SessionManager

Defines whether the MultipartFormData encoding was successful and contains result of the encoding as associated values.

• Success: Represents a successful MultipartFormData encoding and contains the new UploadRequest along with streaming information.
• Failure: Used to represent a failure in the MultipartFormData encoding and also contains the encoding error.

A default instance of SessionManager, used by top-level Alamofire request methods, and suitable for use directly for any ad hoc requests.

Creates default values for the “Accept-Encoding”, “Accept-Language” and “User-Agent” headers.

Default memory threshold used when encoding MultipartFormData in bytes.

The underlying session.

The session delegate handling all the task and session delegate callbacks.

Whether to start requests immediately after being constructed. true by default.

The request adapter called each time a new request is created.

The request retrier called each time a request encounters an error to determine whether to retry the request.

The background completion handler closure provided by the UIApplicationDelegate application:handleEventsForBackgroundURLSession:completionHandler: method. By setting the background completion handler, the SessionDelegate sessionDidFinishEventsForBackgroundURLSession closure implementation will automatically call the handler.

If you need to handle your own events before the handler is called, then you need to override the SessionDelegate sessionDidFinishEventsForBackgroundURLSession and manually call the handler when finished.

nil by default.

Creates an instance with the specified configuration, delegate and serverTrustPolicyManager.

Creates an instance with the specified session, delegate and serverTrustPolicyManager.

Creates a DataRequest to retrieve the contents of the specified url, method, parameters, encoding and headers.

Creates a DataRequest to retrieve the contents of a URL based on the specified urlRequest.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a DownloadRequest to retrieve the contents the specified url, method, parameters, encoding, headers and save them to the destination.

If destination is not specified, the contents will remain in the temporary location determined by the underlying URL session.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a DownloadRequest to retrieve the contents of a URL based on the specified urlRequest and save them to the destination.

If destination is not specified, the contents will remain in the temporary location determined by the underlying URL session.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a DownloadRequest from the resumeData produced from a previous request cancellation to retrieve the contents of the original request and save them to the destination.

If destination is not specified, the contents will remain in the temporary location determined by the underlying URL session.

If startRequestsImmediately is true, the request will have resume() called before being returned.

On the latest release of all the Apple platforms (iOS 10, macOS 10.12, tvOS 10, watchOS 3), resumeData is broken on background URL session configurations. There’s an underlying bug in the resumeData generation logic where the data is written incorrectly and will always fail to resume the download. For more information about the bug and possible workarounds, please refer to the following Stack Overflow post:

• http://stackoverflow.com/a/39347461/1342462

Creates an UploadRequest from the specified url, method and headers for uploading the file.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a UploadRequest from the specified urlRequest for uploading the file.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates an UploadRequest from the specified url, method and headers for uploading the data.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates an UploadRequest from the specified urlRequest for uploading the data.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates an UploadRequest from the specified url, method and headers for uploading the stream.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates an UploadRequest from the specified urlRequest for uploading the stream.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Encodes multipartFormData using encodingMemoryThreshold and calls encodingCompletion with new UploadRequest using the url, method and headers.

It is important to understand the memory implications of uploading MultipartFormData. If the cummulative payload is small, encoding the data in-memory and directly uploading to a server is the by far the most efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be used for larger payloads such as video content.

The encodingMemoryThreshold parameter allows Alamofire to automatically determine whether to encode in-memory or stream from disk. If the content length of the MultipartFormData is below the encodingMemoryThreshold, encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding technique was used.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Encodes multipartFormData using encodingMemoryThreshold and calls encodingCompletion with new UploadRequest using the urlRequest.

It is important to understand the memory implications of uploading MultipartFormData. If the cummulative payload is small, encoding the data in-memory and directly uploading to a server is the by far the most efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be used for larger payloads such as video content.

The encodingMemoryThreshold parameter allows Alamofire to automatically determine whether to encode in-memory or stream from disk. If the content length of the MultipartFormData is below the encodingMemoryThreshold, encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding technique was used.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a StreamRequest for bidirectional streaming using the hostname and port.

If startRequestsImmediately is true, the request will have resume() called before being returned.

Creates a StreamRequest for bidirectional streaming using the netService.

If startRequestsImmediately is true, the request will have resume() called before being returned.

A default with cache policy instance of SessionManager, used by top-level Alamofire request methods, and suitable for use directly for any ad hoc requests.