OutOfBandOperationError

public enum OutOfBandOperationError : MobileAuthenticationClientError
extension OutOfBandOperationError: LocalizedError

The error that can occur when the processing of an OutOfBandPayload fails.

  • The token was already redeemed. This can occur for instance when a user scans twice the same QR code containing a token (a token can only be used once).

    Declaration

    Swift

    case TokenAlreadyRedeemed(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • The token has expired. This occurs for example when it took to long to the user to scan a QR code or to open a push notification.

    Declaration

    Swift

    case TokenExpired(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • A network error occurred while redeeming the token: either the server was not reachable or it returned an HTTP error.

    Declaration

    Swift

    case NetworkError(cause: Error? = nil)

    Parameters

    cause

    The underlying error that is related to the error occurred.

  • The iOS device has no passcode set.

    Declaration

    Swift

    case NoDeviceLockError

  • Unknown error, handling not categorized error cases.

    Requires

    iOS platform

    Declaration

    Swift

    case Unknown(message: String? = nil, cause: Error? = nil)

    Parameters

    message

    Additional information about the error.
    cause

    The underlying error that is related to the error occurred.

Localized descriptions

  • A message describing what error occurred.

    Declaration

    Swift

    public var errorDescription: String? { get }