Instance Method

uploadTask(withStreamedRequest:)

Creates a task that performs an HTTP request for uploading data based on the specified URL request.

Declaration

func uploadTask(withStreamedRequest request: URLRequest) -> URLSessionUploadTask

Parameters

request

An NSURLRequest object that provides the URL, cache policy, request type, and so on. The body stream and body data in this request object are ignored, and NSURLSession calls its delegate’s urlSession(_:task:needNewBodyStream:) method to provide the body data.

Return Value

The new session upload task.

Discussion

An HTTP upload request is any request that contains a request body, such as a POST or PUT request. Upload tasks require you to provide a request object so that you can provide metadata for the upload, such as HTTP request headers.

After you create the task, you must start it by calling its resume() method. The task calls methods on the session’s delegate to provide you with the upload’s progress, response metadata, response data, and so on. The session’s delegate must have a urlSession(_:task:needNewBodyStream:) method that provides the body data to upload.