dataTask(with:completionHandler:)
Creates a task that retrieves the contents of a URL based on the specified URL request object, and calls a handler upon completion.
Declaration
func dataTask(with request: URLRequest, completionHandler: @escaping @Sendable (Data?, URLResponse?, (any Error)?) -> Void) -> URLSessionDataTaskParameters
- request:
A URL request object that provides the URL, cache policy, request type, body data or body stream, and so on.
- 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 Datatask(with:) 7jpys method.This completion handler takes the following parameters:
dataThe data returned by the server.
responseAn 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 Httpurlresponse object.
errorAn error object that indicates why the request failed, or
nilif the request was successful.
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, URLResponse, and NSError objects inside the completion handler. Delegate methods for handling authentication challenges, however, are still called.
You should pass a nil completion handler only when creating tasks in sessions whose delegates include a urlSession(_:dataTask:didReceive:) method.
After you create the task, you must start it by calling its resume() method.
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.