AF

public enum AF

Global namespace containing API for the default Session instance.

Data Request

Download Request

URLRequest

Resume Data

  • Creates a DownloadRequest using the SessionManager.default from the resumeData produced from a previous DownloadRequest 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.

    On some versions of all Apple platforms (iOS 10 - 10.2, macOS 10.12 - 10.12.2, tvOS 10 - 10.1, watchOS 3 - 3.1.1), 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 this Stack Overflow post.

    Declaration

    Swift

    public static func download(resumingWith resumeData: Data,
                            to destination: DownloadRequest.Destination? = nil) -> DownloadRequest

    Parameters

    resumeData

    The resume Data. This is an opaque blob produced by URLSessionDownloadTask when a task is cancelled. See Apple’s documentation for more information.
    destination

    The DownloadRequest.Destination closure used to determine the destination of the downloaded file. nil by default.

    Return Value

    The created DownloadRequest.

File

Data

InputStream

MultipartFormData

  • Encodes multipartFormData using encodingMemoryThreshold and uploads the result using SessionManager.default with the url, method, and headers provided.

    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.

    Declaration

    Swift

    public static func upload(multipartFormData: @escaping (MultipartFormData) -> Void,
                          usingThreshold encodingMemoryThreshold: UInt64 = MultipartUpload.encodingMemoryThreshold,
                          to url: URLConvertible,
                          method: HTTPMethod = .post,
                          headers: HTTPHeaders? = nil) -> UploadRequest

    Parameters

    multipartFormData

    The closure used to append body parts to the MultipartFormData.
    encodingMemoryThreshold

    The encoding memory threshold in bytes. 10_000_000 bytes by default.
    url

    The URLConvertible value.
    method

    The HTTPMethod, .post by default.
    headers

    The HTTPHeaders, nil by default.

    Return Value

    The created UploadRequest.

  • Encodes multipartFormData using encodingMemoryThreshold and uploads the result using SessionManager.default using the urlRequest provided.

    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.

    Declaration

    Swift

    @discardableResult
public static func upload(multipartFormData: @escaping (MultipartFormData) -> Void,
                          usingThreshold encodingMemoryThreshold: UInt64 = MultipartUpload.encodingMemoryThreshold,
                          with urlRequest: URLRequestConvertible) -> UploadRequest

    Parameters

    multipartFormData

    The closure used to append body parts to the MultipartFormData.
    encodingMemoryThreshold

    The encoding memory threshold in bytes. 10_000_000 bytes by default.
    urlRequest

    Return Value

    The UploadRequest created.