LCURLSessionManager

Objective-C

@interface LCURLSessionManager
    : NSObject <NSURLSessionDelegate, NSURLSessionTaskDelegate,
                NSURLSessionDataDelegate, NSURLSessionDownloadDelegate,
                NSSecureCoding, NSCopying>

Swift

class LCURLSessionManager : NSObject, URLSessionDelegate, URLSessionTaskDelegate, URLSessionDataDelegate, URLSessionDownloadDelegate, NSSecureCoding, NSCopying

LCURLSessionManager creates and manages an NSURLSession object based on a specified NSURLSessionConfiguration object, which conforms to <NSURLSessionTaskDelegate>, <NSURLSessionDataDelegate>, <NSURLSessionDownloadDelegate>, and <NSURLSessionDelegate>.

Subclassing Notes

This is the base class for LCHTTPSessionManager, which adds functionality specific to making HTTP requests. If you are looking to extend LCURLSessionManager specifically for HTTP, consider subclassing LCHTTPSessionManager instead.

NSURLSession & NSURLSessionTask Delegate Methods

LCURLSessionManager implements the following delegate methods:

NSURLSessionDelegate

  • URLSession:didBecomeInvalidWithError:
  • URLSession:didReceiveChallenge:completionHandler:
  • URLSessionDidFinishEventsForBackgroundURLSession:

NSURLSessionTaskDelegate

  • URLSession:willPerformHTTPRedirection:newRequest:completionHandler:
  • URLSession:task:didReceiveChallenge:completionHandler:
  • URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:
  • URLSession:task:needNewBodyStream:
  • URLSession:task:didCompleteWithError:

NSURLSessionDataDelegate

  • URLSession:dataTask:didReceiveResponse:completionHandler:
  • URLSession:dataTask:didBecomeDownloadTask:
  • URLSession:dataTask:didReceiveData:
  • URLSession:dataTask:willCacheResponse:completionHandler:

NSURLSessionDownloadDelegate

  • URLSession:downloadTask:didFinishDownloadingToURL:
  • URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesWritten:totalBytesExpectedToWrite:
  • URLSession:downloadTask:didResumeAtOffset:expectedTotalBytes:

If any of these methods are overridden in a subclass, they must call the super implementation first.

Network Reachability Monitoring

Network reachability status and change monitoring is available through the reachabilityManager property. Applications may choose to monitor network reachability conditions in order to prevent or suspend any outbound requests. See LCNetworkReachabilityManager for more details.

NSCoding Caveats

  • Encoded managers do not include any block properties. Be sure to set delegate callback blocks when using -initWithCoder: or NSKeyedUnarchiver.

NSCopying Caveats

  • -copy and -copyWithZone: return a new manager with a new NSURLSession created from the configuration of the original.

  • Operation copies do not include any delegate callback blocks, as they often strongly captures a reference to self, which would otherwise have the unintuitive side-effect of pointing to the original session manager when copied.

Warning

Managers for background sessions must be owned for the duration of their use. This can be accomplished by creating an application-wide or shared singleton instance.

Show on GitHub

  • The managed session.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSURLSession *_Nonnull session;

    Swift

    var session: URLSession { get }
    Show on GitHub

  • The operation queue on which delegate callbacks are run.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSOperationQueue *_Nonnull operationQueue;

    Swift

    var operationQueue: OperationQueue { get }
    Show on GitHub

  • Responses sent from the server in data tasks created with dataTaskWithRequest:success:failure: and run using the GET / POST / et al. convenience methods are automatically validated and serialized by the response serializer. By default, this property is set to an instance of LCJSONResponseSerializer.

    Warning

    responseSerializer must not be nil.

    Declaration

    Objective-C

    @property (nonatomic, strong) id<LCURLResponseSerialization> _Nonnull responseSerializer;

    Swift

    var responseSerializer: LCURLResponseSerialization { get set }
    Show on GitHub

Managing Security Policy

  • The security policy used by created session to evaluate server trust for secure connections. LCURLSessionManager uses the defaultPolicy unless otherwise specified.

    Declaration

    Objective-C

    @property (nonatomic, strong) LCSecurityPolicy *_Nonnull securityPolicy;

    Swift

    var securityPolicy: LCSecurityPolicy { get set }
    Show on GitHub

