Instance Method インスタンスメソッド

dataTaskWithRequest:completionHandler:

Creates a task that retrieves the contents of a URL based on the specified URL request object, and calls a handler upon completion. 指定されたURLリクエストオブジェクトに基づいてあるURLの内容を取ってくるタスクを作成します、そしてあるハンドラを完了に関して呼び出します。

Declaration 宣言 

- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request 
                            completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler;

Parameters パラメータ

request

A URL request object that provides the URL, cache policy, request type, body data or body stream, and so on. URL、キャッシュ方針、リクエスト型、ボディデータまたはボディストリーム、などを提供するURLリクエストオブジェクト。

completionHandler

The completion handler to call when the load request is complete. This handler is executed on the delegate queue. ロードリクエストが完了する時に呼び出す完了ハンドラ。このハンドラは、委任先キュー上で遂行されます。

If you pass nil, only the session delegate methods are called when the task completes, making this method equivalent to the dataTaskWithRequest: method. あなたがnilを渡すならば、セッション委任先メソッドそれらだけがそのタスクが完了する時に呼び出され、このメソッドをdataTaskWithRequest:メソッドと等しいものにします。

This completion handler takes the following parameters: この完了ハンドラは、以下のパラメータを取ります：

data

The data returned by the server. サーバによって返されるデータ。

response

An object that provides response metadata, such as HTTP headers and status code. If you are making an HTTP or HTTPS request, the returned object is actually an NSHTTPURLResponse object. あるオブジェクト、それは応答メタデータを提供します、たとえばHTTPヘッダおよび状態コード。あなたがHTTPまたはHTTPSリクエストをしているならば、返されるオブジェクトは事実上NSHTTPURLResponseオブジェクトです。

error

An error object that indicates why the request failed, or nil if the request was successful. あるエラーオブジェクト、それはなぜリクエストが失敗したかを指し示します、またはnil、もしリクエストがうまくいったならば。

Return Value 戻り値

The new session data task. 新しいセッションデータタスク。

Discussion 議論

By creating a task based on a request object, you can tune various aspects of the task’s behavior, including the cache policy and timeout interval. リクエストオブジェクトに基づいてタスクを作成することによって、あなたはタスクのもつ挙動のさまざまな面を調整できます、キャッシュ方針とタイムアウト間隔を含めて。

By using the completion handler, the task bypasses calls to delegate methods for response and data delivery, and instead provides any resulting NSData, NSURLResponse, and NSError objects inside the completion handler. Delegate methods for handling authentication challenges, however, are still called. 完了ハンドラを使うことによって、タスクは応答とデータを配達するための委任先メソッドへの呼び出しを迂回します、そして代わりに何らかの結果NSData、NSURLResponse、そしてNSErrorオブジェクトを完了ハンドラ内部で提供します。認証チャレンジを取り扱う委任先メソッドは、しかしながら、依然として呼び出されます。

You should pass a nil completion handler only when creating tasks in sessions whose delegates include a URLSession:dataTask:didReceiveData: method. あなたはnil完了ハンドラを、それの委任先がURLSession:dataTask:didReceiveData:メソッドを含むセッションにおいてタスクを作成している時にのみ渡すべきです。

After you create the task, you must start it by calling its resume method. あなたがタスクを作成する後、あなたはそれを、それのresumeメソッドを呼び出すことによって開始しなければなりません。

If the request completes successfully, the data parameter of the completion handler block contains the resource data, and the error parameter is nil. If the request fails, the data parameter is nil and the error parameter contain information about the failure. If a response from the server is received, regardless of whether the request completes successfully or fails, the response parameter contains that information. リクエストが成功裏に完了するならば、完了ハンドラブロックのdataパラメータはリソースデータを含みます、そしてerrorパラメータはnilです。リクエストが失敗するならば、dataパラメータはnilです、そしてerrorパラメータはその失敗についての情報を含みます。サーバからの応答が受け取られるならば、リクエストがうまく完了するか失敗するかどうかに関係なく、responseパラメータはその情報を含みます。

See Also 参照

Adding Data Tasks to a Session データタスクをセッションに加える

- dataTaskWithURL:
Creates a task that retrieves the contents of the specified URL. 指定されたURLの内容を取ってくるタスクを作成します。
- dataTaskWithURL:completionHandler:
Creates a task that retrieves the contents of the specified URL, then calls a handler upon completion. 指定されたURLの内容を取ってきて、それからあるハンドラを完了に関して呼び出すタスクを作成します。
- dataTaskWithRequest:
Creates a task that retrieves the contents of a URL based on the specified URL request object. 指定されたURLリクエストオブジェクトに基づいてあるURLの内容を取ってくるタスクを作成します。
NSURLSessionDataTask
A URL session task that returns downloaded data directly to the app in memory. ダウンロードされたデータを直接にアプリへとメモリ中に返すURLセッションタスク。
NSURLSessionDataDelegate
A protocol that defines methods that URL session instances call on their delegates to handle task-level events specific to data and upload tasks. あるプロトコル、それはいくつかのメソッドを定義します、それらはURLセッションインスタンスがそれらの委任先上で呼び出して、データおよびアップロードタスクに特有なタスク水準イベントを取り扱うものです。