AuthenticationCallback

Kotlin |Java

abstract class AuthenticationCallback

kotlin.Any
↳	androidx.biometric.BiometricPrompt.AuthenticationCallback

Callback structure provided to BiometricPrompt. Users of must provide an implementation of this for listening to fingerprint events.

Summary

Public constructors
`<init>()` Callback structure provided to `BiometricPrompt`.

Public methods
open Unit	`onAuthenticationError(errorCode: Int, @NonNull errString: CharSequence)` Called when an unrecoverable error has been encountered and the operation is complete.
open Unit	`onAuthenticationFailed()` Called when a biometric is valid but not recognized.
open Unit	`onAuthenticationSucceeded(@NonNull result: BiometricPrompt.AuthenticationResult)` Called when a biometric is recognized.

AuthenticationCallback()

Callback structure provided to BiometricPrompt. Users of must provide an implementation of this for listening to fingerprint events.

open fun onAuthenticationError(
    errorCode: Int, 
    @NonNull errString: CharSequence
): Unit

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

open fun onAuthenticationFailed(): Unit

Called when a biometric is valid but not recognized.

open fun onAuthenticationSucceeded(@NonNull result: BiometricPrompt.AuthenticationResult): Unit

Called when a biometric is recognized.

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