Added in version 37.2

Summary: Ctors | Methods | Inherited Methods

EmbeddedBiometricPrompt.AuthenticationCallback

Kotlin |Java

public static abstract class EmbeddedBiometricPrompt.AuthenticationCallback
extends Object

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

Callback structure provided to EmbeddedBiometricPrompt.startAuthenticationSession(CancellationSignal,int,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`	`onAuthenticationPaused()` Called when the authentication session has been paused.
`void`	`onAuthenticationResumed()` Called when the authentication session has been resumed.
`void`	`onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result)` Called when a biometric is recognized.
`void`	`onBackPressed()` Called when the user triggers a back gesture or back key press.
`void`	`onSessionStarted(long sessionId)` Called when the authentication session has started.
`void`	`onTappedOutside()` Called when the user taps outside the bounds of the prompt.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

AuthenticationCallback

public AuthenticationCallback ()

Public methods

onAuthenticationError

Added in version 37.2

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.

Note that when the user triggers a back gesture, onBackPressed() is called instead of this method.

Parameters
`errorCode`	`int`: An integer from `ERROR(BiometricConstants.Errors/android.hardware.biometrics.BiometricConstants.Errors BiometricConstants.Errors)` identifying the error message
`errString`	`CharSequence`: A human-readable error string that can be shown on an UI. This value cannot be `null`.

onAuthenticationFailed

Added in version 37.2

public void onAuthenticationFailed ()

Called when a biometric is valid but not recognized.

onAuthenticationHelp

Added in version 37.2

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 from `ERROR(BiometricFaceConstants.FaceAcquired/android.hardware.biometrics.BiometricFaceConstants.FaceAcquired BiometricFaceConstants.FaceAcquired)` or `ERROR(BiometricFingerprintConstants.FingerprintAcquired/android.hardware.biometrics.BiometricFingerprintConstants.FingerprintAcquired BiometricFingerprintConstants.FingerprintAcquired)` corresponding to a known error message.
`helpString`	`CharSequence`: A human-readable string that can be shown on an UI. This value cannot be `null`.

onAuthenticationPaused

Added in version 37.2

public void onAuthenticationPaused ()

Called when the authentication session has been paused.

onAuthenticationResumed

Added in version 37.2

public void onAuthenticationResumed ()

Called when the authentication session has been resumed.

onAuthenticationSucceeded

Added in version 37.2

public void onAuthenticationSucceeded (BiometricPrompt.AuthenticationResult result)

Called when a biometric is recognized.

Parameters
`result`	`BiometricPrompt.AuthenticationResult`: An object containing authentication-related data. This value cannot be `null`.

onBackPressed

Added in version 37.2

public void onBackPressed ()

Called when the user triggers a back gesture or back key press.

Note that when a back gesture is triggered, the prompt is automatically dismissed and the authentication session is terminated. Unlike standard BiometricPrompt, this callback is invoked directly instead of onAuthenticationError(int,CharSequence) with BiometricPrompt.BIOMETRIC_ERROR_USER_CANCELED.

onSessionStarted

Added in version 37.2

public void onSessionStarted (long sessionId)

Called when the authentication session has started.

Parameters
`sessionId`	`long`: The session id for this authentication operation.

onTappedOutside

Added in version 37.2

public void onTappedOutside ()

Called when the user taps outside the bounds of the prompt.

Note that calling this method does not automatically dismiss the prompt or terminate the authentication session. If you wish to terminate authentication, you must explicitly cancel using the CancellationSignal provided when starting the session.