FingerprintManagerCompat.AuthenticationCallback

Added in 1.1.0
Deprecated in 1.1.0

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

void
onAuthenticationError(int errMsgId, CharSequence errString)

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

void

Called when a fingerprint is valid but not recognized.

void
onAuthenticationHelp(int helpMsgId, CharSequence helpString)

Called when a recoverable error has been encountered during authentication.

void

Called when a fingerprint is recognized.

Public constructors

AuthenticationCallback

Added in 1.1.0
Deprecated in 1.1.0
public AuthenticationCallback()

Public methods

onAuthenticationError

Added in 1.1.0
Deprecated in 1.1.0
public void onAuthenticationError(int errMsgId, CharSequence errString)

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

Parameters
int errMsgId

An integer identifying the error message

CharSequence errString

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

onAuthenticationFailed

Added in 1.1.0
Deprecated in 1.1.0
public void onAuthenticationFailed()

Called when a fingerprint is valid but not recognized.

onAuthenticationHelp

Added in 1.1.0
Deprecated in 1.1.0
public void onAuthenticationHelp(int helpMsgId, 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
int helpMsgId

An integer identifying the error message

CharSequence helpString

A human-readable string that can be shown in UI

onAuthenticationSucceeded

Added in 1.1.0
Deprecated in 1.1.0
public void onAuthenticationSucceeded(
    FingerprintManagerCompat.AuthenticationResult result
)

Called when a fingerprint is recognized.

Parameters
FingerprintManagerCompat.AuthenticationResult result

An object containing authentication-related data