Google is committed to advancing racial equity for Black communities. See how.

PromptInfo

open class PromptInfo
kotlin.Any
   ↳ androidx.biometric.BiometricPrompt.PromptInfo

A set of configurable options for how the BiometricPrompt should appear and behave.

Summary

Nested classes
open

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

Public methods
open Int

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

open CharSequence?

Gets the description for the prompt.

open CharSequence

Gets the text for the negative button on the prompt.

open CharSequence?

Gets the subtitle for the prompt.

open CharSequence

Gets the title for the prompt.

open Boolean

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

open Boolean

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

Public methods

getAllowedAuthenticators

open fun getAllowedAuthenticators(): Int

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

Return
Int A bit field representing all valid authenticator types that may be invoked by the prompt, or 0 if not set.

getDescription

@Nullable open fun getDescription(): CharSequence?

Gets the description for the prompt.

Return
CharSequence? The description to be displayed on the prompt.

getNegativeButtonText

@NonNull open fun getNegativeButtonText(): CharSequence

Gets the text for the negative button on the prompt.

Return
CharSequence The label to be used for the negative button on the prompt, or an empty string if not set.

getSubtitle

@Nullable open fun getSubtitle(): CharSequence?

Gets the subtitle for the prompt.

Return
CharSequence? The subtitle to be displayed on the prompt.

getTitle

@NonNull open fun getTitle(): CharSequence

Gets the title for the prompt.

Return
CharSequence The title to be displayed on the prompt.

isConfirmationRequired

open fun isConfirmationRequired(): Boolean

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

Return
Boolean Whether this option is enabled.

isDeviceCredentialAllowed

open fun isDeviceCredentialAllowed(): Boolean

Deprecated: Will be removed with Builder#setDeviceCredentialAllowed(boolean).

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

Return
Boolean Whether this option is enabled.