Context

public struct Context

The context provided to the user interaction delegate for a user verification.

  • The account associated with the operation.

    Declaration

    Swift

    public let account: Account?
  • The authenticator that requires user verification.

    Declaration

    Swift

    public let authenticator: AuthenticatorInformation
  • The authenticator protection status.

    Declaration

    Swift

    public let authenticatorProtectionStatus: AuthenticatorProtectionStatus
  • The formatting properties of the authenticator if applicable.

    Declaration

    Swift

    public let credentialFormat: CredentialFormat?
  • A message to be displayed to the user in case of transaction confirmation.

    Note

    The exact format of the message may depend on the server, e.g. a simple String or a JSON representation.

    Declaration

    Swift

    public let transactionConfirmationData: Data?
  • In case a recoverable error occurs during the verification of credentials, this property contains information about it.

    Always contains the last error, in case of more consecutive recoverable error scenarios.

    Declaration

    Swift

    public let lastRecoverableError: RecoverableError?
  • ** ONLY FOR AUTOMATED TESTING PURPOSES; DO NOT USE IN PRODUCTION CODE **

    Creates a new context.

    Declaration

    Swift

    public init(account: Account? = nil, authenticator: AuthenticatorInformation, authenticatorProtectionStatus: AuthenticatorProtectionStatus, credentialFormat: CredentialFormat?, transactionConfirmationData: Data?, lastRecoverableError: RecoverableError? = nil)

    Parameters

    account

    The account associated with the operation.

    authenticator

    The authenticator that requires user verification.

    authenticatorProtectionStatus

    The authenticator protection status.

    credentialFormat

    The formatting properties of the authenticator if applicable.

    transactionConfirmationData

    A message to be displayed to the user in case of transaction confirmation.

    lastRecoverableError

    The last occurred recoverable error if it is supported by the authenticator.