Summary: Nested Classes | Methods | Inherited Methods

CredentialAuthPrompt

Kotlin |Java

public class CredentialAuthPrompt
extends Object

java.lang.Object
↳	androidx.biometric.auth.CredentialAuthPrompt

---

An authentication prompt that requires the user to present the screen lock credential (i.e. PIN, pattern, or password) for the device.

See also:

• BiometricManager.Authenticators.DEVICE_CREDENTIAL
• Class2BiometricAuthPrompt
• Class2BiometricOrCredentialAuthPrompt
• Class3BiometricAuthPrompt
• Class3BiometricOrCredentialAuthPrompt

Summary

Nested classes
class	CredentialAuthPrompt.Builder Builder for a CredentialAuthPrompt with configurable options.

Public methods
CharSequence	getDescription() Gets the description to be displayed on the prompt, if set.
CharSequence	getTitle() Gets the title to be displayed on the prompt.
AuthPrompt	startAuthentication(AuthPromptHost host, BiometricPrompt.CryptoObject crypto, Executor executor, AuthPromptCallback callback) Shows an authentication prompt to the user.
AuthPrompt	startAuthentication(AuthPromptHost host, BiometricPrompt.CryptoObject crypto, AuthPromptCallback callback) Shows an authentication prompt to the user.

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

getDescription

public CharSequence getDescription ()

Gets the description to be displayed on the prompt, if set.

Returns
CharSequence	The description for the prompt.

See also:

• CredentialAuthPrompt.Builder.setDescription(CharSequence)

getTitle

public CharSequence getTitle ()

Gets the title to be displayed on the prompt.

Returns
CharSequence	The title for the prompt.

startAuthentication

public AuthPrompt startAuthentication (AuthPromptHost host, 
                BiometricPrompt.CryptoObject crypto, 
                Executor executor, 
                AuthPromptCallback callback)

Shows an authentication prompt to the user.

Parameters
host	AuthPromptHost: A wrapper for the component that will host the prompt.
crypto	BiometricPrompt.CryptoObject: A cryptographic object to be associated with this authentication.
executor	Executor: The executor that will be used to run authentication callback methods.
callback	AuthPromptCallback: The callback object that will receive and process authentication events.

Returns
AuthPrompt	A handle to the shown prompt.

See also:

• startAuthentication(AuthPromptHost, BiometricPrompt.CryptoObject, AuthPromptCallback)

startAuthentication

public AuthPrompt startAuthentication (AuthPromptHost host, 
                BiometricPrompt.CryptoObject crypto, 
                AuthPromptCallback callback)

Shows an authentication prompt to the user.

Parameters
host	AuthPromptHost: A wrapper for the component that will host the prompt.
crypto	BiometricPrompt.CryptoObject: A cryptographic object to be associated with this authentication.
callback	AuthPromptCallback: The callback object that will receive and process authentication events. Each callback method will be run on the main thread.

Returns
AuthPrompt	A handle to the shown prompt.

See also:

• startAuthentication(AuthPromptHost, BiometricPrompt.CryptoObject, Executor, AuthPromptCallback)