public class

BiometricPrompt.PromptInfo

extends java.lang.Object

 java.lang.Object

↳androidx.biometric.BiometricPrompt.PromptInfo

Overview

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

Summary

Methods
public intgetAllowedAuthenticators()

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

public PromptContentViewgetContentView()

Gets the content view for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setContentView(PromptContentView).

public java.lang.CharSequencegetDescription()

Gets the description for the prompt.

public BitmapgetLogoBitmap()

Gets the logo bitmap for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoBitmap(Bitmap).

public java.lang.StringgetLogoDescription()

Gets the logo description for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoDescription(String).

public intgetLogoRes()

Gets the drawable resource of the logo for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoRes(int).

public java.lang.CharSequencegetNegativeButtonText()

Gets the text for the negative button on the prompt.

public java.lang.CharSequencegetSubtitle()

Gets the subtitle for the prompt.

public java.lang.CharSequencegetTitle()

Gets the title for the prompt.

public booleanisConfirmationRequired()

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

public booleanisDeviceCredentialAllowed()

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

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public int getLogoRes()

Gets the drawable resource of the logo for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoRes(int). Currently for system applications use only.

Returns:

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

public Bitmap getLogoBitmap()

Gets the logo bitmap for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoBitmap(Bitmap). Currently for system applications use only.

Returns:

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

public java.lang.String getLogoDescription()

Gets the logo description for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setLogoDescription(String). Currently for system applications use only.

Returns:

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

public java.lang.CharSequence getTitle()

Gets the title for the prompt.

Returns:

The title to be displayed on the prompt.

See also: BiometricPrompt.PromptInfo.Builder.setTitle(CharSequence)

public java.lang.CharSequence getSubtitle()

Gets the subtitle for the prompt.

Returns:

The subtitle to be displayed on the prompt.

See also: BiometricPrompt.PromptInfo.Builder.setSubtitle(CharSequence)

public java.lang.CharSequence getDescription()

Gets the description for the prompt.

Returns:

The description to be displayed on the prompt.

See also: BiometricPrompt.PromptInfo.Builder.setDescription(CharSequence)

public PromptContentView getContentView()

Gets the content view for the prompt, as set by BiometricPrompt.PromptInfo.Builder.setContentView(PromptContentView).

Returns:

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

public java.lang.CharSequence getNegativeButtonText()

Gets the text for the negative button on the prompt.

Returns:

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)

public boolean isConfirmationRequired()

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

Returns:

Whether this option is enabled.

See also: BiometricPrompt.PromptInfo.Builder.setConfirmationRequired(boolean)

public boolean isDeviceCredentialAllowed()

Deprecated: Will be removed with BiometricPrompt.PromptInfo.Builder.setDeviceCredentialAllowed(boolean).

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

Returns:

Whether this option is enabled.

See also: BiometricPrompt.PromptInfo.Builder.setDeviceCredentialAllowed(boolean)

public int getAllowedAuthenticators()

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

Returns:

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)