OutOfBandPayloadError

public enum OutOfBandPayloadError : MobileAuthenticationClientError
extension OutOfBandPayloadError: LocalizedError

The error returned when there is a problem with the out-of-band payload.

  • A violation of the out-of-band payload (contents of OutOfBandPayload) occurred. The message was malformed.

    Declaration

    Swift

    case MalformedPayload(cause: Error? = nil)

    Parameters

    cause

    The underlying error.

  • The encrypted contents of the out-of-band payload could not be decrypted. This occurs for instance when the keys that are used to decrypt the out-of-band payload are deleted. The problem can also occur in the case where the user is trying to redeem a token that was generated for another mobile device: a malicious user trying to authenticate using the QR code generated by another user, or a user with multiple devices trying to scan the QR using the wrong device.

    Declaration

    Swift

    case DecryptionError(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 }