APIError Enumeration Reference


                    
                    
                    UserInfo

Dictionary used to store additional information

Declaration

Swift

public typealias UserInfo = [String : Any]


                    
                    
                    StatusCode

Status code Int

Declaration

Swift

public typealias StatusCode = Int


                    
                    
                    unknown(_:_:_:)

An unknown error

Declaration

Swift

case unknown(ErrorDescription, RecoverySuggestion, _: Error? = nil)


                    
                    
                    invalidConfiguration(_:_:_:)

The configuration for a particular API was invalid

Declaration

Swift

case invalidConfiguration(ErrorDescription, RecoverySuggestion, _: Error? = nil)


                    
                    
                    invalidURL(_:_:_:)

The URL in a request was invalid or missing

Declaration

Swift

case invalidURL(ErrorDescription, RecoverySuggestion, _: Error? = nil)


                    
                    
                    operationError(_:_:_:)

An in-process operation encountered a processing error

Declaration

Swift

case operationError(ErrorDescription, RecoverySuggestion, _: Error? = nil)


                    
                    
                    networkError(_:_:_:)

The category received an underlying error from network layer.

Declaration

Swift

case networkError(ErrorDescription, _: UserInfo? = nil, _: Error? = nil)


                    
                    
                    httpStatusError(_:_:)

A non 2xx response from the service.

Declaration

Swift

case httpStatusError(StatusCode, HTTPURLResponse)


                    
                    
                    pluginError(_:)

An error to encapsulate an error received by a dependent plugin

Declaration

Swift

case pluginError(AmplifyError)


                    
                    
                    init(errorDescription:recoverySuggestion:error:)

Declaration

Swift

public init(
    errorDescription: ErrorDescription = "An unknown error occurred",
    recoverySuggestion: RecoverySuggestion = "See `underlyingError` for more details",
    error: Error
)


                    
                    
                    errorDescription

Declaration

Swift

public var errorDescription: ErrorDescription { get }


                    
                    
                    recoverySuggestion

Declaration

Swift

public var recoverySuggestion: RecoverySuggestion { get }


                    
                    
                    underlyingError

Declaration

Swift

public var underlyingError: Error? { get }