BiometricPrompt.AuthenticationCallback

Kotlin |Java

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

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 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

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