BiometricPrompt.PromptInfo


public class BiometricPrompt.PromptInfo


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

Summary

Nested types

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

Public methods

int

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

@Nullable PromptContentView

Gets the content view for the prompt, as set by setContentView.

@Nullable CharSequence

Gets the description for the prompt.

@Nullable Bitmap

Gets the logo bitmap for the prompt, as set by setLogoBitmap.

@Nullable String

Gets the logo description for the prompt, as set by setLogoDescription.

@DrawableRes int

Gets the drawable resource of the logo for the prompt, as set by setLogoRes.

@NonNull CharSequence

Gets the text for the negative button on the prompt.

@Nullable CharSequence

Gets the subtitle for the prompt.

@NonNull CharSequence

Gets the title for the prompt.

boolean

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

boolean

This method is deprecated.

Will be removed with setDeviceCredentialAllowed.

Public methods

getAllowedAuthenticators

Added in 1.1.0
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.

getContentView

Added in 1.4.0-alpha02
public @Nullable PromptContentView getContentView()

Gets the content view for the prompt, as set by setContentView.

Returns
@Nullable PromptContentView

The content view for the prompt, or null if the prompt has no content view.

getDescription

Added in 1.0.0
public @Nullable CharSequence getDescription()

Gets the description for the prompt.

Returns
@Nullable CharSequence

The description to be displayed on the prompt.

See also
setDescription

getLogoBitmap

Added in 1.4.0-alpha02
@RequiresPermission(value = "")
public @Nullable Bitmap getLogoBitmap()

Gets the logo bitmap for the prompt, as set by setLogoBitmap. Currently for system applications use only.

Returns
@Nullable Bitmap

The logo bitmap of the prompt, or null if the prompt has no logo bitmap set.

getLogoDescription

Added in 1.4.0-alpha02
@RequiresPermission(value = "")
public @Nullable String getLogoDescription()

Gets the logo description for the prompt, as set by setLogoDescription. Currently for system applications use only.

Returns
@Nullable String

The logo description of the prompt, or null if the prompt has no logo description set.

getLogoRes

Added in 1.4.0-alpha02
@RequiresPermission(value = "")
public @DrawableRes int getLogoRes()

Gets the drawable resource of the logo for the prompt, as set by setLogoRes. Currently for system applications use only.

Returns
@DrawableRes int

The drawable resource of the logo, or -1 if the prompt has no logo resource set.

getNegativeButtonText

Added in 1.0.0
public @NonNull CharSequence getNegativeButtonText()

Gets the text for the negative button on the prompt.

Returns
@NonNull CharSequence

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

getSubtitle

Added in 1.0.0
public @Nullable CharSequence getSubtitle()

Gets the subtitle for the prompt.

Returns
@Nullable CharSequence

The subtitle to be displayed on the prompt.

See also
setSubtitle

getTitle

Added in 1.0.0
public @NonNull CharSequence getTitle()

Gets the title for the prompt.

Returns
@NonNull CharSequence

The title to be displayed on the prompt.

See also
setTitle

isConfirmationRequired

Added in 1.0.0
public boolean isConfirmationRequired()

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

Returns
boolean

Whether this option is enabled.

isDeviceCredentialAllowed

Added in 1.0.0
Deprecated in 1.1.0
public boolean isDeviceCredentialAllowed()

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

Returns
boolean

Whether this option is enabled.