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. |
Class2BiometricAuthPrompt |
An authentication prompt that requires the user to present a Class 2 biometric (e.g. fingerprint, face, or iris). |
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. |
Class3BiometricAuthPrompt |
An authentication prompt that requires the user to present a Class 3 biometric (e.g. fingerprint, face, or iris). |
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. |
CredentialAuthPrompt |
An authentication prompt that requires the user to present the screen lock credential (i.e. PIN, pattern, or password) for the device. |
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. |
Extension functions summary
For Class2BiometricAuthPrompt | |
suspend BiometricPrompt.AuthenticationResult |
Shows an authentication prompt to the user. |
For Class2BiometricOrCredentialAuthPrompt | |
suspend BiometricPrompt.AuthenticationResult |
Shows an authentication prompt to the user. |
For Class3BiometricAuthPrompt | |
suspend BiometricPrompt.AuthenticationResult |
Class3BiometricAuthPrompt.authenticate(host: AuthPromptHost, crypto: BiometricPrompt.CryptoObject?) Shows an authentication prompt to the user. |
For Class3BiometricOrCredentialAuthPrompt | |
suspend BiometricPrompt.AuthenticationResult |
Class3BiometricOrCredentialAuthPrompt.authenticate(host: AuthPromptHost, crypto: BiometricPrompt.CryptoObject?) Shows an authentication prompt to the user. |
For CredentialAuthPrompt | |
suspend BiometricPrompt.AuthenticationResult |
CredentialAuthPrompt.authenticate(host: AuthPromptHost, crypto: BiometricPrompt.CryptoObject?) Shows an authentication prompt to the user. |
For FragmentActivity | |
suspend BiometricPrompt.AuthenticationResult |
FragmentActivity.authenticateWithClass2Biometrics(title: CharSequence, negativeButtonText: CharSequence, subtitle: CharSequence? = null, description: CharSequence? = null, confirmationRequired: Boolean = true) Prompts the user to authenticate with a Class 2 biometric (e. |
suspend BiometricPrompt.AuthenticationResult |
FragmentActivity.authenticateWithClass2BiometricsOrCredentials(title: CharSequence, subtitle: CharSequence? = null, description: CharSequence? = null, confirmationRequired: Boolean = true) Prompts the user to authenticate with a Class 2 biometric (e. |
AuthPrompt |
FragmentActivity.authenticateWithClass3Biometrics(crypto: BiometricPrompt.CryptoObject?, title: CharSequence, negativeButtonText: CharSequence, subtitle: CharSequence? = null, description: |