Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# EmbeddedBiometricPrompt

*** ** * ** ***

```
class EmbeddedBiometricPrompt
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.hardware.biometrics.EmbeddedBiometricPrompt](https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#) |

The embedded version of `https://developer.android.com/reference/kotlin/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 ||
|---|---|
| abstract | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback` Callback structure provided to `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#startAuthenticationSession(android.os.CancellationSignal,%20kotlin.Int,%20java.util.concurrent.Executor,%20android.hardware.biometrics.EmbeddedBiometricPrompt.AuthenticationCallback)`. |
|   | `https://developer.android.com/reference/kotlin/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. |
| abstract | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory` A factory that produces the custom embedded content view for the biometric prompt. |

| Constants ||
|---|---|
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED:kotlin.Int` The prompt should be collapsed and display in the deferred/paused state. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE:kotlin.Int` Start authentication immediately with the full prompt displayed. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED:kotlin.Int` Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. |

| Public methods ||
|---|---|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getAllowedAuthenticators()()` Gets the type(s) of authenticators that may be invoked by the prompt. |
| [EmbeddedBiometricPrompt.AuthenticationCallback](https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationCallback()()` Gets the authentication callback used for the prompt. |
| [Executor](https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationExecutor()()` Gets the executor used for the authentication callback. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getAuthenticationPurpose()()` Gets the authentication purpose for the prompt. |
| [PromptContentView](https://developer.android.com/reference/kotlin/android/hardware/biometrics/PromptContentView)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getContentView()()` Gets the content view, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setContentView(android.hardware.biometrics.PromptContentView)`. |
| [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getDescription()()` Gets the description, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setDescription(kotlin.CharSequence)`. |
| [EmbeddedBiometricPrompt.EmbeddedContentFactory](https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory) | `https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getExistingAuthSessionId()()` Returns the existing auth session id for BiometricPrompt. |
| [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\<[FallbackOption](https://developer.android.com/reference/kotlin/android/hardware/biometrics/FallbackOption)!\> | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getFallbackOptions()()` Gets the fallback options for the prompt. |
| [Bitmap](https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html#)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoBitmap()()` Gets the logo bitmap, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoBitmap(android.graphics.Bitmap)`. |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoDescription()()` Gets the logo description, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoDescription(kotlin.String)`. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getLogoRes()()` Gets the drawable resource of the logo, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoRes(kotlin.Int)`. |
| [DialogInterface.OnClickListener](https://developer.android.com/reference/kotlin/android/content/DialogInterface.OnClickListener.html#)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButton()()` Gets the negative button listener, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| [Executor](https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButtonExecutor()()` Gets the executor used for the negative button listener, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getNegativeButtonText()()` Gets the negative button text, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getNextTranslationOffset()()` Gets the ending target layout translation offset in pixels (px) for the disappear (exit) animation. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getPreviousTranslationOffset()()` Gets the starting layout translation offset in pixels (px) for the appear (entry) animation. |
| [BiometricPromptStyleSpec](https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricPromptStyleSpec)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getStyleSpec()()` Returns a `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricPromptStyleSpec` containing the style specifications of BiometricPrompt |
| [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getSubtitle()()` Gets the subtitle, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setSubtitle(kotlin.CharSequence)`. |
| [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)? | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#getTitle()()` Gets the title, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setTitle(kotlin.CharSequence)`. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#isConfirmationRequired()()` Determines if explicit user confirmation is required by the prompt. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#pauseAuthentication()()` Pauses biometric authentication and collapses the biometric prompt to the delayed state, displaying a button in its place. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#resumeAuthentication()()` Activates biometric authentication and starts the biometric sensor scanning if delayed authentication was configured. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#setNextTranslationOffset(kotlin.Int)(offset: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Sets the ending target layout translation offset in pixels (px) for the disappear (exit) animation. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#startAuthenticationSession(android.os.CancellationSignal,%20kotlin.Int,%20java.util.concurrent.Executor,%20android.hardware.biometrics.EmbeddedBiometricPrompt.AuthenticationCallback)(cancel: https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html#, startMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html, executor: https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#, callback: https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback)` Starts an authentication session for embedded BiometricPrompt. |

## Constants

### START_MODE_DEFERRED

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
static val START_MODE_DEFERRED: Int
```

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/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#resumeAuthentication()` when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

    Value: 2

### START_MODE_IMMEDIATE

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
static val START_MODE_IMMEDIATE: Int
```

Start authentication immediately with the full prompt displayed.

    Value: 0

### START_MODE_IMMEDIATE_UNLESS_OCCLUDED

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
static val START_MODE_IMMEDIATE_UNLESS_OCCLUDED: Int
```

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/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onAuthenticationPaused()` in this case, and respond by calling `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#resumeAuthentication()` when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

    Value: 1

## Public methods

### getAllowedAuthenticators

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getAllowedAuthenticators(): Int
```

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | A bit field representing the type(s) of authenticators that may be invoked by the prompt. |

### getAuthenticationCallback

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getAuthenticationCallback(): EmbeddedBiometricPrompt.AuthenticationCallback?
```

Gets the authentication callback used for the prompt.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback?` | The authentication callback used for the prompt, or null if not set. |

### getAuthenticationExecutor

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getAuthenticationExecutor(): Executor?
```

Gets the executor used for the authentication callback.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#?` | The executor used for the authentication callback, or null if not set. |

### getAuthenticationPurpose

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getAuthenticationPurpose(): Int
```

Gets the authentication purpose for the prompt.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The authentication purpose. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_UNKNOWN:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_PAYMENT:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricManager#AUTHENTICATION_PURPOSE_LOGIN:kotlin.Int` |

### getContentView

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getContentView(): PromptContentView?
```

Gets the content view, as set by `https://developer.android.com/reference/kotlin/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).

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/biometrics/PromptContentView?` | The content view for the prompt, or null if the prompt has no content view. |

### getDescription

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getDescription(): CharSequence?
```

Gets the description, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setDescription(kotlin.CharSequence)`. This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html?` | The description for the prompt, or null if the prompt has no description. |

### getEmbeddedContentFactory

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getEmbeddedContentFactory(): EmbeddedBiometricPrompt.EmbeddedContentFactory
```

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

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.EmbeddedContentFactory` | The factory used to create the content view. This value cannot be `null`. |

### getExistingAuthSessionId

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getExistingAuthSessionId(): Long
```

Returns the existing auth session id for BiometricPrompt.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | The existing auth session id, or `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#` if none has been set. |

### getFallbackOptions

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getFallbackOptions(): MutableList<FallbackOption!>
```

Gets the fallback options for the prompt.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html<https://developer.android.com/reference/kotlin/android/hardware/biometrics/FallbackOption!>` | The fallback options for the prompt. This value cannot be `null`. |

### getLogoBitmap

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getLogoBitmap(): Bitmap?
```

Gets the logo bitmap, as set by `https://developer.android.com/reference/kotlin/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/kotlin/android/Manifest.permission.html#SET_BIOMETRIC_DIALOG_ADVANCED:kotlin.String`

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html#?` | The logo bitmap of the prompt, or null if the prompt has no logo bitmap set. |

### getLogoDescription

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getLogoDescription(): String?
```

Gets the logo description, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoDescription(kotlin.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/kotlin/android/Manifest.permission.html#SET_BIOMETRIC_DIALOG_ADVANCED:kotlin.String`

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | The logo description of the prompt, or null if the prompt has no logo description set. |

### getLogoRes

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getLogoRes(): Int
```

Gets the drawable resource of the logo, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setLogoRes(kotlin.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/kotlin/android/Manifest.permission.html#SET_BIOMETRIC_DIALOG_ADVANCED:kotlin.String`

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The drawable resource of the logo, or 0 if the prompt has no logo resource set. |

### getNegativeButton

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getNegativeButton(): DialogInterface.OnClickListener?
```

Gets the negative button listener, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/DialogInterface.OnClickListener.html#?` | The negative button listener, or null if not set. |

### getNegativeButtonExecutor

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getNegativeButtonExecutor(): Executor?
```

Gets the executor used for the negative button listener, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#?` | The executor used for the negative button listener, or null if not set. |

### getNegativeButtonText

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getNegativeButtonText(): CharSequence?
```

Gets the negative button text, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setNegativeButton(kotlin.CharSequence,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html?` | The negative button text, or null if not set. |

### getNextTranslationOffset

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getNextTranslationOffset(): Int
```

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.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The ending target translation offset in pixels (px). |

### getPreviousTranslationOffset

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getPreviousTranslationOffset(): Int
```

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.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The starting translation offset in pixels (px), or -1 if the system default is used. |

### getStyleSpec

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getStyleSpec(): BiometricPromptStyleSpec?
```

Returns a `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricPromptStyleSpec` containing the style specifications of BiometricPrompt

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/biometrics/BiometricPromptStyleSpec?` | the style specifications of BiometricPrompt. This value may be `null`. |

### getSubtitle

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getSubtitle(): CharSequence?
```

Gets the subtitle, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setSubtitle(kotlin.CharSequence)`. This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html?` | The subtitle for the prompt, or null if the prompt has no subtitle. |

### getTitle

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun getTitle(): CharSequence?
```

Gets the title, as set by `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#setTitle(kotlin.CharSequence)`. This is only applicable to the device credential fallback page (when the user is authenticating with PIN/pattern/password).

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html?` | The title of the prompt, or null if not set. |

### isConfirmationRequired

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun isConfirmationRequired(): Boolean
```

Determines if explicit user confirmation is required by the prompt.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | true if explicit user confirmation is required, or false otherwise. |

### pauseAuthentication

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun pauseAuthentication(): Unit
```

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

### resumeAuthentication

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun resumeAuthentication(): Unit
```

Activates biometric authentication and starts the biometric sensor scanning if delayed authentication was configured. If authentication was started with `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED:kotlin.Int` and the embedded content exceeds the allowed dimensions, or authentication was started with `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED:kotlin.Int`, 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 [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun setNextTranslationOffset(offset: Int): Unit
```

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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The target translation offset in pixels (px). |

### startAuthenticationSession

Added in [API level 37.2](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
fun startAuthenticationSession(
    cancel: CancellationSignal, 
    startMode: Int, 
    executor: Executor, 
    callback: EmbeddedBiometricPrompt.AuthenticationCallback
): Unit
```

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/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onSessionStarted(kotlin.Long)` is called, terminates when `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback#onAuthenticationError(kotlin.Int,%20kotlin.CharSequence)` is called, when `https://developer.android.com/reference/kotlin/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/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback`, and button events through the corresponding callback set in `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.Builder#addFallbackOption(kotlin.CharSequence,%20kotlin.Int,%20java.util.concurrent.Executor,%20android.content.DialogInterface.OnClickListener)`.

| Parameters ||
|---|---|
| `cancel` | [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html#): An object that can be used to cancel authentication. This value cannot be `null`. |
| `startMode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The mode determining when authentication starts (e.g. `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE:kotlin.Int`, `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED:kotlin.Int`, or `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED:kotlin.Int`). Value is one of the following: - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_IMMEDIATE_UNLESS_OCCLUDED:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt#START_MODE_DEFERRED:kotlin.Int` |
| `executor` | [Executor](https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#): An executor to handle callback events. This value cannot be `null`. Callback and listener events are dispatched through this `https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#`, 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/kotlin/android/content/Context.html#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html#` that dispatches to an appropriate thread. |
| `callback` | [EmbeddedBiometricPrompt.AuthenticationCallback](https://developer.android.com/reference/kotlin/android/hardware/biometrics/EmbeddedBiometricPrompt.AuthenticationCallback): An object to receive authentication events. This value cannot be `null`. |