AuthenticationRequest.Biometric
class AuthenticationRequest.Biometric : AuthenticationRequest
| kotlin.Any | ||
| ↳ | androidx.biometric.AuthenticationRequest | |
| ↳ | androidx.biometric.AuthenticationRequest.Biometric |
A set of configurable options for how the BiometricPrompt should appear and behave with biometric authentication with fallbacks.
Summary
Nested types |
|---|
|
Builder used to create an instance of |
abstract class AuthenticationRequest.Biometric.FallbackFallback options for the biometric authentication. |
class AuthenticationRequest.Biometric.Fallback.CustomOption : AuthenticationRequest.Biometric.FallbackCustom Fallback option displayed as the negative button in prompt authentication screen if it is the only option or displayed in a list in the fallback options page if there are more than one. |
object AuthenticationRequest.Biometric.Fallback.DeviceCredential : AuthenticationRequest.Biometric.FallbackDevice credential as the fallback. |
abstract class AuthenticationRequest.Biometric.StrengthTypes of biometric strength for the prompt. |
|
Class 2 (formerly Weak). |
|
Class 3 (formerly Strong). |
Public companion functions |
|
|---|---|
Int |
Returns the maximum number of fallback options that can be added to the prompt. |
Public properties |
|
|---|---|
List<AuthenticationRequest.Biometric.Fallback> |
The |
AuthenticationRequest.BodyContent? |
The optional |
Boolean |
Whether user confirmation should be required for passive biometrics. |
Bitmap? |
|
String? |
|
Int |
|
AuthenticationRequest.Biometric.Strength |
The minimum biometric strength for the authentication. |
String? |
The optional subtitle of the prompt. |
String |
The title of the prompt. |
Public companion functions
getMaxFallbackOptions
fun getMaxFallbackOptions(): Int
Returns the maximum number of fallback options that can be added to the prompt.
| Returns | |
|---|---|
Int |
The maximum number of fallback options. |
Public properties
authFallbacks
val authFallbacks: List<AuthenticationRequest.Biometric.Fallback>
The Fallback options for the biometric authentication.
content
val content: AuthenticationRequest.BodyContent?
The optional BodyContent of the prompt.
isConfirmationRequired
val isConfirmationRequired: Boolean
Whether user confirmation should be required for passive biometrics.
minStrength
val minStrength: AuthenticationRequest.Biometric.Strength
The minimum biometric strength for the authentication. Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.