Class

HTTPCookieStorage

A container that manages the storage of cookies. クッキーのストレージを管理するコンテナ。

Declaration 宣言 

class HTTPCookieStorage : NSObject

Overview 概要

Each stored cookie is represented by an instance of the HTTPCookie class. 各貯蔵クッキーは、HTTPCookieクラスのインスタンスによって表されます。

Sharing Cookie Storage クッキーストレージを共有する

The persistent cookie storage returned by shared may be available to app extensions or other apps, subject to the following guidelines: sharedによって返される持続するクッキーストレージは、アプリ拡張または他のアプリに利用可能かもしれません、以下の指針を条件として：

  • iOS — Each app and app extension has a unique data container, meaning they have separate cookie stores. You can obtain a common cookie storage by using the sharedCookieStorage(forGroupContainerIdentifier:) method. iOS — アプリとアプリ拡張それぞれが特有なデータコンテナを持ちます、それらが独立したクッキー貯蔵を持つことを意味しています。あなたは、一般的なクッキーストレージをsharedCookieStorage(forGroupContainerIdentifier:)メソッドによって取得できます。

  • macOS (non-sandboxed) — As of macOS 10.11, each app has its own cookie storage. Prior to macOS 10.11, a common cookie store is shared among the user's apps. macOS（非サンドボックス） — macOS 10.11現在、各アプリはそれ自身のクッキーストレージを持ちます。macOS 10.11より前、一般的なクッキー貯蔵所は、ユーザのもつアプリそれらの間で共有されます。

  • macOS (sandboxed) — Same as iOS. macOS（サンドボックス） — iOSに同じ。

  • UIWebView — UIWebView instances within an app inherit the parent app's shared cookie storage. UIWebView — UIWebViewインスタンスはあるアプリ内において、親アプリの持つ共有クッキーストレージを継承します。

  • WKWebView — Each WKWebView instance has its own cookie storage. See the WKHTTPCookieStore class for more information. WKWebView — 各WKWebViewインスタンスはそれ自身のクッキーストレージを持ちます。WKHTTPCookieStoreクラスをさらなる情報のために見てください。

Session cookies (where the cookie object’s isSessionOnly property is true) are local to a single process and are not shared. セッションクッキーは（そこでクッキーオブジェクトの持つisSessionOnlyプロパティはtrueです）、ある単一のプロセスに対してローカルであり、共有されません。

Subclassing Notes サブクラス作成の注意

The HTTPCookieStorage class is usable as-is, but you can subclass it. For example, you can override the storage methods like storeCookies(_:for:), getCookiesFor(_:completionHandler:) to screen which cookies are stored, or reimplement the storage mechanism for security or other reasons. HTTPCookieStorageクラスはそのままで利用可能です、しかしあなたはそれのサブクラスを作れます。例えば、あなたはstoreCookies(_:for:)、getCookiesFor(_:completionHandler:)のようなストレージメソッドをオーバーライドして、どのクッキーが貯蔵されるかふるいにかける、またはストレージの仕組みを安全性または他の理由のために再実装することが可能です。

When overriding methods of this class, be aware that methods that take a task parameter are preferred by the system to equivalent methods that do not. Therefore, you should override the task-based methods when subclassing, as follows: このクラスのメソッドをオーバーライドする場合、taskパラメータを取るメソッドがそうしない同等のメソッドよりシステムによって優先されることを承知しておいてください。それゆえに、あなたは、サブクラスを作る場合は、タスク基盤のメソッドをオーバーライドするべきです、次のように：

Topics 話題

Getting the Shared Cookie Storage Object 共有クッキーストレージオブジェクトを取得する

class var shared: HTTPCookieStorage
The shared cookie storage instance. 共有クッキーストレージインスタンス。
class func sharedCookieStorage(forGroupContainerIdentifier: String) -> HTTPCookieStorage
Returns the cookie storage instance for the container associated with the specified app group identifier. 指定されたアプリグループ識別子と結び付けられるコンテナに対するクッキーストレージインスタンスを返します。

Getting and Setting the Cookie Accept Policy クッキー受入方針の取得と設定

var cookieAcceptPolicy: HTTPCookie.AcceptPolicy
The cookie storage’s cookie accept policy. クッキーストレージの持つクッキー受入方針。
enum HTTPCookie.AcceptPolicy
Cookie acceptance policies implemented by the HTTPCookieStorage class. HTTPCookieStorageクラスによって実装されるクッキー受入方針。

Adding and Removing Cookies クッキーの追加と除去

func removeCookies(since: Date)
Removes cookies that were stored after a given date. 与えられた日付より後に貯蔵されたクッキーを取り除きます。
func deleteCookie(HTTPCookie)
Deletes the specified cookie from the cookie storage. 指定されたクッキーをクッキーストレージから削除します。
func setCookie(HTTPCookie)
Stores a specified cookie in the cookie storage if the cookie accept policy permits. 指定されたクッキーをクッキーストレージに貯蔵します、もしクッキー受入方針が許可するならば。
func setCookies([HTTPCookie], for: URL?, mainDocumentURL: URL?)
Adds an array of cookies to the cookie storage if the storage’s cookie acceptance policy permits. クッキーの配列をクッキーストレージに加えます、もしそのストレージの持つクッキー受入方針が許可するならば。
func storeCookies([HTTPCookie], for: URLSessionTask)
Stores an array of cookies in the cookie storage, on behalf of the provided task, if the cookie accept policy permits. クッキーの配列をクッキーストレージの中に貯蔵します、提供されたタスクの代理で、もしクッキー受入方針が許可するならば。

Retrieving Cookies クッキーの回収

var cookies: [HTTPCookie]?
The cookie storage’s cookies. クッキーストレージの持つクッキーそれら。
func getCookiesFor(URLSessionTask, completionHandler: ([HTTPCookie]?) -> Void)
Fetches cookies relevant to the specified task and passes them to the completion handler. 指定されたタスクと関連があるクッキーをとってきます、そしてそれらを完了ハンドラに渡します。
func cookies(for: URL) -> [HTTPCookie]?
Returns all the cookie storage’s cookies that are sent to a specified URL. クッキーストレージの持つクッキー全てで、ある指定されたURLに送られるものを返します。
func sortedCookies(using: [NSSortDescriptor]) -> [HTTPCookie]
Returns all of the cookie storage’s cookies, sorted according to a given set of sort descriptors. ある与えられた一揃いのソート記述子によってソート（選別）される、クッキーストレージの持つクッキー全てを返します。

Tracking Cookie Storage Changes クッキーストレージの変化を追跡する

static let NSHTTPCookieManagerCookiesChanged: NSNotification.Name
A notification posted when the cookies stored in the cookie storage have changed. クッキーストレージに貯蔵されたクッキーが変化する場合に投函される通知。
static let NSHTTPCookieManagerAcceptPolicyChanged: NSNotification.Name
A notification posted when the acceptance policy of the cookie storage has changed. そのクッキーの受入方針が変化する場合に投函される通知。

Relationships 関係

Inherits From 継承元

See Also 参照

Cookies さまざまなクッキー

class HTTPCookie
A representation of an HTTP cookie. HTTPクッキーのある表現。