public abstract class

FingerprintManagerCompat.AuthenticationCallback

extends java.lang.Object

 java.lang.Object

↳androidx.core.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback

Overview

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

Summary

Constructors
publicAuthenticationCallback()

Methods
public voidonAuthenticationError(int errMsgId, java.lang.CharSequence errString)

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

public voidonAuthenticationFailed()

Called when a fingerprint is valid but not recognized.

public voidonAuthenticationHelp(int helpMsgId, java.lang.CharSequence helpString)

Called when a recoverable error has been encountered during authentication.

public voidonAuthenticationSucceeded(FingerprintManagerCompat.AuthenticationResult result)

Called when a fingerprint is recognized.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public AuthenticationCallback()

Methods

public void onAuthenticationError(int errMsgId, java.lang.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 onAuthenticationHelp(int helpMsgId, java.lang.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

public void onAuthenticationFailed()

Called when a fingerprint is valid but not recognized.