Classes

The following classes are available globally.

  • Constructs multipart/form-data for uploads within an HTTP or HTTPS body. There are currently two ways to encode multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.

    For more information on multipart/form-data in general, please refer to the RFC-2388 and RFC-2045 specs as well and the w3 form documentation.

    See more

    Declaration

    Swift

    open class MultipartFormData
  • The NetworkReachabilityManager class listens for reachability changes of hosts and addresses for both cellular and WiFi network interfaces.

    Reachability can be used to determine background information about why a network operation failed, or to retry network requests when a connection is established. It should not be used to prevent a user from initiating a network request, as it’s possible that an initial request may be required to establish reachability.

    See more

    Declaration

    Swift

    open class NetworkReachabilityManager
  • Request is the common superclass of all Alamofire request types and provides common state, delegate, and callback handling.

    See more

    Declaration

    Swift

    public class Request
  • A ParameterEncoder that encodes types as JSON body data.

    If no Content-Type header is already set on the provided URLRequests, it’s set to application/json.

    See more

    Declaration

    Swift

    open class JSONParameterEncoder : ParameterEncoder
  • A ParameterEncoder that encodes types as URL-encoded query strings to be set on the URL or as body data, depending on the Destination set.

    If no Content-Type header is already set on the provided URLRequests, it will be set to application/x-www-form-urlencoded; charset=utf-8.

    Encoding behavior can be customized by passing an instance of URLEncodedFormEncoder to the initializer.

    See more

    Declaration

    Swift

    open class URLEncodedFormParameterEncoder : ParameterEncoder
  • A ResponseSerializer that performs minimal response checking and returns any response data as-is. By default, a request returning nil or no data is considered an error. However, if the response is has a status code valid for empty responses (204, 205), then an empty Data value is returned.

    See more

    Declaration

    Swift

    public final class DataResponseSerializer : ResponseSerializer
  • A ResponseSerializer that decodes the response data as a String. By default, a request returning nil or no data is considered an error. However, if the response is has a status code valid for empty responses (204, 205), then an empty String is returned.

    See more

    Declaration

    Swift

    public final class StringResponseSerializer : ResponseSerializer
  • A ResponseSerializer that decodes the response data using JSONSerialization. By default, a request returning nil or no data is considered an error. However, if the response is has a status code valid for empty responses (204, 205), then an NSNull value is returned.

    See more

    Declaration

    Swift

    public final class JSONResponseSerializer : ResponseSerializer
  • A ResponseSerializer that decodes the response data as a generic value using any type that conforms to DataDecoder. By default, this is an instance of JSONDecoder. Additionally, a request returning nil or no data is considered an error. However, if the response is has a status code valid for empty responses (204, 205), then the Empty.value value is returned.

    See more

    Declaration

    Swift

    public final class DecodableResponseSerializer<T> : ResponseSerializer where T : Decodable
  • A retry policy that retries requests using an exponential backoff for allowed HTTP methods and HTTP status codes as well as certain types of networking errors.

    See more

    Declaration

    Swift

    open class RetryPolicy : RequestInterceptor
  • A retry policy that automatically retries idempotent requests for network connection lost errors. For more information about retrying network connection lost errors, please refer to Apple’s technical document.

    See more

    Declaration

    Swift

    open class ConnectionLostRetryPolicy : RetryPolicy
  • An evaluator which uses the default server trust evaluation while allowing you to control whether to validate the host provided by the challenge. Applications are encouraged to always validate the host in production environments to guarantee the validity of the server’s certificate chain.

    See more

    Declaration

    Swift

    public final class DefaultTrustEvaluator : ServerTrustEvaluating
  • An evaluator which Uses the default and revoked server trust evaluations allowing you to control whether to validate the host provided by the challenge as well as specify the revocation flags for testing for revoked certificates. Apple platforms did not start testing for revoked certificates automatically until iOS 10.1, macOS 10.12 and tvOS 10.1 which is demonstrated in our TLS tests. Applications are encouraged to always validate the host in production environments to guarantee the validity of the server’s certificate chain.

    See more

    Declaration

    Swift

    public final class RevocationTrustEvaluator : ServerTrustEvaluating
  • Uses the pinned certificates to validate the server trust. The server trust is considered valid if one of the pinned certificates match one of the server certificates. By validating both the certificate chain and host, certificate pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks. Applications are encouraged to always validate the host and require a valid certificate chain in production environments.

    See more

    Declaration

    Swift

    public final class PinnedCertificatesTrustEvaluator : ServerTrustEvaluating
  • Uses the pinned public keys to validate the server trust. The server trust is considered valid if one of the pinned public keys match one of the server certificate public keys. By validating both the certificate chain and host, public key pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks. Applications are encouraged to always validate the host and require a valid certificate chain in production environments.

    See more

    Declaration

    Swift

    public final class PublicKeysTrustEvaluator : ServerTrustEvaluating
  • Uses the provided evaluators to validate the server trust. The trust is only considered valid if all of the evaluators consider it valid.

    See more

    Declaration

    Swift

    public final class CompositeTrustEvaluator : ServerTrustEvaluating
  • Disables all evaluation which in turn will always consider any server trust as valid.

    THIS EVALUATOR SHOULD NEVER BE USED IN PRODUCTION!

    See more

    Declaration

    Swift

    public final class DisabledEvaluator : ServerTrustEvaluating
  • Session creates and manages Alamofire’s Request types during their lifetimes. It also provides common functionality for all Requests, including queuing, interception, trust management, redirect handling, and response cache handling.

    See more

    Declaration

    Swift

    open class Session
  • Class which implements the various URLSessionDelegate methods to connect various Alamofire features.

    See more

    Declaration

    Swift

    open class SessionDelegate : NSObject
  • An object that encodes instances into URL-encoded query strings.

    There is no published specification for how to encode collection types. By default, the convention of appending [] to the key for array values (foo[]=1&foo[]=2), and appending the key surrounded by square brackets for nested dictionary values (foo[bar]=baz) is used. Optionally, ArrayEncoding can be used to omit the square brackets appended to array keys.

    BoolEncoding can be used to configure how Bool values are encoded. The default behavior is to encode true as 1 and false as 0.

    DateEncoding can be used to configure how Date values are encoded. By default, the .deferredToDate strategy is used, which formats dates from their structure.

    SpaceEncoding can be used to configure how spaces are encoded. Modern encodings use percent replacement (%20), while older encodings may expect spaces to be replaced with +.

    This type is largely based on Vapor’s url-encoded-form project.

    See more

    Declaration

    Swift

    public final class URLEncodedFormEncoder