BiometricPrompt.PromptInfo
public class BiometricPrompt.PromptInfo
A set of configurable options for how the BiometricPrompt should appear and behave.
Summary
Nested types |
|---|
public class BiometricPrompt.PromptInfo.BuilderA builder used to set individual options for the |
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 |
@Nullable CharSequence |
Gets the description for the prompt. |
@Nullable Bitmap |
@RequiresPermission(value = "")Gets the logo bitmap for the prompt, as set by |
@Nullable String |
@RequiresPermission(value = "")Gets the logo description for the prompt, as set by |
@DrawableRes int |
@RequiresPermission(value = "")Gets the drawable resource of the logo for the prompt, as set by |
@NonNull CharSequence |
Gets the text for the negative button on the prompt. |
@Nullable CharSequence |
Gets the subtitle for the prompt. |
@NonNull CharSequence |
getTitle()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 |
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 | |
|---|---|
setAllowedAuthenticators |
getContentView
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
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
@RequiresPermission(value = "")
public @Nullable Bitmap getLogoBitmap()
Gets the logo bitmap for the prompt, as set by setLogoBitmap. Currently for system applications use only.
getLogoDescription
@RequiresPermission(value = "")
public @Nullable String getLogoDescription()
Gets the logo description for the prompt, as set by setLogoDescription. Currently for system applications use only.
getLogoRes
@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
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. |
| See also | |
|---|---|
setNegativeButtonText |
getSubtitle
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
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
public boolean isConfirmationRequired()
Checks if the confirmation required option is enabled for the prompt.
| Returns | |
|---|---|
boolean |
Whether this option is enabled. |
| See also | |
|---|---|
setConfirmationRequired |
public boolean isDeviceCredentialAllowed()
Checks if the device credential allowed option is enabled for the prompt.
| Returns | |
|---|---|
boolean |
Whether this option is enabled. |
| See also | |
|---|---|
setDeviceCredentialAllowed |