BiometricPrompt.PromptInfo
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 |
Public functions |
|
|---|---|
Int |
Gets the type(s) of authenticators that may be invoked by the prompt. |
PromptContentView? |
Gets the content view for the prompt, as set by |
CharSequence? |
Gets the description for the prompt. |
Bitmap? |
@RequiresPermission(value = "")Gets the logo bitmap for the prompt, as set by |
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 |
CharSequence |
Gets the text for the negative button on the prompt. |
CharSequence? |
Gets the subtitle for the prompt. |
CharSequence |
getTitle()Gets the title for the prompt. |
Boolean |
Checks if the confirmation required option is enabled for the prompt. |
Boolean |
This function is deprecated. Will be removed with |
Public functions
getAllowedAuthenticators
fun getAllowedAuthenticators(): Int
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
fun getContentView(): PromptContentView?
Gets the content view for the prompt, as set by setContentView.
| Returns | |
|---|---|
PromptContentView? |
The content view for the prompt, or null if the prompt has no content view. |
getDescription
fun getDescription(): CharSequence?
Gets the description for the prompt.
| Returns | |
|---|---|
CharSequence? |
The description to be displayed on the prompt. |
| See also | |
|---|---|
setDescription |
getLogoBitmap
@RequiresPermission(value = "")
fun getLogoBitmap(): Bitmap?
Gets the logo bitmap for the prompt, as set by setLogoBitmap. Currently for system applications use only.
| Returns | |
|---|---|
Bitmap? |
The logo bitmap of the prompt, or null if the prompt has no logo bitmap set. |
getLogoDescription
@RequiresPermission(value = "")
fun getLogoDescription(): String?
Gets the logo description for the prompt, as set by setLogoDescription. Currently for system applications use only.
| Returns | |
|---|---|
String? |
The logo description of the prompt, or null if the prompt has no logo description set. |
getLogoRes
@RequiresPermission(value = "")
fun getLogoRes(): @DrawableRes Int
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
fun getNegativeButtonText(): CharSequence
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 | |
|---|---|
setNegativeButtonText |
getSubtitle
fun getSubtitle(): CharSequence?
Gets the subtitle for the prompt.
| Returns | |
|---|---|
CharSequence? |
The subtitle to be displayed on the prompt. |
| See also | |
|---|---|
setSubtitle |
getTitle
fun getTitle(): CharSequence
Gets the title for the prompt.
| Returns | |
|---|---|
CharSequence |
The title to be displayed on the prompt. |
| See also | |
|---|---|
setTitle |
isConfirmationRequired
fun isConfirmationRequired(): Boolean
Checks if the confirmation required option is enabled for the prompt.
| Returns | |
|---|---|
Boolean |
Whether this option is enabled. |
| See also | |
|---|---|
setConfirmationRequired |
funisDeviceCredentialAllowed(): Boolean
Checks if the device credential allowed option is enabled for the prompt.
| Returns | |
|---|---|
Boolean |
Whether this option is enabled. |
| See also | |
|---|---|
setDeviceCredentialAllowed |