Class2BiometricOrCredentialAuthPrompt.Builder
public
static
final
class
Class2BiometricOrCredentialAuthPrompt.Builder
extends Object
java.lang.Object | |
↳ | androidx.biometric.auth.Class2BiometricOrCredentialAuthPrompt.Builder |
Builder for a Class2BiometricOrCredentialAuthPrompt
with configurable options.
Summary
Public constructors | |
---|---|
Builder(CharSequence title)
Constructs a prompt builder with the given required options. |
Public methods | |
---|---|
Class2BiometricOrCredentialAuthPrompt
|
build()
Creates a new prompt with the specified options. |
Class2BiometricOrCredentialAuthPrompt.Builder
|
setConfirmationRequired(boolean confirmationRequired)
Sets a hint indicating whether the prompt should require explicit user confirmation after a passive biometric (e.g. |
Class2BiometricOrCredentialAuthPrompt.Builder
|
setDescription(CharSequence description)
Sets a description that should be displayed on the prompt. |
Class2BiometricOrCredentialAuthPrompt.Builder
|
setSubtitle(CharSequence subtitle)
Sets a subtitle that should be displayed on the prompt. |
Inherited methods | |
---|---|
Public constructors
Builder
public Builder (CharSequence title)
Constructs a prompt builder with the given required options.
Parameters | |
---|---|
title |
CharSequence : The title to be displayed on the prompt.
|
Public methods
build
public Class2BiometricOrCredentialAuthPrompt build ()
Creates a new prompt with the specified options.
Returns | |
---|---|
Class2BiometricOrCredentialAuthPrompt |
An instance of Class2BiometricOrCredentialAuthPrompt .
|
setConfirmationRequired
public Class2BiometricOrCredentialAuthPrompt.Builder setConfirmationRequired (boolean confirmationRequired)
Sets a hint indicating whether the prompt should require explicit user confirmation
after a passive biometric (e.g. iris or face) has been recognized but before
AuthPromptCallback.onAuthenticationSucceeded(androidx.fragment.app.FragmentActivity, BiometricPrompt.AuthenticationResult)
is
called. Defaults to true
.
Setting this option to false
is generally only appropriate for frequent,
low-value transactions, such as re-authenticating for a previously authorized app.
As a hint, the value of this option may be ignored by the system. For example, explicit confirmation may always be required if the user has toggled a system-wide setting to disallow pure passive authentication. This option will also be ignored on any device with an OS version prior to Android 10 (API 29).
Parameters | |
---|---|
confirmationRequired |
boolean : Whether the prompt should require explicit user confirmation
for passive biometrics. |
Returns | |
---|---|
Class2BiometricOrCredentialAuthPrompt.Builder |
This builder. |
setDescription
public Class2BiometricOrCredentialAuthPrompt.Builder setDescription (CharSequence description)
Sets a description that should be displayed on the prompt. Defaults to null
.
Parameters | |
---|---|
description |
CharSequence : A description for the prompt. |
Returns | |
---|---|
Class2BiometricOrCredentialAuthPrompt.Builder |
This builder. |
setSubtitle
public Class2BiometricOrCredentialAuthPrompt.Builder setSubtitle (CharSequence subtitle)
Sets a subtitle that should be displayed on the prompt. Defaults to null
.
Parameters | |
---|---|
subtitle |
CharSequence : A subtitle for the prompt. |
Returns | |
---|---|
Class2BiometricOrCredentialAuthPrompt.Builder |
This builder. |