BiometricPrompt.PromptInfo.Builder

class BiometricPrompt.PromptInfo.Builder

A builder used to set individual options for the PromptInfo class.

Summary

Public constructors

Public functions
BiometricPrompt.PromptInfo

Creates a PromptInfo object with the specified options.
BiometricPrompt.PromptInfo.Builder
setAllowedAuthenticators(allowedAuthenticators: Int)

Optional: Specifies the type(s) of authenticators that may be invoked by BiometricPrompt to authenticate the user.
BiometricPrompt.PromptInfo.Builder
setConfirmationRequired(confirmationRequired: Boolean)

Optional: Sets a system hint for whether to require explicit user confirmation after a passive biometric (e.g. iris or face) has been recognized but before onAuthenticationSucceeded is called.
BiometricPrompt.PromptInfo.Builder

Optional: Sets application customized content view that will be shown on the prompt.
BiometricPrompt.PromptInfo.Builder

Optional: Sets a description that will be shown on the prompt.
BiometricPrompt.PromptInfo.Builder
setDeviceCredentialAllowed(deviceCredentialAllowed: Boolean)

This function is deprecated.

Use setAllowedAuthenticators instead.
BiometricPrompt.PromptInfo.Builder
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
setLogoBitmap(logoBitmap: Bitmap)

Optional: Sets the bitmap drawable of the logo that will be shown on the prompt.
BiometricPrompt.PromptInfo.Builder
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
setLogoDescription(logoDescription: String)

Optional: Sets logo description text that will be shown on the prompt.
BiometricPrompt.PromptInfo.Builder
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
setLogoRes(logoRes: @DrawableRes Int)

Optional: Sets the drawable resource of the logo that will be shown on the prompt.
BiometricPrompt.PromptInfo.Builder
setNegativeButtonText(negativeButtonText: CharSequence)

Required: Sets the text for the negative button on the prompt.
BiometricPrompt.PromptInfo.Builder

Optional: Sets the subtitle for the prompt.
BiometricPrompt.PromptInfo.Builder

Required: Sets the title for the prompt.

Public constructors

Builder

Added in 1.0.0
Builder()

Public functions

build

Added in 1.0.0
fun build(): BiometricPrompt.PromptInfo

Creates a PromptInfo object with the specified options.

Returns
BiometricPrompt.PromptInfo

The PromptInfo object.
Throws
java.lang.IllegalArgumentException

If any required option is not set, or if any illegal combination of options is present.

setAllowedAuthenticators

Added in 1.1.0
fun setAllowedAuthenticators(allowedAuthenticators: Int): BiometricPrompt.PromptInfo.Builder

Optional: Specifies the type(s) of authenticators that may be invoked by BiometricPrompt to authenticate the user. Available authenticator types are defined in Authenticators and can be combined via bitwise OR. Defaults to:

Note that not all combinations of authenticator types are supported prior to Android 11 (API 30). Specifically, DEVICE_CREDENTIAL alone is unsupported prior to API 30, and BIOMETRIC_STRONG | DEVICE_CREDENTIAL is unsupported on API 28-29. Setting an unsupported value on an affected Android version will result in an error when calling build.

This method should be preferred over setDeviceCredentialAllowed and overrides the latter if both are used. Using this method to enable device credential authentication (with DEVICE_CREDENTIAL) will replace the negative button on the prompt, making it an error to also call setNegativeButtonText.

If this method is used and no authenticator of any of the specified types is available at the time authenticate() is called, onAuthenticationError will be invoked with an appropriate error code.

Parameters
allowedAuthenticators: Int

A bit field representing all valid authenticator types that may be invoked by the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setConfirmationRequired

Added in 1.0.0
fun setConfirmationRequired(confirmationRequired: Boolean): BiometricPrompt.PromptInfo.Builder

Optional: Sets a system hint for whether to require explicit user confirmation after a passive biometric (e.g. iris or face) has been recognized but before onAuthenticationSucceeded is called. Defaults to true.

Disabling this option is generally only appropriate for frequent, low-value transactions, such as re-authenticating for a previously authorized application.

Also note that, as it is merely a hint, this option may be ignored by the system. For example, the system may choose to instead always require confirmation if the user has disabled passive authentication for their device in Settings. Additionally, this option will be ignored on devices running OS versions prior to Android 10 (API 29).

