EmbeddedBiometricPrompt

START_MODE_DEFERRED

public static final int START_MODE_DEFERRED

The prompt should be collapsed and display in the deferred/paused state. A shorter bottom sheet with a down arrow button is shown in place of the full prompt, and biometric sensors are not activated. Apps can call resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

Constant Value: 2 (0x00000002)

START_MODE_IMMEDIATE

public static final int START_MODE_IMMEDIATE

Start authentication immediately with the full prompt displayed.

Constant Value: 0 (0x00000000)

START_MODE_IMMEDIATE_UNLESS_OCCLUDED

public static final int START_MODE_IMMEDIATE_UNLESS_OCCLUDED

Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. If authentication is started and the provided embedded content exceeds the maximum available space, the prompt displays in the deferred/paused state, where it shows a shorter bottom sheet with a down arrow button in place of the full prompt, and biometric sensors are not activated. Apps can listen for AuthenticationCallback.onAuthenticationPaused in this case, and respond by calling resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

Constant Value: 1 (0x00000001)

getAllowedAuthenticators

public int getAllowedAuthenticators ()

Gets the type(s) of authenticators that may be invoked by the prompt.

getAuthenticationCallback

public EmbeddedBiometricPrompt.AuthenticationCallback getAuthenticationCallback ()

Gets the authentication callback used for the prompt.

getAuthenticationExecutor

public Executor getAuthenticationExecutor ()

Gets the executor used for the authentication callback.

getAuthenticationPurpose

public int getAuthenticationPurpose ()

Gets the authentication purpose for the prompt.

getContentView

public PromptContentView getContentView ()

Gets the content view, as set by Builder.setContentView(PromptContentView). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

getDescription

public CharSequence getDescription ()

Gets the description, as set by Builder.setDescription(CharSequence). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

getEmbeddedContentFactory

public EmbeddedBiometricPrompt.EmbeddedContentFactory getEmbeddedContentFactory ()

Gets the factory that will create the content to display above the biometric prompt as a connected sheet.

getExistingAuthSessionId

public long getExistingAuthSessionId ()

Returns the existing auth session id for BiometricPrompt.

getFallbackOptions

public List<FallbackOption> getFallbackOptions ()

Gets the fallback options for the prompt.

getLogoBitmap

public Bitmap getLogoBitmap ()

Gets the logo bitmap, as set by Builder.setLogoBitmap(Bitmap). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).
Requires Manifest.permission.SET_BIOMETRIC_DIALOG_ADVANCED

getLogoDescription

public String getLogoDescription ()

Gets the logo description, as set by Builder.setLogoDescription(String). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).
Requires Manifest.permission.SET_BIOMETRIC_DIALOG_ADVANCED

getLogoRes

public int getLogoRes ()

Gets the drawable resource of the logo, as set by Builder.setLogoRes(int). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).
Requires Manifest.permission.SET_BIOMETRIC_DIALOG_ADVANCED

getNegativeButton

public DialogInterface.OnClickListener getNegativeButton ()

Gets the negative button listener, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener).

getNegativeButtonExecutor

public Executor getNegativeButtonExecutor ()

Gets the executor used for the negative button listener, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener).

getNegativeButtonText

public CharSequence getNegativeButtonText ()

Gets the negative button text, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener).

getNextTranslationOffset

public int getNextTranslationOffset ()

Gets the ending target layout translation offset in pixels (px) for the disappear (exit) animation.

In portrait mode, this target offset is applied vertically along the Y-axis.

In landscape mode, this target offset is applied horizontally along the X-axis.

getPreviousTranslationOffset

public int getPreviousTranslationOffset ()

Gets the starting layout translation offset in pixels (px) for the appear (entry) animation.

In portrait mode, this offset is applied vertically along the Y-axis.

getStyleSpec

public BiometricPromptStyleSpec getStyleSpec ()

Returns a BiometricPromptStyleSpec containing the style specifications of BiometricPrompt

getSubtitle

public CharSequence getSubtitle ()

Gets the subtitle, as set by Builder.setSubtitle(CharSequence). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

getTitle

public CharSequence getTitle ()

Gets the title, as set by Builder.setTitle(CharSequence). This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

isConfirmationRequired

public boolean isConfirmationRequired ()

Determines if explicit user confirmation is required by the prompt.

pauseAuthentication

public void pauseAuthentication ()

Pauses biometric authentication and collapses the biometric prompt to the delayed state, displaying a button in its place.

resumeAuthentication

public void resumeAuthentication ()

Activates biometric authentication and starts the biometric sensor scanning if delayed authentication was configured. If authentication was started with START_MODE_IMMEDIATE_UNLESS_OCCLUDED and the embedded content exceeds the allowed dimensions, or authentication was started with START_MODE_DEFERRED, the prompt is initially hidden and in a paused state, instead displaying a downward arrow button. Calling this method transitions the layout to show the sensor and biometric prompt content, and activates the biometric sensor to actively start authenticating.

setNextTranslationOffset

public void setNextTranslationOffset (int offset)

Sets the ending target layout translation offset in pixels (px) for the disappear (exit) animation.

When the prompt is dismissed, it animates from its resting position to this target layout offset.

In portrait mode, the target offset is applied vertically along the Y-axis.

In landscape mode, the target offset is applied horizontally along the X-axis.

startAuthenticationSession

public void startAuthenticationSession (CancellationSignal cancel, 
                int startMode, 
                Executor executor, 
                EmbeddedBiometricPrompt.AuthenticationCallback callback)

Starts an authentication session for embedded BiometricPrompt. This call warms up the biometric hardware, displays a system-provided dialog, and starts scanning for a biometric. Authentication starts when AuthenticationCallback.onSessionStarted(long) is called, terminates when AuthenticationCallback.onAuthenticationError(int,CharSequence) is called, when AuthenticationCallback.onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult) is called, or when the user dismisses the system-provided dialog. This operation can be canceled by using the provided cancel object. The application will receive authentication errors through AuthenticationCallback, and button events through the corresponding callback set in Builder.addFallbackOption(CharSequence,int,Executor,DialogInterface.OnClickListener).