AFError

public enum AFError : Error

AFError is the error type returned by Alamofire. It encompasses a few different types of errors, each with their own associated reasons.

ParameterEncodingFailureReason
The underlying reason the .parameterEncodingFailed error occurred.
See more
Declaration
Swift

public enum ParameterEncodingFailureReason
ParameterEncoderFailureReason
The underlying reason the .parameterEncoderFailed error occurred.
See more
Declaration
Swift

public enum ParameterEncoderFailureReason
MultipartEncodingFailureReason
The underlying reason the .multipartEncodingFailed error occurred.
See more
Declaration
Swift

public enum MultipartEncodingFailureReason
ResponseValidationFailureReason
The underlying reason the .responseValidationFailed error occurred.
See more
Declaration
Swift

public enum ResponseValidationFailureReason
ResponseSerializationFailureReason
The underlying reason the response serialization error occurred.
See more
Declaration
Swift

public enum ResponseSerializationFailureReason
ServerTrustFailureReason
Underlying reason a server trust evaluation error occurred.
See more
Declaration
Swift

public enum ServerTrustFailureReason
sessionDeinitialized
Session which issued the Request was deinitialized, most likely because its reference went out of scope.
Declaration
Swift

case sessionDeinitialized
sessionInvalidated(error:)
Session was explicitly invalidated, possibly with the Error produced by the underlying URLSession.
Declaration
Swift

case sessionInvalidated(error: Error?)
explicitlyCancelled
Request was explcitly cancelled.
Declaration
Swift

case explicitlyCancelled
invalidURL(url:)
URLConvertible type failed to create a valid URL.
Declaration
Swift

case invalidURL(url: URLConvertible)
parameterEncodingFailed(reason:)
ParameterEncoding threw an error during the encoding process.
Declaration
Swift

case parameterEncodingFailed(reason: ParameterEncodingFailureReason)
parameterEncoderFailed(reason:)
ParameterEncoder threw an error while running the encoder.
Declaration
Swift

case parameterEncoderFailed(reason: ParameterEncoderFailureReason)
multipartEncodingFailed(reason:)
Multipart form encoding failed.
Declaration
Swift

case multipartEncodingFailed(reason: MultipartEncodingFailureReason)
requestAdaptationFailed(error:)
RequestAdapter failed threw an error during adaptation.
Declaration
Swift

case requestAdaptationFailed(error: Error)
responseValidationFailed(reason:)
Response validation failed.
Declaration
Swift

case responseValidationFailed(reason: ResponseValidationFailureReason)
responseSerializationFailed(reason:)
Response serialization failued.
Declaration
Swift

case responseSerializationFailed(reason: ResponseSerializationFailureReason)
serverTrustEvaluationFailed(reason:)
ServerTrustEvaluating instance threw an error during trust evaluation.
Declaration
Swift

case serverTrustEvaluationFailed(reason: ServerTrustFailureReason)
requestRetryFailed(retryError:originalError:)
RequestRetrier threw an error during the request retry process.
Declaration
Swift

case requestRetryFailed(retryError: Error, originalError: Error)

Error Booleans

isSessionDeinitializedError
Returns whether the instance is .sessionDeinitialized.
Declaration
Swift

public var isSessionDeinitializedError: Bool { get }
isSessionInvalidatedError
Returns whether the instance is .sessionInvalidated.
Declaration
Swift

public var isSessionInvalidatedError: Bool { get }
isExplicitlyCancelledError
Returns whether the instance is .explicitlyCancelled.
Declaration
Swift

public var isExplicitlyCancelledError: Bool { get }
isInvalidURLError
Returns whether the instance is .invalidURL.
Declaration
Swift

public var isInvalidURLError: Bool { get }
isParameterEncodingError
Returns whether the instance is .parameterEncodingFailed. When true, the underlyingError property will contain the associated value.
Declaration
Swift

public var isParameterEncodingError: Bool { get }
isParameterEncoderError
Returns whether the instance is .parameterEncoderFailed. When true, the underlyingError property will contain the associated value.
Declaration
Swift

public var isParameterEncoderError: Bool { get }
isMultipartEncodingError
Returns whether the instance is .multipartEncodingFailed. When true, the url and underlyingError properties will contain the associated values.
Declaration
Swift

public var isMultipartEncodingError: Bool { get }
isRequestAdaptationError
Returns whether the instance is .requestAdaptationFailed. When true, the underlyingError property will contain the associated value.
Declaration
Swift

public var isRequestAdaptationError: Bool { get }
isResponseValidationError
Returns whether the instance is .responseValidationFailed. When true, the acceptableContentTypes, responseContentType, and responseCode properties will contain the associated values.
Declaration
Swift

public var isResponseValidationError: Bool { get }
isResponseSerializationError
Returns whether the instance is .responseSerializationFailed. When true, the failedStringEncoding and underlyingError properties will contain the associated values.
Declaration
Swift

public var isResponseSerializationError: Bool { get }
isServerTrustEvaluationError
Returns whether the instance is .serverTrustEvaluationFailed.
Declaration
Swift

public var isServerTrustEvaluationError: Bool { get }
isRequestRetryError
Returns whether the instance is requestRetryFailed. When true, the underlyingError property will contain the associated value.
Declaration
Swift

public var isRequestRetryError: Bool { get }

Convenience Properties

urlConvertible
The URLConvertible associated with the error.
Declaration
Swift

public var urlConvertible: URLConvertible? { get }
url
The URL associated with the error.
Declaration
Swift

public var url: URL? { get }
underlyingError
The underlying Error responsible for generating the failure associated with .sessionInvalidated, .parameterEncodingFailed, .parameterEncoderFailed, .multipartEncodingFailed, .requestAdaptationFailed, .responseSerializationFailed, .requestRetryFailed errors.
Declaration
Swift

public var underlyingError: Error? { get }
acceptableContentTypes
The acceptable Content-Types of a .responseValidationFailed error.
Declaration
Swift

public var acceptableContentTypes: [String]? { get }
responseContentType
The response Content-Type of a .responseValidationFailed error.
Declaration
Swift

public var responseContentType: String? { get }
responseCode
The response code of a .responseValidationFailed error.
Declaration
Swift

public var responseCode: Int? { get }
failedStringEncoding
The String.Encoding associated with a failed .stringResponse() call.
Declaration
Swift

public var failedStringEncoding: String.Encoding? { get }

Error Descriptions


                    
                    
                    errorDescription

Declaration

Swift

public var errorDescription: String? { get }