SessionDelegate Class Reference

URLSessionDelegate Overrides

subscript(_:)
Access the task delegate for the specified task in a thread-safe manner.
Declaration
Swift

open subscript(task: URLSessionTask) -> Request?
Show on GitHub
sessionDidBecomeInvalidWithError
Overrides default behavior for URLSessionDelegate method urlSession(_:didBecomeInvalidWithError:).
Declaration
Swift

@objc open var sessionDidBecomeInvalidWithError: ((URLSession, Error?) -> Void)?
Show on GitHub
sessionDidReceiveChallenge
Overrides default behavior for URLSessionDelegate method urlSession(_:didReceive:completionHandler:).
Declaration
Swift

open var sessionDidReceiveChallenge: ((URLSession, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?
Show on GitHub
sessionDidReceiveChallengeWithCompletion
Overrides all behavior for URLSessionDelegate method urlSession(_:didReceive:completionHandler:) and requires the caller to call the completionHandler.
Declaration
Swift

@objc open var sessionDidReceiveChallengeWithCompletion: ((URLSession, URLAuthenticationChallenge, (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void)?
Show on GitHub
sessionDidFinishEventsForBackgroundURLSession
Overrides default behavior for URLSessionDelegate method urlSessionDidFinishEvents(forBackgroundURLSession:).
Declaration
Swift

@objc open var sessionDidFinishEventsForBackgroundURLSession: ((URLSession) -> Void)?
Show on GitHub

URLSessionTaskDelegate Overrides

taskWillPerformHTTPRedirection
Overrides default behavior for URLSessionTaskDelegate method urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:).
Declaration
Swift

@objc open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> URLRequest?)?
Show on GitHub
taskWillPerformHTTPRedirectionWithCompletion
Overrides all behavior for URLSessionTaskDelegate method urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:) and requires the caller to call the completionHandler.
Declaration
Swift

@objc open var taskWillPerformHTTPRedirectionWithCompletion: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest, (URLRequest?) -> Void) -> Void)?
Show on GitHub
taskDidReceiveChallenge
Overrides default behavior for URLSessionTaskDelegate method urlSession(_:task:didReceive:completionHandler:).
Declaration
Swift

open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?
Show on GitHub
taskDidReceiveChallengeWithCompletion
Overrides all behavior for URLSessionTaskDelegate method urlSession(_:task:didReceive:completionHandler:) and requires the caller to call the completionHandler.
Declaration
Swift

@objc open var taskDidReceiveChallengeWithCompletion: ((URLSession, URLSessionTask, URLAuthenticationChallenge, (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void)?
Show on GitHub
taskNeedNewBodyStream
Overrides default behavior for URLSessionTaskDelegate method urlSession(_:task:needNewBodyStream:).
Declaration
Swift

@objc open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> InputStream?)?
Show on GitHub
taskNeedNewBodyStreamWithCompletion
Overrides all behavior for URLSessionTaskDelegate method urlSession(_:task:needNewBodyStream:) and requires the caller to call the completionHandler.
Declaration
Swift

@objc open var taskNeedNewBodyStreamWithCompletion: ((URLSession, URLSessionTask, (InputStream?) -> Void) -> Void)?
Show on GitHub
taskDidSendBodyData
Overrides default behavior for URLSessionTaskDelegate method urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:).
Declaration
Swift

@objc open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?
Show on GitHub
taskDidComplete
Overrides default behavior for URLSessionTaskDelegate method urlSession(_:task:didCompleteWithError:).
Declaration
Swift

@objc open var taskDidComplete: ((URLSession, URLSessionTask, Error?) -> Void)?
Show on GitHub

URLSessionDataDelegate Overrides

dataTaskDidReceiveResponse
Overrides default behavior for URLSessionDataDelegate method urlSession(_:dataTask:didReceive:completionHandler:).
Declaration
Swift

@objc open var dataTaskDidReceiveResponse: ((URLSession, URLSessionDataTask, URLResponse) -> URLSession.ResponseDisposition)?
Show on GitHub
dataTaskDidReceiveResponseWithCompletion
Overrides all behavior for URLSessionDataDelegate method urlSession(_:dataTask:didReceive:completionHandler:) and requires caller to call the completionHandler.
Declaration
Swift

@objc open var dataTaskDidReceiveResponseWithCompletion: ((URLSession, URLSessionDataTask, URLResponse, (URLSession.ResponseDisposition) -> Void) -> Void)?
Show on GitHub
dataTaskDidBecomeDownloadTask
Overrides default behavior for URLSessionDataDelegate method urlSession(_:dataTask:didBecome:).
Declaration
Swift

@objc open var dataTaskDidBecomeDownloadTask: ((URLSession, URLSessionDataTask, URLSessionDownloadTask) -> Void)?
Show on GitHub
dataTaskDidReceiveData
Overrides default behavior for URLSessionDataDelegate method urlSession(_:dataTask:didReceive:).
Declaration
Swift

@objc open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?
Show on GitHub
dataTaskWillCacheResponse
Overrides default behavior for URLSessionDataDelegate method urlSession(_:dataTask:willCacheResponse:completionHandler:).
Declaration
Swift

@objc open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> CachedURLResponse?)?
Show on GitHub
dataTaskWillCacheResponseWithCompletion
Overrides all behavior for URLSessionDataDelegate method urlSession(_:dataTask:willCacheResponse:completionHandler:) and requires caller to call the completionHandler.
Declaration
Swift

