Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions) Summary: [Nested Classes](https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#nestedclasses) \| [Constants](https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#constants) \| [Methods](https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#inhmethods)
# EmbeddedBiometricPrompt
*** ** * ** ***
`
public
final
class
EmbeddedBiometricPrompt
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.biometrics.EmbeddedBiometricPrompt |
*** ** * ** ***
The embedded version of `https://developer.android.com/reference/android/hardware/biometrics/BiometricPrompt` that allows client apps to pass in content to
display above the biometric prompt as a connected sheet.
## Summary
| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback` Callback structure provided to `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#startAuthenticationSession(android.os.CancellationSignal,%20int,%20java.util.concurrent.Executor,%20android.hardware.biometrics.EmbeddedBiometricPrompt.AuthenticationCallback)`. |
| ` class` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder` A builder for the embedded version of BiometricPrompt that collects arguments to be shown on the system-provided biometric dialog. |
| ` interface` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory` A factory that produces the custom embedded content view for the biometric prompt. |
| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED` The prompt should be collapsed and display in the deferred/paused state. |
| `int` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE` Start authentication immediately with the full prompt displayed. |
| `int` | `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED` Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. |
| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getAllowedAuthenticators()() ` Gets the type(s) of authenticators that may be invoked by the prompt. |
| ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationCallback()() ` Gets the authentication callback used for the prompt. |
| ` https://developer.android.com/reference/java/util/concurrent/Executor` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationExecutor()() ` Gets the executor used for the authentication callback. |
| ` int` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationPurpose()() ` Gets the authentication purpose for the prompt. |
| ` https://developer.android.com/reference/android/hardware/biometrics/PromptContentView` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getContentView()() ` Gets the content view, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setContentView(android.hardware.biometrics.PromptContentView)`. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getDescription()() ` Gets the description, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setDescription(java.lang.CharSequence)`. |
| ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getEmbeddedContentFactory()() ` Gets the factory that will create the content to display above the biometric prompt as a connected sheet. |
| ` long` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getExistingAuthSessionId()() ` Returns the existing auth session id for BiometricPrompt. |
| ` https://developer.android.com/reference/java/util/List` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getFallbackOptions()() ` Gets the fallback options for the prompt. |
| ` https://developer.android.com/reference/android/graphics/Bitmap` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoBitmap()() ` Gets the logo bitmap, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoBitmap(android.graphics.Bitmap)`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoDescription()() ` Gets the logo description, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoDescription(java.lang.String)`. |
| ` int` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoRes()() ` Gets the drawable resource of the logo, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoRes(int)`. |
| ` https://developer.android.com/reference/android/content/DialogInterface.OnClickListener` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButton()() ` Gets the negative button listener, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| ` https://developer.android.com/reference/java/util/concurrent/Executor` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButtonExecutor()() ` Gets the executor used for the negative button listener, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButtonText()() ` Gets the negative button text, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| ` int` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getNextTranslationOffset()() ` Gets the ending target layout translation offset in pixels (px) for the disappear (exit) animation. |
| ` int` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getPreviousTranslationOffset()() ` Gets the starting layout translation offset in pixels (px) for the appear (entry) animation. |
| ` https://developer.android.com/reference/android/hardware/biometrics/BiometricPromptStyleSpec` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getStyleSpec()() ` Returns a `https://developer.android.com/reference/android/hardware/biometrics/BiometricPromptStyleSpec` containing the style specifications of BiometricPrompt |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getSubtitle()() ` Gets the subtitle, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setSubtitle(java.lang.CharSequence)`. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#getTitle()() ` Gets the title, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setTitle(java.lang.CharSequence)`. |
| ` boolean` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#isConfirmationRequired()() ` Determines if explicit user confirmation is required by the prompt. |
| ` void` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#pauseAuthentication()() ` Pauses biometric authentication and collapses the biometric prompt to the delayed state, displaying a button in its place. |
| ` void` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#resumeAuthentication()() ` Activates biometric authentication and starts the biometric sensor scanning if delayed authentication was configured. |
| ` void` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#setNextTranslationOffset(int)(int offset) ` Sets the ending target layout translation offset in pixels (px) for the disappear (exit) animation. |
| ` void` | ` https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#startAuthenticationSession(android.os.CancellationSignal,%20int,%20java.util.concurrent.Executor,%20android.hardware.biometrics.EmbeddedBiometricPrompt.AuthenticationCallback)(https://developer.android.com/reference/android/os/CancellationSignal cancel, int startMode, https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback callback) ` Starts an authentication session for embedded BiometricPrompt. |
### Inherited methods
From class `
https://developer.android.com/reference/java/lang/Object
` `
https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`
Creates and returns a copy of this object.
`
boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`
Indicates whether some other object is "equal to" this one.
`
void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
`
final
https://developer.android.com/reference/java/lang/Class` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`
Returns the runtime class of this `Object`.
`
int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`
Returns a hash code value for the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`
Wakes up a single thread that is waiting on this object's
monitor.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`
Wakes up all threads that are waiting on this object's monitor.
`
https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`
Returns a string representation of the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait()()
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.
## Constants
### START_MODE_DEFERRED
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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 `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#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
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public static final int START_MODE_IMMEDIATE
```
Start authentication immediately with the full prompt displayed.
Constant Value:
0
(0x00000000)
### START_MODE_IMMEDIATE_UNLESS_OCCLUDED
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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 `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onAuthenticationPaused()` in this case,
and respond by calling `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#resumeAuthentication()` when ready to expand the
bottom sheet to the full prompt and activate biometric sensors to begin authenticating.
Constant Value:
1
(0x00000001)
## Public methods
### getAllowedAuthenticators
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public int getAllowedAuthenticators ()
```
Gets the type(s) of authenticators that may be invoked by the prompt.
| Returns ||
|---|---|
| `int` | A bit field representing the type(s) of authenticators that may be invoked by the prompt.
|
### getAuthenticationCallback
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public EmbeddedBiometricPrompt.AuthenticationCallback getAuthenticationCallback ()
```
Gets the authentication callback used for the prompt.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback` | The authentication callback used for the prompt, or null if not set.
|
### getAuthenticationExecutor
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public Executor getAuthenticationExecutor ()
```
Gets the executor used for the authentication callback.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/concurrent/Executor` | The executor used for the authentication callback, or null if not set.
|
### getAuthenticationPurpose
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public int getAuthenticationPurpose ()
```
Gets the authentication purpose for the prompt.
| Returns ||
|---|---|
| `int` | The authentication purpose. Value is one of the following: - `https://developer.android.com/reference/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_UNKNOWN` - `https://developer.android.com/reference/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_PAYMENT` - `https://developer.android.com/reference/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_LOGIN` |
### getContentView
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public PromptContentView getContentView ()
```
Gets the content view, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setContentView(android.hardware.biometrics.PromptContentView)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/hardware/biometrics/PromptContentView` | The content view for the prompt, or null if the prompt has no content view.
|
### getDescription
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public CharSequence getDescription ()
```
Gets the description, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setDescription(java.lang.CharSequence)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | The description for the prompt, or null if the prompt has no description.
|
### getEmbeddedContentFactory
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public EmbeddedBiometricPrompt.EmbeddedContentFactory getEmbeddedContentFactory ()
```
Gets the factory that will create the content to display above the biometric prompt as a
connected sheet.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory` | The factory used to create the content view. This value cannot be `null`.
|
### getExistingAuthSessionId
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public long getExistingAuthSessionId ()
```
Returns the existing auth session id for BiometricPrompt.
| Returns ||
|---|---|
| `long` | The existing auth session id, or `https://developer.android.com/` if none has been set.
|
### getFallbackOptions
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public List getFallbackOptions ()
```
Gets the fallback options for the prompt.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List` | The fallback options for the prompt. This value cannot be `null`.
|
### getLogoBitmap
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public Bitmap getLogoBitmap ()
```
Gets the logo bitmap, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoBitmap(android.graphics.Bitmap)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
Requires `https://developer.android.com/reference/android/Manifest.permission#SET_BIOMETRIC_DIALOG_ADVANCED`
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Bitmap` | The logo bitmap of the prompt, or null if the prompt has no logo bitmap set.
|
### getLogoDescription
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public String getLogoDescription ()
```
Gets the logo description, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoDescription(java.lang.String)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
Requires `https://developer.android.com/reference/android/Manifest.permission#SET_BIOMETRIC_DIALOG_ADVANCED`
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The logo description of the prompt, or null if the prompt has no logo description set.
|
### getLogoRes
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public int getLogoRes ()
```
Gets the drawable resource of the logo, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoRes(int)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
Requires `https://developer.android.com/reference/android/Manifest.permission#SET_BIOMETRIC_DIALOG_ADVANCED`
| Returns ||
|---|---|
| `int` | The drawable resource of the logo, or 0 if the prompt has no logo resource set.
|
### getNegativeButton
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public DialogInterface.OnClickListener getNegativeButton ()
```
Gets the negative button listener, as set by
`https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/DialogInterface.OnClickListener` | The negative button listener, or null if not set.
|
### getNegativeButtonExecutor
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public Executor getNegativeButtonExecutor ()
```
Gets the executor used for the negative button listener, as set by
`https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/concurrent/Executor` | The executor used for the negative button listener, or null if not set.
|
### getNegativeButtonText
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public CharSequence getNegativeButtonText ()
```
Gets the negative button text, as set by
`https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(java.lang.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | The negative button text, or null if not set.
|
### getNextTranslationOffset
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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.
| Returns ||
|---|---|
| `int` | The ending target translation offset in pixels (px).
|
### getPreviousTranslationOffset
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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.
| Returns ||
|---|---|
| `int` | The starting translation offset in pixels (px), or -1 if the system default is used.
|
### getStyleSpec
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public BiometricPromptStyleSpec getStyleSpec ()
```
Returns a `https://developer.android.com/reference/android/hardware/biometrics/BiometricPromptStyleSpec` containing the style specifications of
BiometricPrompt
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/hardware/biometrics/BiometricPromptStyleSpec` | the style specifications of BiometricPrompt. This value may be `null`.
|
### getSubtitle
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public CharSequence getSubtitle ()
```
Gets the subtitle, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setSubtitle(java.lang.CharSequence)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | The subtitle for the prompt, or null if the prompt has no subtitle.
|
### getTitle
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public CharSequence getTitle ()
```
Gets the title, as set by `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setTitle(java.lang.CharSequence)`.
This is only applicable to the device credential fallback page (when the user is
authenticating with PIN/pattern/password).
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | The title of the prompt, or null if not set.
|
### isConfirmationRequired
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public boolean isConfirmationRequired ()
```
Determines if explicit user confirmation is required by the prompt.
| Returns ||
|---|---|
| `boolean` | true if explicit user confirmation is required, or false otherwise.
|
### pauseAuthentication
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public void pauseAuthentication ()
```
Pauses biometric authentication and collapses the biometric prompt to the delayed state,
displaying a button in its place.
### resumeAuthentication
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
public void resumeAuthentication ()
```
Activates biometric authentication and starts the biometric sensor scanning if delayed
authentication was configured.
If authentication was started with `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED` and the
embedded content exceeds the allowed dimensions, or authentication was started with
`https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#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
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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.
| Parameters ||
|---|---|
| `offset` | `int`: The target translation offset in pixels (px).
|
### startAuthenticationSession
Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)
```
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
`https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onSessionStarted(long)` is called, terminates when `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onAuthenticationError(int,%20java.lang.CharSequence)` is called,
when `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onAuthenticationSucceeded(android.hardware.biometrics.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 `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback`, and button events through the corresponding
callback set in `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#addFallbackOption(java.lang.CharSequence,%20int,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.
| Parameters ||
|---|---|
| `cancel` | `CancellationSignal`: An object that can be used to cancel authentication. This value cannot be `null`.
|
| `startMode` | `int`: The mode determining when authentication starts (e.g. `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE`, `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED`, or `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED`). Value is one of the following: - `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE` - `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED` - `https://developer.android.com/reference/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED` |
| `executor` | `Executor`: An executor to handle callback events. This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread.
|
| `callback` | `EmbeddedBiometricPrompt.AuthenticationCallback`: An object to receive authentication events. This value cannot be `null`.
|