androidx.biometric.auth

Interfaces

AuthPrompt

A handle to the prompt that is shown while the user is authenticating.

Classes

AuthPromptCallback

A collection of methods that may be invoked by an auth prompt during authentication.

AuthPromptHost

A wrapper class for the component that will be used to host an auth prompt.

Class2BiometricAuthExtensionsKt
Class2BiometricAuthPrompt

An authentication prompt that requires the user to present a Class 2 biometric (e.g. fingerprint, face, or iris).

Class2BiometricAuthPrompt.Builder

Builder for a Class2BiometricAuthPrompt with configurable options.

Class2BiometricOrCredentialAuthExtensionsKt
Class2BiometricOrCredentialAuthPrompt

An authentication prompt that requires the user to present a Class 2 biometric (e.g. fingerprint, face, or iris) or the screen lock credential (i.e. PIN, pattern, or password) for the device.

Class2BiometricOrCredentialAuthPrompt.Builder

Builder for a Class2BiometricOrCredentialAuthPrompt with configurable options.

Class3BiometricAuthExtensionsKt
Class3BiometricAuthPrompt

An authentication prompt that requires the user to present a Class 3 biometric (e.g. fingerprint, face, or iris).

Class3BiometricAuthPrompt.Builder

Builder for a Class3BiometricAuthPrompt with configurable options.

Class3BiometricOrCredentialAuthExtensionsKt
Class3BiometricOrCredentialAuthPrompt

An authentication prompt that requires the user to present a Class 3 biometric (e.g. fingerprint, face, or iris) or the screen lock credential (i.e. PIN, pattern, or password) for the device.

Class3BiometricOrCredentialAuthPrompt.Builder

Builder for a Class3BiometricOrCredentialAuthPrompt with configurable options.

CredentialAuthExtensionsKt
CredentialAuthPrompt

An authentication prompt that requires the user to present the screen lock credential (i.e. PIN, pattern, or password) for the device.

CredentialAuthPrompt.Builder

Builder for a CredentialAuthPrompt with configurable options.

Exceptions

AuthPromptErrorException

Thrown when an unrecoverable error has been encountered and authentication has stopped.

AuthPromptFailureException

Thrown when an authentication attempt by the user has been rejected, e.g., the user's biometrics were not recognized.