Parameters
confirmationRequired: Boolean

Whether this option should be enabled.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setContentView

Added in 1.4.0-alpha04
fun setContentView(view: PromptContentView): BiometricPrompt.PromptInfo.Builder

Optional: Sets application customized content view that will be shown on the prompt.

Note that from API 35, the description set by setDescription will be overridden by setContentView. The view provided to setContentView will be used if both methods are called.

Parameters
view: PromptContentView

The customized view information.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setDescription

Added in 1.0.0
fun setDescription(description: CharSequence?): BiometricPrompt.PromptInfo.Builder

Optional: Sets a description that will be shown on the prompt.

Note that from API 35, the description set by setDescription will be overridden by setContentView. The view provided to setContentView will be used if both methods are called.

Parameters
description: CharSequence?

The description to display.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setDeviceCredentialAllowed

Added in 1.0.0
Deprecated in 1.1.0
fun setDeviceCredentialAllowed(deviceCredentialAllowed: Boolean): BiometricPrompt.PromptInfo.Builder

Optional: Sets whether the user should be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. Defaults to false.

Note that this option is incompatible with setNegativeButtonText and must NOT be enabled if the latter is set.

Before enabling this option, developers should check whether the device is secure by calling isDeviceSecure. If the device is not secure, authentication will fail with ERROR_NO_DEVICE_CREDENTIAL.

On versions prior to Android 10 (API 29), calls to cancelAuthentication will not work as expected after the user has chosen to authenticate with their device credential. This is because the library internally launches a separate activity (by calling createConfirmDeviceCredentialIntent) that does not have a public API for cancellation.

Parameters
deviceCredentialAllowed: Boolean

Whether this option should be enabled.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setLogoBitmap

Added in 1.4.0-alpha04
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun setLogoBitmap(logoBitmap: Bitmap): BiometricPrompt.PromptInfo.Builder

Optional: Sets the bitmap drawable of the logo that will be shown on the prompt.

Note that using this method is not recommended in most scenarios because the calling application's icon will be used by default. Setting the logo is intended for large bundled applications that perform a wide range of functions and need to show distinct icons for each function.

Parameters
logoBitmap: Bitmap

A bitmap drawable of the logo that will be shown on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setLogoDescription

Added in 1.4.0-alpha04
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun setLogoDescription(logoDescription: String): BiometricPrompt.PromptInfo.Builder

Optional: Sets logo description text that will be shown on the prompt.

Note that using this method is not recommended in most scenarios because the calling application's name will be used by default. Setting the logo description is intended for large bundled applications that perform a wide range of functions and need to show distinct description for each function.

Parameters
logoDescription: String

The logo description text that will be shown on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.
Throws
java.lang.IllegalArgumentException

If logo description is null or exceeds certain character limit.

setLogoRes

Added in 1.4.0-alpha04
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
fun setLogoRes(logoRes: @DrawableRes Int): BiometricPrompt.PromptInfo.Builder

Optional: Sets the drawable resource of the logo that will be shown on the prompt.

Note that using this method is not recommended in most scenarios because the calling application's icon will be used by default. Setting the logo is intended for large bundled applications that perform a wide range of functions and need to show distinct icons for each function.

Parameters
logoRes: @DrawableRes Int

A drawable resource of the logo that will be shown on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setNegativeButtonText

Added in 1.0.0
fun setNegativeButtonText(negativeButtonText: CharSequence): BiometricPrompt.PromptInfo.Builder

Required: Sets the text for the negative button on the prompt.

Note that this option is incompatible with device credential authentication and must NOT be set if the latter is enabled via setAllowedAuthenticators or setDeviceCredentialAllowed.

Parameters
negativeButtonText: CharSequence

The label to be used for the negative button on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setSubtitle

Added in 1.0.0
fun setSubtitle(subtitle: CharSequence?): BiometricPrompt.PromptInfo.Builder

Optional: Sets the subtitle for the prompt.

Parameters
subtitle: CharSequence?

The subtitle to be displayed on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.

setTitle

Added in 1.0.0
fun setTitle(title: CharSequence): BiometricPrompt.PromptInfo.Builder

Required: Sets the title for the prompt.

Parameters
title: CharSequence

The title to be displayed on the prompt.
Returns
BiometricPrompt.PromptInfo.Builder

This builder.