Monitoring Network Reachability

Getting Session Tasks

  • The data, upload, and download tasks currently run by the managed session.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSURLSessionTask *> *_Nonnull tasks;

    Swift

    var tasks: [URLSessionTask] { get }
    Show on GitHub

  • The data tasks currently run by the managed session.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSURLSessionDataTask *> *_Nonnull dataTasks;

    Swift

    var dataTasks: [URLSessionDataTask] { get }
    Show on GitHub

  • The upload tasks currently run by the managed session.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSURLSessionUploadTask *> *_Nonnull uploadTasks;

    Swift

    var uploadTasks: [URLSessionUploadTask] { get }
    Show on GitHub

  • The download tasks currently run by the managed session.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSURLSessionDownloadTask *> *_Nonnull downloadTasks;

    Swift

    var downloadTasks: [URLSessionDownloadTask] { get }
    Show on GitHub

Managing Callback Queues

  • The dispatch queue for completionBlock. If NULL (default), the main queue is used.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) dispatch_queue_t completionQueue;

    Swift

    var completionQueue: DispatchQueue? { get set }
    Show on GitHub

  • The dispatch group for completionBlock. If NULL (default), a private dispatch group is used.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) dispatch_group_t completionGroup;

    Swift

    var completionGroup: DispatchGroup? { get set }
    Show on GitHub

Working Around System Bugs

  • Whether to attempt to retry creation of upload tasks for background sessions when initial call returns nil. NO by default.

    @bug As of iOS 7.0, there is a bug where upload tasks created for background tasks are sometimes nil. As a workaround, if this property is YES, AFNetworking will follow Apple’s recommendation to try creating the task again.

    See

    https://github.com/AFNetworking/AFNetworking/issues/1675

    Declaration

    Objective-C

    @property (nonatomic) BOOL attemptsToRecreateUploadTasksForBackgroundSessions;

    Swift

    var attemptsToRecreateUploadTasksForBackgroundSessions: Bool { get set }
    Show on GitHub

Initialization

  • Creates and returns a manager for a session created with the specified configuration. This is the designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSessionConfiguration:
    (nullable NSURLSessionConfiguration *)configuration;

    Swift

    init(sessionConfiguration configuration: URLSessionConfiguration?)

    Parameters

    configuration

    The configuration used to create the managed session.

    Return Value

    A manager for a newly-created session.

    Show on GitHub

  • Invalidates the managed session, optionally canceling pending tasks.

    Declaration

    Objective-C

    - (void)invalidateSessionCancelingTasks:(BOOL)cancelPendingTasks;

    Swift

    func invalidateSessionCancelingTasks(_ cancelPendingTasks: Bool)

    Parameters

    cancelPendingTasks

    Whether or not to cancel pending tasks.
    Show on GitHub

