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 CharSequence?

See Builder#setDescription(CharSequence).

open CharSequence

See Builder#setNegativeButtonText(CharSequence).

open CharSequence?

See Builder#setSubtitle(CharSequence).

open CharSequence

See Builder#setTitle(CharSequence).

open Boolean

See Builder#setConfirmationRequired(boolean).

open Boolean

See Builder#setDeviceCredentialAllowed(boolean).

Public methods

getDescription

@Nullable open fun getDescription(): CharSequence?

See Builder#setDescription(CharSequence).

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

getNegativeButtonText

@NonNull open fun getNegativeButtonText(): CharSequence

See Builder#setNegativeButtonText(CharSequence).

Return
CharSequence The label to be used for the negative button on the prompt.

getSubtitle

@Nullable open fun getSubtitle(): CharSequence?

See Builder#setSubtitle(CharSequence).

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

getTitle

@NonNull open fun getTitle(): CharSequence

See Builder#setTitle(CharSequence).

Return
CharSequence The title to be displayed on the prompt.

isConfirmationRequired

open fun isConfirmationRequired(): Boolean

See Builder#setConfirmationRequired(boolean).

Return
Boolean Whether this option is enabled.

isDeviceCredentialAllowed

open fun isDeviceCredentialAllowed(): Boolean

See Builder#setDeviceCredentialAllowed(boolean).

Return
Boolean Whether this option is enabled.