FingerprintManagerCompat.AuthenticationCallback

Added in 1.1.0
Deprecated in 1.1.0

abstract class FingerprintManagerCompat.AuthenticationCallback


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

Summary

Public constructors

Public functions

Unit
onAuthenticationError(errMsgId: Int, errString: CharSequence!)

Called when an unrecoverable error has been encountered and the operation is complete.

Unit

Called when a fingerprint is valid but not recognized.

Unit
onAuthenticationHelp(helpMsgId: Int, helpString: CharSequence!)

Called when a recoverable error has been encountered during authentication.

Unit

Called when a fingerprint is recognized.

Public constructors

AuthenticationCallback

Added in 1.1.0
Deprecated in 1.1.0
AuthenticationCallback()

Public functions

onAuthenticationError

Added in 1.1.0
Deprecated in 1.1.0
fun onAuthenticationError(errMsgId: Int, errString: CharSequence!): Unit

Called when an unrecoverable error has been encountered and the operation is complete. No further callbacks will be made on this object.

Parameters
errMsgId: Int

An integer identifying the error message

errString: CharSequence!

A human-readable error string that can be shown in UI

onAuthenticationFailed

Added in 1.1.0
Deprecated in 1.1.0
fun onAuthenticationFailed(): Unit

Called when a fingerprint is valid but not recognized.

onAuthenticationHelp

Added in 1.1.0
Deprecated in 1.1.0
fun onAuthenticationHelp(helpMsgId: Int, helpString: CharSequence!): Unit

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
helpMsgId: Int

An integer identifying the error message

helpString: CharSequence!

A human-readable string that can be shown in UI

onAuthenticationSucceeded

Added in 1.1.0
Deprecated in 1.1.0
fun onAuthenticationSucceeded(
    result: FingerprintManagerCompat.AuthenticationResult!
): Unit

Called when a fingerprint is recognized.

Parameters
result: FingerprintManagerCompat.AuthenticationResult!

An object containing authentication-related data