Summary: Nested Classes | Methods | Inherited Methods

BiometricPrompt.PromptInfo

Kotlin |Java

public static class BiometricPrompt.PromptInfo
extends Object

java.lang.Object
↳	androidx.biometric.BiometricPrompt.PromptInfo

---

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

Summary

Nested classes
class	BiometricPrompt.PromptInfo.Builder A builder used to set individual options for the BiometricPrompt.PromptInfo class.

Public methods
int	getAllowedAuthenticators() Gets the type(s) of authenticators that may be invoked by the prompt.
CharSequence	getDescription() Gets the description for the prompt.
CharSequence	getNegativeButtonText() Gets the text for the negative button on the prompt.
CharSequence	getSubtitle() Gets the subtitle for the prompt.
CharSequence	getTitle() Gets the title for the prompt.
boolean	isConfirmationRequired() Checks if the confirmation required option is enabled for the prompt.
boolean	isDeviceCredentialAllowed() This method is deprecated. Will be removed with BiometricPrompt.PromptInfo.Builder.setDeviceCredentialAllowed(boolean).

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public methods

getAllowedAuthenticators

public int getAllowedAuthenticators ()

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

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

See also:

• BiometricPrompt.PromptInfo.Builder.setAllowedAuthenticators(int)

getDescription

public CharSequence getDescription ()

Gets the description for the prompt.

Returns
CharSequence	The description to be displayed on the prompt.

See also:

• BiometricPrompt.PromptInfo.Builder.setDescription(CharSequence)

getNegativeButtonText

public CharSequence getNegativeButtonText ()

Gets the text for the negative button on the prompt.

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

See also:

• BiometricPrompt.PromptInfo.Builder.setNegativeButtonText(CharSequence)

getSubtitle

public CharSequence getSubtitle ()

Gets the subtitle for the prompt.

Returns
CharSequence	The subtitle to be displayed on the prompt.

See also:

• BiometricPrompt.PromptInfo.Builder.setSubtitle(CharSequence)

getTitle

public CharSequence getTitle ()

Gets the title for the prompt.

Returns
CharSequence	The title to be displayed on the prompt.

See also:

• BiometricPrompt.PromptInfo.Builder.setTitle(CharSequence)

isConfirmationRequired

public boolean isConfirmationRequired ()

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

Returns
boolean	Whether this option is enabled.

See also:

• BiometricPrompt.PromptInfo.Builder.setConfirmationRequired(boolean)

isDeviceCredentialAllowed

public boolean isDeviceCredentialAllowed ()

This method is deprecated.
Will be removed with BiometricPrompt.PromptInfo.Builder.setDeviceCredentialAllowed(boolean).

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

Returns
boolean	Whether this option is enabled.

See also:

• BiometricPrompt.PromptInfo.Builder.setDeviceCredentialAllowed(boolean)