Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

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

BiometricPrompt.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(BiometricAuthenticator.AuthenticationResult result)

Called when a biometric is recognized.

void onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

Inherited methods

Public constructors

BiometricPrompt.AuthenticationCallback

added in API level 28
public BiometricPrompt.AuthenticationCallback ()

Public methods

onAuthenticationError

added in API level 28
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

added in API level 28
public void onAuthenticationFailed ()

Called when a biometric is valid but not recognized.

onAuthenticationHelp

added in API level 28
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 (BiometricAuthenticator.AuthenticationResult result)

Called when a biometric is recognized.

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

onAuthenticationSucceeded

added in API level 28
public void onAuthenticationSucceeded (BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

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