BiometricPrompt.PromptInfo.Builder

fun build(): BiometricPrompt.PromptInfo

Creates a PromptInfo object with the specified options.

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:

• BIOMETRIC_WEAK for non-crypto authentication, or
• BIOMETRIC_STRONG for crypto-based authentication.

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.

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).

fun setContentView(view: PromptContentView): BiometricPrompt.PromptInfo.Builder

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

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

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

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

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

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.

@RequiresPermission(value = "")
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.

@RequiresPermission(value = "")
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.

@RequiresPermission(value = "")
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.

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.

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

Optional: Sets the subtitle for the prompt.

fun setTitle(title: CharSequence): BiometricPrompt.PromptInfo.Builder

Required: Sets the title for the prompt.