@objc open var dataTaskWillCacheResponseWithCompletion: ((URLSession, URLSessionDataTask, CachedURLResponse, (CachedURLResponse?) -> Void) -> Void)?
Show on GitHub

URLSessionDownloadDelegate Overrides

downloadTaskDidFinishDownloadingToURL
Overrides default behavior for URLSessionDownloadDelegate method urlSession(_:downloadTask:didFinishDownloadingTo:).
Declaration
Swift

@objc open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?
Show on GitHub
downloadTaskDidWriteData
Overrides default behavior for URLSessionDownloadDelegate method urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:).
Declaration
Swift

@objc open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?
Show on GitHub
downloadTaskDidResumeAtOffset
Overrides default behavior for URLSessionDownloadDelegate method urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:).
Declaration
Swift

@objc open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?
Show on GitHub

Lifecycle

init()
Initializes the SessionDelegate instance.
Declaration
Swift

public override init()
Show on GitHub

NSObject Overrides

responds(to:)
Returns a Bool indicating whether the SessionDelegate implements or inherits a method that can respond to a specified message.
Declaration
Swift

open override func responds(to selector: Selector) -> Bool
Show on GitHub

urlSession(_:didBecomeInvalidWithError:)
Tells the delegate that the session has been invalidated.
Declaration
Swift

open func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)
Show on GitHub


                    
                    
                    urlSession(_:didReceive:completionHandler:)

Requests credentials from the delegate in response to a session-level authentication request from the remote server.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        didReceive challenge: URLAuthenticationChallenge,
        completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)

Show on GitHub

urlSessionDidFinishEvents(forBackgroundURLSession:)
Tells the delegate that all messages enqueued for a session have been delivered.
Declaration
Swift

open func urlSessionDidFinishEvents(forBackgroundURLSession session: URLSession)
Show on GitHub


                    
                    
                    urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)

Tells the delegate that the remote server requested an HTTP redirect.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        task: URLSessionTask,
        willPerformHTTPRedirection response: HTTPURLResponse,
        newRequest request: URLRequest,
        completionHandler: @escaping (URLRequest?) -> Void)

Show on GitHub


                    
                    
                    urlSession(_:task:didReceive:completionHandler:)

Requests credentials from the delegate in response to an authentication request from the remote server.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        task: URLSessionTask,
        didReceive challenge: URLAuthenticationChallenge,
        completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)

Show on GitHub


                    
                    
                    urlSession(_:task:needNewBodyStream:)

Tells the delegate when a task requires a new request body stream to send to the remote server.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        task: URLSessionTask,
        needNewBodyStream completionHandler: @escaping (InputStream?) -> Void)

Show on GitHub


                    
                    
                    urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)

Periodically informs the delegate of the progress of sending body content to the server.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        task: URLSessionTask,
        didSendBodyData bytesSent: Int64,
        totalBytesSent: Int64,
        totalBytesExpectedToSend: Int64)

Show on GitHub

urlSession(_:task:didFinishCollecting:)
Tells the delegate that the session finished collecting metrics for the task.
Declaration
Swift

open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)
Show on GitHub
urlSession(_:task:didCompleteWithError:)
Tells the delegate that the task finished transferring data.
Declaration
Swift

open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
Show on GitHub


                    
                    
                    urlSession(_:dataTask:didReceive:completionHandler:)

Tells the delegate that the data task received the initial reply (headers) from the server.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        dataTask: URLSessionDataTask,
        didReceive response: URLResponse,
        completionHandler: @escaping (URLSession.ResponseDisposition) -> Void)

Show on GitHub


                    
                    
                    urlSession(_:dataTask:didBecome:)

Tells the delegate that the data task was changed to a download task.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        dataTask: URLSessionDataTask,
        didBecome downloadTask: URLSessionDownloadTask)

Show on GitHub

urlSession(_:dataTask:didReceive:)
Tells the delegate that the data task has received some of the expected data.
Declaration
Swift

open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)
Show on GitHub


                    
                    
                    urlSession(_:dataTask:willCacheResponse:completionHandler:)

Asks the delegate whether the data (or upload) task should store the response in the cache.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        dataTask: URLSessionDataTask,
        willCacheResponse proposedResponse: CachedURLResponse,
        completionHandler: @escaping (CachedURLResponse?) -> Void)

Show on GitHub


                    
                    
                    urlSession(_:downloadTask:didFinishDownloadingTo:)

Tells the delegate that a download task has finished downloading.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        downloadTask: URLSessionDownloadTask,
        didFinishDownloadingTo location: URL)

Show on GitHub


                    
                    
                    urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)

Periodically informs the delegate about the download’s progress.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        downloadTask: URLSessionDownloadTask,
        didWriteData bytesWritten: Int64,
        totalBytesWritten: Int64,
        totalBytesExpectedToWrite: Int64)

Show on GitHub


                    
                    
                    urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)

Tells the delegate that the download task has resumed downloading.

Declaration

Swift

open func urlSession(
        _ session: URLSession,
        downloadTask: URLSessionDownloadTask,
        didResumeAtOffset fileOffset: Int64,
        expectedTotalBytes: Int64)

Show on GitHub