Google is committed to advancing racial equity for Black communities. See how.

BiometricPrompt.AuthenticationCallback

public static abstract class BiometricPrompt.AuthenticationCallback
extends Object

java.lang.Object
   ↳ androidx.biometric.BiometricPrompt.AuthenticationCallback


A collection of methods that may be invoked by BiometricPrompt during authentication.

Summary

Public constructors

AuthenticationCallback()

Public methods

void onAuthenticationError(int errorCode, CharSequence errString)

Called when an unrecoverable error has been encountered and authentication has stopped.

void onAuthenticationFailed()

Called when a biometric (e.g.

void onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result)

Called when a biometric (e.g.

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 authentication has stopped.

After this method is called, no further events will be sent for the current authentication session.

Parameters
errorCode int: An integer ID associated with the error.

errString CharSequence: A human-readable string that describes the error.

onAuthenticationFailed

public void onAuthenticationFailed ()

Called when a biometric (e.g. fingerprint, face, etc.) is presented but not recognized as belonging to the user.

onAuthenticationSucceeded

public void onAuthenticationSucceeded (BiometricPrompt.AuthenticationResult result)

Called when a biometric (e.g. fingerprint, face, etc.) is recognized, indicating that the user has successfully authenticated.

After this method is called, no further events will be sent for the current authentication session.

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