lightbulb_outline Please take our October 2018 developer survey. Start survey

belongs to Maven artifact androidx.biometric:biometric:1.0.0-alpha01

BiometricPrompt.AuthenticationCallback

public static abstract class BiometricPrompt.AuthenticationCallback
extends Object

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


Callback structure provided to BiometricPrompt. Users of BiometricPrompt must provide an implementation of this for listening to fingerprint 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 onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

Inherited methods

Public constructors

BiometricPrompt.AuthenticationCallback

public BiometricPrompt.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. The error message will usually be one of the BIOMETRIC_ERROR constants.

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.

onAuthenticationSucceeded

public void onAuthenticationSucceeded (BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

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