Android APIs
public static abstract class

FingerprintManagerCompat.AuthenticationCallback

extends Object
java.lang.Object
   ↳ android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback

Class Overview

Callback structure provided to authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler). Users of authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler) must provide an implementation of this for listening to fingerprint events.

Summary

Public Constructors
FingerprintManagerCompat.AuthenticationCallback()
Public Methods
void onAuthenticationError(int errMsgId, CharSequence errString)
Called when an unrecoverable error has been encountered and the operation is complete.
void onAuthenticationFailed()
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 onAuthenticationSucceeded(FingerprintManagerCompat.AuthenticationResult result)
Called when a fingerprint is recognized.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FingerprintManagerCompat.AuthenticationCallback ()

Public Methods

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
errMsgId An integer identifying the error message
errString A human-readable error string that can be shown in UI

public void onAuthenticationFailed ()

Called when a fingerprint is valid but not recognized.

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
helpMsgId An integer identifying the error message
helpString A human-readable string that can be shown in UI

public void onAuthenticationSucceeded (FingerprintManagerCompat.AuthenticationResult result)

Called when a fingerprint is recognized.

Parameters
result An object containing authentication-related data