Running Data Tasks

  • Creates an NSURLSessionDataTask with the specified request.

    Declaration

    Objective-C

    - (nonnull NSURLSessionDataTask *)
    dataTaskWithRequest:(nonnull NSURLRequest *)request
      completionHandler:
          (nullable void (^)(NSURLResponse *_Nonnull, id _Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func dataTask(with request: URLRequest, completionHandler: ((URLResponse, Any?, Error?) -> Void)? = nil) -> URLSessionDataTask

    Parameters

    request

    The HTTP request for the request.
    completionHandler

    A block object to be executed when the task finishes. This block has no return value and takes three arguments: the server response, the response object created by that serializer, and the error that occurred, if any.
    Show on GitHub

  • Creates an NSURLSessionDataTask with the specified request.

    Declaration

    Objective-C

    - (nonnull NSURLSessionDataTask *)
    dataTaskWithRequest:(nonnull NSURLRequest *)request
         uploadProgress:
             (nullable void (^)(NSProgress *_Nonnull))uploadProgressBlock
       downloadProgress:
           (nullable void (^)(NSProgress *_Nonnull))downloadProgressBlock
      completionHandler:
          (nullable void (^)(NSURLResponse *_Nonnull, id _Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func dataTask(with request: URLRequest, uploadProgress uploadProgressBlock: ((Progress) -> Void)?, downloadProgress downloadProgressBlock: ((Progress) -> Void)?, completionHandler: ((URLResponse, Any?, Error?) -> Void)? = nil) -> URLSessionDataTask

    Parameters

    request

    The HTTP request for the request.
    uploadProgressBlock

    A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue.
    downloadProgressBlock

    A block object to be executed when the download progress is updated. Note this block is called on the session queue, not the main queue.
    completionHandler

    A block object to be executed when the task finishes. This block has no return value and takes three arguments: the server response, the response object created by that serializer, and the error that occurred, if any.
    Show on GitHub

Running Upload Tasks

  • Creates an NSURLSessionUploadTask with the specified request for a local file.

    See

    attemptsToRecreateUploadTasksForBackgroundSessions

    Declaration

    Objective-C

    - (nonnull NSURLSessionUploadTask *)
    uploadTaskWithRequest:(nonnull NSURLRequest *)request
                 fromFile:(nonnull NSURL *)fileURL
                 progress:(nullable void (^)(NSProgress *_Nonnull))
                              uploadProgressBlock
        completionHandler:
            (nullable void (^)(NSURLResponse *_Nonnull, id _Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func uploadTask(with request: URLRequest, fromFile fileURL: URL, progress uploadProgressBlock: ((Progress) -> Void)?, completionHandler: ((URLResponse, Any?, Error?) -> Void)? = nil) -> URLSessionUploadTask

    Parameters

    request

    The HTTP request for the request.
    fileURL

    A URL to the local file to be uploaded.
    uploadProgressBlock

    A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue.
    completionHandler

    A block object to be executed when the task finishes. This block has no return value and takes three arguments: the server response, the response object created by that serializer, and the error that occurred, if any.
    Show on GitHub

  • Creates an NSURLSessionUploadTask with the specified request for an HTTP body.

    Declaration

    Objective-C

    - (nonnull NSURLSessionUploadTask *)
    uploadTaskWithRequest:(nonnull NSURLRequest *)request
                 fromData:(nullable NSData *)bodyData
                 progress:(nullable void (^)(NSProgress *_Nonnull))
                              uploadProgressBlock
        completionHandler:
            (nullable void (^)(NSURLResponse *_Nonnull, id _Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func uploadTask(with request: URLRequest, from bodyData: Data?, progress uploadProgressBlock: ((Progress) -> Void)?, completionHandler: ((URLResponse, Any?, Error?) -> Void)? = nil) -> URLSessionUploadTask

    Parameters

    request

    The HTTP request for the request.
    bodyData

    A data object containing the HTTP body to be uploaded.
    uploadProgressBlock

    A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue.
    completionHandler

    A block object to be executed when the task finishes. This block has no return value and takes three arguments: the server response, the response object created by that serializer, and the error that occurred, if any.
    Show on GitHub

  • Creates an NSURLSessionUploadTask with the specified streaming request.

    Declaration

    Objective-C

    - (nonnull NSURLSessionUploadTask *)
    uploadTaskWithStreamedRequest:(nonnull NSURLRequest *)request
                         progress:(nullable void (^)(NSProgress *_Nonnull))
                                      uploadProgressBlock
                completionHandler:
                    (nullable void (^)(NSURLResponse *_Nonnull, id _Nullable,
                                       NSError *_Nullable))completionHandler;

    Swift

    func uploadTask(withStreamedRequest request: URLRequest, progress uploadProgressBlock: ((Progress) -> Void)?, completionHandler: ((URLResponse, Any?, Error?) -> Void)? = nil) -> URLSessionUploadTask

    Parameters

    request

    The HTTP request for the request.
    uploadProgressBlock

    A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue.
    completionHandler

    A block object to be executed when the task finishes. This block has no return value and takes three arguments: the server response, the response object created by that serializer, and the error that occurred, if any.
    Show on GitHub

Running Download Tasks

  • Creates an NSURLSessionDownloadTask with the specified request.

    Warning

    If using a background NSURLSessionConfiguration on iOS, these blocks will be lost when the app is terminated. Background sessions may prefer to use -setDownloadTaskDidFinishDownloadingBlock: to specify the URL for saving the downloaded file, rather than the destination block of this method.

    Declaration

    Objective-C

    - (nonnull NSURLSessionDownloadTask *)
    downloadTaskWithRequest:(nonnull NSURLRequest *)request
                   progress:(nullable void (^)(NSProgress *_Nonnull))
                                downloadProgressBlock
                destination:(nullable NSURL *_Nonnull (^)(
                                NSURL *_Nonnull,
                                NSURLResponse *_Nonnull))destination
          completionHandler:
              (nullable void (^)(NSURLResponse *_Nonnull, NSURL *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func downloadTask(with request: URLRequest, progress downloadProgressBlock: ((Progress) -> Void)?, destination: ((URL, URLResponse) -> URL)?, completionHandler: ((URLResponse, URL?, Error?) -> Void)? = nil) -> URLSessionDownloadTask

    Parameters

    request

    The HTTP request for the request.
    downloadProgressBlock

    A block object to be executed when the download progress is updated. Note this block is called on the session queue, not the main queue.
    destination

    A block object to be executed in order to determine the destination of the downloaded file. This block takes two arguments, the target path & the server response, and returns the desired file URL of the resulting download. The temporary file used during the download will be automatically deleted after being moved to the returned URL.
    completionHandler

    A block to be executed when a task finishes. This block has no return value and takes three arguments: the server response, the path of the downloaded file, and the error describing the network or parsing error that occurred, if any.
    Show on GitHub

  • Creates an NSURLSessionDownloadTask with the specified resume data.

    Declaration

    Objective-C

    - (nonnull NSURLSessionDownloadTask *)
    downloadTaskWithResumeData:(nonnull NSData *)resumeData
                      progress:(nullable void (^)(NSProgress *_Nonnull))
                                   downloadProgressBlock
                   destination:(nullable NSURL *_Nonnull (^)(
                                   NSURL *_Nonnull,
                                   NSURLResponse *_Nonnull))destination
             completionHandler:
                 (nullable void (^)(NSURLResponse *_Nonnull, NSURL *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func downloadTask(withResumeData resumeData: Data, progress downloadProgressBlock: ((Progress) -> Void)?, destination: ((URL, URLResponse) -> URL)?, completionHandler: ((URLResponse, URL?, Error?) -> Void)? = nil) -> URLSessionDownloadTask

    Parameters

    resumeData

    The data used to resume downloading.
    downloadProgressBlock

    A block object to be executed when the download progress is updated. Note this block is called on the session queue, not the main queue.
    destination

    A block object to be executed in order to determine the destination of the downloaded file. This block takes two arguments, the target path & the server response, and returns the desired file URL of the resulting download. The temporary file used during the download will be automatically deleted after being moved to the returned URL.
    completionHandler

    A block to be executed when a task finishes. This block has no return value and takes three arguments: the server response, the path of the downloaded file, and the error describing the network or parsing error that occurred, if any.
    Show on GitHub

Getting Progress for Tasks

  • Returns the upload progress of the specified task.

    Declaration

    Objective-C

    - (nullable NSProgress *)uploadProgressForTask:(nonnull NSURLSessionTask *)task;

    Swift

    func uploadProgress(for task: URLSessionTask) -> Progress?

    Parameters

    task

    The session task. Must not be nil.

    Return Value

    An NSProgress object reporting the upload progress of a task, or nil if the progress is unavailable.

    Show on GitHub

  • Returns the download progress of the specified task.

    Declaration

    Objective-C

    - (nullable NSProgress *)downloadProgressForTask:
    (nonnull NSURLSessionTask *)task;

    Swift

    func downloadProgress(for task: URLSessionTask) -> Progress?

    Parameters

    task

    The session task. Must not be nil.

    Return Value

    An NSProgress object reporting the download progress of a task, or nil if the progress is unavailable.

    Show on GitHub

Setting Session Delegate Callbacks

  • Sets a block to be executed when the managed session becomes invalid, as handled by the NSURLSessionDelegate method URLSession:didBecomeInvalidWithError:.

    Declaration

    Objective-C

    - (void)setSessionDidBecomeInvalidBlock:
    (nullable void (^)(NSURLSession *_Nonnull, NSError *_Nonnull))block;

    Swift

    func setSessionDidBecomeInvalidBlock(_ block: ((URLSession, Error) -> Void)?)

    Parameters

    block

    A block object to be executed when the managed session becomes invalid. The block has no return value, and takes two arguments: the session, and the error related to the cause of invalidation.
    Show on GitHub

  • Sets a block to be executed when a connection level authentication challenge has occurred, as handled by the NSURLSessionDelegate method URLSession:didReceiveChallenge:completionHandler:.

    Declaration

    Objective-C

    - (void)setSessionDidReceiveAuthenticationChallengeBlock:
    (nullable NSURLSessionAuthChallengeDisposition (^)(
        NSURLSession *_Nonnull, NSURLAuthenticationChallenge *_Nonnull,
        NSURLCredential *_Nullable *_Nullable))block;

    Swift

    func setSessionDidReceiveAuthenticationChallenge(_ block: ((URLSession, URLAuthenticationChallenge, AutoreleasingUnsafeMutablePointer<URLCredential?>?) -> URLSession.AuthChallengeDisposition)?)

    Parameters

    block

    A block object to be executed when a connection level authentication challenge has occurred. The block returns the disposition of the authentication challenge, and takes three arguments: the session, the authentication challenge, and a pointer to the credential that should be used to resolve the challenge.
    Show on GitHub

Setting Task Delegate Callbacks

  • Sets a block to be executed when a task requires a new request body stream to send to the remote server, as handled by the NSURLSessionTaskDelegate method URLSession:task:needNewBodyStream:.

    Declaration

    Objective-C

    - (void)setTaskNeedNewBodyStreamBlock:
    (nullable NSInputStream *_Nonnull (^)(NSURLSession *_Nonnull,
                                          NSURLSessionTask *_Nonnull))block;

    Swift

    func setTaskNeedNewBodyStreamBlock(_ block: ((URLSession, URLSessionTask) -> InputStream)?)

    Parameters

    block

    A block object to be executed when a task requires a new request body stream.
    Show on GitHub

  • Sets a block to be executed when an HTTP request is attempting to perform a redirection to a different URL, as handled by the NSURLSessionTaskDelegate method URLSession:willPerformHTTPRedirection:newRequest:completionHandler:.

    Declaration

    Objective-C

    - (void)setTaskWillPerformHTTPRedirectionBlock:
    (nullable NSURLRequest *_Nullable (^)(NSURLSession *_Nonnull,
                                          NSURLSessionTask *_Nonnull,
                                          NSURLResponse *_Nonnull,
                                          NSURLRequest *_Nonnull))block;

    Swift

    func setTaskWillPerformHTTPRedirectionBlock(_ block: ((URLSession, URLSessionTask, URLResponse, URLRequest) -> URLRequest?)?)

    Parameters

    block

    A block object to be executed when an HTTP request is attempting to perform a redirection to a different URL. The block returns the request to be made for the redirection, and takes four arguments: the session, the task, the redirection response, and the request corresponding to the redirection response.
    Show on GitHub

  • Sets a block to be executed when a session task has received a request specific authentication challenge, as handled by the NSURLSessionTaskDelegate method URLSession:task:didReceiveChallenge:completionHandler:.

    Declaration

    Objective-C

    - (void)setTaskDidReceiveAuthenticationChallengeBlock:
    (nullable NSURLSessionAuthChallengeDisposition (^)(
        NSURLSession *_Nonnull, NSURLSessionTask *_Nonnull,
        NSURLAuthenticationChallenge *_Nonnull,
        NSURLCredential *_Nullable *_Nullable))block;

    Swift

    func setTaskDidReceiveAuthenticationChallenge(_ block: ((URLSession, URLSessionTask, URLAuthenticationChallenge, AutoreleasingUnsafeMutablePointer<URLCredential?>?) -> URLSession.AuthChallengeDisposition)?)

    Parameters

    block

    A block object to be executed when a session task has received a request specific authentication challenge. The block returns the disposition of the authentication challenge, and takes four arguments: the session, the task, the authentication challenge, and a pointer to the credential that should be used to resolve the challenge.
    Show on GitHub

  • Sets a block to be executed periodically to track upload progress, as handled by the NSURLSessionTaskDelegate method URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:.

    Declaration

    Objective-C

    - (void)setTaskDidSendBodyDataBlock:
    (nullable void (^)(NSURLSession *_Nonnull, NSURLSessionTask *_Nonnull,
                       int64_t, int64_t, int64_t))block;

    Swift

    func setTaskDidSendBodyDataBlock(_ block: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?)

    Parameters

    block

    A block object to be called when an undetermined number of bytes have been uploaded to the server. This block has no return value and takes five arguments: the session, the task, the number of bytes written since the last time the upload progress block was called, the total bytes written, and the total bytes expected to be written during the request, as initially determined by the length of the HTTP body. This block may be called multiple times, and will execute on the main thread.
    Show on GitHub

  • Sets a block to be executed as the last message related to a specific task, as handled by the NSURLSessionTaskDelegate method URLSession:task:didCompleteWithError:.

    Declaration

    Objective-C

    - (void)setTaskDidCompleteBlock:(nullable void (^)(NSURLSession *_Nonnull,
                                                   NSURLSessionTask *_Nonnull,
                                                   NSError *_Nullable))block;

    Swift

    func setTaskDidComplete(_ block: ((URLSession, URLSessionTask, Error?) -> Void)?)

    Parameters

    block

    A block object to be executed when a session task is completed. The block has no return value, and takes three arguments: the session, the task, and any error that occurred in the process of executing the task.
    Show on GitHub

Setting Data Task Delegate Callbacks

  • Sets a block to be executed when a data task has received a response, as handled by the NSURLSessionDataDelegate method URLSession:dataTask:didReceiveResponse:completionHandler:.

    Declaration

    Objective-C

    - (void)setDataTaskDidReceiveResponseBlock:
    (nullable NSURLSessionResponseDisposition (^)(
        NSURLSession *_Nonnull, NSURLSessionDataTask *_Nonnull,
        NSURLResponse *_Nonnull))block;

    Swift

    func setDataTaskDidReceiveResponseBlock(_ block: ((URLSession, URLSessionDataTask, URLResponse) -> URLSession.ResponseDisposition)?)

    Parameters

    block

    A block object to be executed when a data task has received a response. The block returns the disposition of the session response, and takes three arguments: the session, the data task, and the received response.
    Show on GitHub

  • Sets a block to be executed when a data task has become a download task, as handled by the NSURLSessionDataDelegate method URLSession:dataTask:didBecomeDownloadTask:.

    Declaration

    Objective-C

    - (void)setDataTaskDidBecomeDownloadTaskBlock:
    (nullable void (^)(NSURLSession *_Nonnull, NSURLSessionDataTask *_Nonnull,
                       NSURLSessionDownloadTask *_Nonnull))block;

    Swift

    func setDataTaskDidBecomeDownloadTaskBlock(_ block: ((URLSession, URLSessionDataTask, URLSessionDownloadTask) -> Void)?)

    Parameters

    block

    A block object to be executed when a data task has become a download task. The block has no return value, and takes three arguments: the session, the data task, and the download task it has become.
    Show on GitHub

  • Sets a block to be executed when a data task receives data, as handled by the NSURLSessionDataDelegate method URLSession:dataTask:didReceiveData:.

    Declaration

    Objective-C

    - (void)setDataTaskDidReceiveDataBlock:
    (nullable void (^)(NSURLSession *_Nonnull, NSURLSessionDataTask *_Nonnull,
                       NSData *_Nonnull))block;

    Swift

    func setDataTaskDidReceiveDataBlock(_ block: ((URLSession, URLSessionDataTask, Data) -> Void)?)

    Parameters

    block

    A block object to be called when an undetermined number of bytes have been downloaded from the server. This block has no return value and takes three arguments: the session, the data task, and the data received. This block may be called multiple times, and will execute on the session manager operation queue.
    Show on GitHub

  • Sets a block to be executed to determine the caching behavior of a data task, as handled by the NSURLSessionDataDelegate method URLSession:dataTask:willCacheResponse:completionHandler:.

    Declaration

    Objective-C

    - (void)setDataTaskWillCacheResponseBlock:
    (nullable NSCachedURLResponse *_Nonnull (^)(
        NSURLSession *_Nonnull, NSURLSessionDataTask *_Nonnull,
        NSCachedURLResponse *_Nonnull))block;

    Swift

    func setDataTaskWillCacheResponseBlock(_ block: ((URLSession, URLSessionDataTask, CachedURLResponse) -> CachedURLResponse)?)

    Parameters

    block

    A block object to be executed to determine the caching behavior of a data task. The block returns the response to cache, and takes three arguments: the session, the data task, and the proposed cached URL response.
    Show on GitHub

  • Sets a block to be executed once all messages enqueued for a session have been delivered, as handled by the NSURLSessionDataDelegate method URLSessionDidFinishEventsForBackgroundURLSession:.

    Declaration

    Objective-C

    - (void)setDidFinishEventsForBackgroundURLSessionBlock:
    (nullable void (^)(NSURLSession *_Nonnull))block;

    Swift

    func setDidFinishEventsForBackgroundURLSessionBlock(_ block: ((URLSession) -> Void)?)

    Parameters

    block

    A block object to be executed once all messages enqueued for a session have been delivered. The block has no return value and takes a single argument: the session.
    Show on GitHub

Setting Download Task Delegate Callbacks

  • Sets a block to be executed when a download task has completed a download, as handled by the NSURLSessionDownloadDelegate method URLSession:downloadTask:didFinishDownloadingToURL:.

    Declaration

    Objective-C

    - (void)setDownloadTaskDidFinishDownloadingBlock:
    (nullable NSURL *_Nullable (^)(NSURLSession *_Nonnull,
                                   NSURLSessionDownloadTask *_Nonnull,
                                   NSURL *_Nonnull))block;

    Swift

    func setDownloadTaskDidFinishDownloadingBlock(_ block: ((URLSession, URLSessionDownloadTask, URL) -> URL?)?)

    Parameters

    block

    A block object to be executed when a download task has completed. The block returns the URL the download should be moved to, and takes three arguments: the session, the download task, and the temporary location of the downloaded file. If the file manager encounters an error while attempting to move the temporary file to the destination, an LCURLSessionDownloadTaskDidFailToMoveFileNotification will be posted, with the download task as its object, and the user info of the error.
    Show on GitHub

  • Sets a block to be executed periodically to track download progress, as handled by the NSURLSessionDownloadDelegate method URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesWritten:totalBytesExpectedToWrite:.

    Declaration

    Objective-C

    - (void)setDownloadTaskDidWriteDataBlock:
    (nullable void (^)(NSURLSession *_Nonnull,
                       NSURLSessionDownloadTask *_Nonnull, int64_t, int64_t,
                       int64_t))block;

    Swift

    func setDownloadTaskDidWriteDataBlock(_ block: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?)

    Parameters

    block

    A block object to be called when an undetermined number of bytes have been downloaded from the server. This block has no return value and takes five arguments: the session, the download task, the number of bytes read since the last time the download progress block was called, the total bytes read, and the total bytes expected to be read during the request, as initially determined by the expected content size of the NSHTTPURLResponse object. This block may be called multiple times, and will execute on the session manager operation queue.
    Show on GitHub

  • Sets a block to be executed when a download task has been resumed, as handled by the NSURLSessionDownloadDelegate method URLSession:downloadTask:didResumeAtOffset:expectedTotalBytes:.

    Declaration

    Objective-C

    - (void)setDownloadTaskDidResumeBlock:
    (nullable void (^)(NSURLSession *_Nonnull,
                       NSURLSessionDownloadTask *_Nonnull, int64_t,
                       int64_t))block;

    Swift

    func setDownloadTaskDidResumeBlock(_ block: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?)

    Parameters

    block

    A block object to be executed when a download task has been resumed. The block has no return value and takes four arguments: the session, the download task, the file offset of the resumed download, and the total number of bytes expected to be downloaded.
    Show on GitHub