ParameterEncoding

public protocol ParameterEncoding

A type used to define how a set of parameters are applied to a URLRequest.

  • Creates a URL request by encoding parameters and applying them onto an existing request.

    Throws

    An AFError.parameterEncodingFailed error if encoding fails.

    Declaration

    Swift

    func encode(_ urlRequest: URLRequestConvertible, with parameters: Parameters?) throws -> URLRequest

    Parameters

    urlRequest

    The request to have parameters applied.
    parameters

    The parameters to apply.

    Return Value

    The encoded request.