Class

URLProtocol

An abstract class that handles the loading of protocol-specific URL data. ある抽象クラス、それはプロトコル特有URLデータのロードを取り扱います。

Declaration 宣言 

class URLProtocol : NSObject

Overview 概要

Don’t instantiate a URLProtocol subclass directly. Instead, create subclasses for any custom protocols or URL schemes that your app supports. When a download starts, the system creates the appropriate protocol object to handle the corresponding URL request. You define your protocol class and call the registerClass(_:) class method during your app’s launch time so that the system is aware of your protocol. URLProtocolサブクラスを直接にインスタンス化しないでください。その代わりに、何らかのあつらえのプロトコルまたはあなたのアプリがサポートするURLスキームに対するサブクラスを作成してください。あるダウンロードが始まる時、システムは適切なプロトコルオブジェクトを作成して、対応するURLリクエストを取り扱います。あなたは、あなたのプロトコルクラスを定義して、registerClass(_:)クラスメソッドをあなたのアプリのもつ起動時間の間に呼び出します、それでシステムはあなたのプロトコルを知っています。

To support the customization of protocol-specific requests, create extensions to the URLRequest class to provide any custom API that you need. You can store and retrieve protocol-specific request data by using URLProtocol’s class methods property(forKey:in:) and setProperty(_:forKey:in:). プロトコル特有リクエストのカスタマイゼーションをサポートするには、URLRequestクラスへの拡張を作成することで、あなたが必要とする何らかのAPIを提供してください。あなたはプロトコル特有リクエストデータの格納および回収を、URLProtocolのもつクラスメソッドproperty(forKey:in:)とsetProperty(_:forKey:in:)を使うことによって行えます。

Create a URLResponse for each request your subclass processes successfully. You may want to create a custom URLResponse class to provide protocol specific information. URLResponseをあなたのサブクラスがうまく処理する各リクエストに対して作成してください。あなたは、あつらえのURLResponseクラスを作成して、プロトコル特有の情報を提供したいかもしれません。

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

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

Topics 話題

Creating Protocol Objects プロトコルオブジェクトを作成する

init(request: URLRequest, cachedResponse: CachedURLResponse?, client: URLProtocolClient?)
Creates a URL protocol instance to handle the request. URLプロトコルインスタンスを作成してリクエストを取り扱います。
init(task: URLSessionTask, cachedResponse: CachedURLResponse?, client: URLProtocolClient?)
Creates a URL protocol instance to handle the task. URLプロトコルインスタンスを作成してタスクを取り扱います。

Registering and Unregistering Protocol Classes プロトコルクラスの登録および登録解除

class func registerClass(AnyClass) -> Bool
Attempts to register a subclass of URLProtocol, making it visible to the URL loading system. URLProtocolのサブクラスの登録を試みます、それがURLローディングシステムに見えるようにします。
class func unregisterClass(AnyClass)
Unregisters the specified subclass of URLProtocol. 指定されたURLProtocolのサブクラスを登録解除します。

Determining If a Subclass Can Handle a Request サブクラスがリクエストを取り扱えるかどうか決定する

class func canInit(with: URLRequest) -> Bool
Determines whether the protocol subclass can handle the specified request. プロトコルサブクラスがこの指定されたリクエストを取り扱えるかどうかを決定します。
class func canInit(with: URLSessionTask) -> Bool
Determines whether the protocol subclass can handle the specified task. プロトコルサブクラスがこの指定されたタスクを取り扱えるかどうかを決定します。

Getting and Setting Request Properties リクエストプロパティの取得と設定

class func property(forKey: String, in: URLRequest) -> Any?
Fetches the property associated with the specified key in the specified request. 指定されたリクエストの中のこの指定されたキーと結び付けられたプロパティを取って来ます。
class func setProperty(Any, forKey: String, in: NSMutableURLRequest)
Sets the property associated with the specified key in the specified request. 指定されたリクエストの中の指定されたキーと結び付けられたプロパティを設定します。
class func removeProperty(forKey: String, in: NSMutableURLRequest)
Removes the property associated with the specified key in the specified request. 指定されたリクエストの中の指定されたキーと結び付けられたプロパティを取り除きます。

Providing a Canonical Version of a Request リクエストの正準版を提供する

class func canonicalRequest(for: URLRequest) -> URLRequest
Returns a canonical version of the specified request. 指定されたリクエストの正準版を返します。

Determining If Requests Are Cache Equivalent リクエストそれらがキャッシュ同等であるかを決定する

class func requestIsCacheEquivalent(URLRequest, to: URLRequest) -> Bool
A Boolean value indicating whether two requests are equivalent for cache purposes. ２つのリクエストがキャッシュ目的に対して同等であるかどうかを指し示しているブール値。

Starting and Stopping Downloads ダウンロードの開始と停止

func startLoading()
Starts protocol-specific loading of the request. このリクエストのプロトコル特有のローディングを開始します。
func stopLoading()
Stops protocol-specific loading of the request. このリクエストのプロトコル特有のローディングを停止します。

Getting Protocol Attributes プロトコル属性を取得する

var cachedResponse: CachedURLResponse?
The protocol’s cached response. プロトコルのもつキュシャされた応答。
var client: URLProtocolClient?
The object the protocol uses to communicate with the URL loading system. プロトコルがURLローディングシステムと通信するのに使うオブジェクト。
protocol URLProtocolClient
The interface used by URLProtocol subclasses to communicate with the URL Loading System. URLProtocolサブクラスによってURLローディングシステムと通信するのに使われるインターフェイス。
var request: URLRequest
The protocol’s request. プロトコルのもつリクエスト。
var task: URLSessionTask?
The protocol’s task. プロトコルのもつタスク。

Relationships 関係

Inherits From 継承元

See Also 参照

Supporting Custom Protocols あつらえのプロトコルをサポートする

var protocolClasses: [AnyClass]?
An array of extra protocol subclasses that handle requests in a session. あるセッションにおいてリクエストを取り扱う追加のプロトコルサブクラスからなるある配列。