# Print output for @column tags ?> BiometricPrompt.AuthenticationCallback - Android SDK | Android Developers

Most visited


Recently visited


BiometricPrompt.AuthenticationCallback

public static abstract class BiometricPrompt.AuthenticationCallback
extends Object

java.lang.Object
   ↳ android.hardware.biometrics.BiometricPrompt.AuthenticationCallback


Callback structure provided to BiometricPrompt#authenticate(CancellationSignal, Executor, AuthenticationCallback) or BiometricPrompt#authenticate(CryptoObject, CancellationSignal, Executor, AuthenticationCallback). Users must provide an implementation of this for listening to authentication events.

Summary


Public constructors

AuthenticationCallback()

Public methods

void onAuthenticationError(int errorCode, CharSequence errString)

Called when an unrecoverable error has been encountered and the operation is complete.

void onAuthenticationFailed()

Called when a biometric is valid but not recognized.

void onAuthenticationHelp(int helpCode, CharSequence helpString)

Called when a recoverable error has been encountered during authentication.

void onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

Inherited methods

Public constructors


AuthenticationCallback

public AuthenticationCallback ()

Public methods


onAuthenticationError

public void onAuthenticationError (int errorCode, 
                CharSequence errString)

Called when an unrecoverable error has been encountered and the operation is complete. No further actions will be made on this object.

Parameters
errorCode int: An integer identifying the error message

errString CharSequence: A human-readable error string that can be shown on an UI

onAuthenticationFailed

public void onAuthenticationFailed ()

Called when a biometric is valid but not recognized.

onAuthenticationHelp

public void onAuthenticationHelp (int helpCode, 
                CharSequence helpString)

Called when a recoverable error has been encountered during authentication. The help string is provided to give the user guidance for what went wrong, such as "Sensor dirty, please clean it."

Parameters
helpCode int: An integer identifying the error message

helpString CharSequence: A human-readable string that can be shown on an UI

onAuthenticationSucceeded

public void onAuthenticationSucceeded (BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

Parameters
result BiometricPrompt.AuthenticationResult: An object containing authentication-related data

Browse this site in English?

You requested a page in English, but your language preference for this site is English.

Would you like to change your language preference and browse this site in English? If you want to change your language preference later, use the language menu at the bottom of each page.