# BiometricPrompt.PromptInfo

Artifact: [androidx.biometric:biometric](https://developer.android.com/jetpack/androidx/releases/biometric) [View Source](https://cs.android.com/search?q=file:androidx/biometric/BiometricPrompt.java+class:androidx.biometric.BiometricPrompt.PromptInfo) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

*** ** * ** ***


```
class BiometricPrompt.PromptInfo
```

<br />

*** ** * ** ***

A set of configurable options for how the `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt` should appear and behave.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder` A builder used to set individual options for the `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo` class. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getAllowedAuthenticators()()` Gets the type(s) of authenticators that may be invoked by the prompt. |
| `https://developer.android.com/reference/kotlin/androidx/biometric/PromptContentView?` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getContentView()()` Gets the content view for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setContentView(androidx.biometric.PromptContentView)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getDescription()()` Gets the description for the prompt. |
| `https://developer.android.com/reference/android/graphics/Bitmap.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getLogoBitmap()()` Gets the logo bitmap for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoBitmap(android.graphics.Bitmap)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getLogoDescription()()` Gets the logo description for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoDescription(java.lang.String)`. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getLogoRes()()` Gets the drawable resource of the logo for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoRes(int)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getNegativeButtonText()()` Gets the text for the negative button on the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getSubtitle()()` Gets the subtitle for the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#getTitle()()` Gets the title for the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#isConfirmationRequired()()` Checks if the confirmation required option is enabled for the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[isDeviceCredentialAllowed](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#isDeviceCredentialAllowed())()` **This function is deprecated.** Will be removed with `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setDeviceCredentialAllowed(boolean)`. <br /> |

## Public functions

### getAllowedAuthenticators

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

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

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

Value is either `0` or a combination of the following:

- `Authenticators.BIOMETRIC_STRONG`
- `Authenticators.BIOMETRIC_WEAK`
- `Authenticators.DEVICE_CREDENTIAL`
- `Authenticators.IDENTITY_CHECK`

<br />

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A bit field representing all valid authenticator types that may be invoked by the prompt, or 0 if not set. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setAllowedAuthenticators(int)` |   |

### getContentView

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

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

Gets the content view for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setContentView(androidx.biometric.PromptContentView)`.

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

### getDescription

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Gets the description for the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | The description to be displayed on the prompt. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setDescription(java.lang.CharSequence)` |   |

### getLogoBitmap

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun getLogoBitmap(): Bitmap?
```

Gets the logo bitmap for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoBitmap(android.graphics.Bitmap)`. Currently for system applications use only.

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

### getLogoDescription

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun getLogoDescription(): String?
```

Gets the logo description for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoDescription(java.lang.String)`. Currently for system applications use only.

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

### getLogoRes

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun getLogoRes(): @DrawableRes Int
```

Gets the drawable resource of the logo for the prompt, as set by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setLogoRes(int)`. Currently for system applications use only.

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The drawable resource of the logo, or -1 if the prompt has no logo resource set. |

### getNegativeButtonText

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Gets the text for the negative button on the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | The label to be used for the negative button on the prompt, or an empty string if not set. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setNegativeButtonText(java.lang.CharSequence)` |   |

### getSubtitle

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Gets the subtitle for the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | The subtitle to be displayed on the prompt. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setSubtitle(java.lang.CharSequence)` |   |

### getTitle

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Gets the title for the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | The title to be displayed on the prompt. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setTitle(java.lang.CharSequence)` |   |

### isConfirmationRequired

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Checks if the confirmation required option is enabled for the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether this option is enabled. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setConfirmationRequired(boolean)` |   |

### isDeviceCredentialAllowed

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
fun [isDeviceCredentialAllowed](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo#isDeviceCredentialAllowed())(): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
>
> Will be removed with `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setDeviceCredentialAllowed(boolean)`.

Checks if the device credential allowed option is enabled for the prompt.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether this option is enabled. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.PromptInfo.Builder#setDeviceCredentialAllowed(boolean)` |   |