FingerprintManager.AuthenticationCallback
public
static
abstract
class
FingerprintManager.AuthenticationCallback
extends Object
java.lang.Object | |
↳ | android.hardware.fingerprint.FingerprintManager.AuthenticationCallback |
This class was deprecated
in API level 28.
See BiometricPrompt.AuthenticationCallback
Callback structure provided to FingerprintManager#authenticate(CryptoObject,
CancellationSignal, int, AuthenticationCallback, Handler)
. Users of FingerprintManager.authenticate(android.hardware.fingerprint.FingerprintManager.CryptoObject, android.os.CancellationSignal, int, android.hardware.fingerprint.FingerprintManager.AuthenticationCallback, android.os.Handler)
must provide an implementation of this for listening to
fingerprint events.
Summary
Public constructors | |
---|---|
AuthenticationCallback()
|
Public methods | |
---|---|
void
|
onAuthenticationError(int errorCode, 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 helpCode, CharSequence helpString)
Called when a recoverable error has been encountered during authentication. |
void
|
onAuthenticationSucceeded(FingerprintManager.AuthenticationResult result)
Called when a fingerprint is recognized. |
Inherited methods | |
---|---|
Public constructors
AuthenticationCallback
public AuthenticationCallback ()
Public methods
onAuthenticationError
public void onAuthenticationError (int errorCode, 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 | |
---|---|
errorCode |
int : An integer identifying the error message |
errString |
CharSequence : A human-readable error string that can be shown in UI |
onAuthenticationFailed
public void onAuthenticationFailed ()
Called when a fingerprint is valid but not recognized.
onAuthenticationHelp
public void onAuthenticationHelp (int helpCode, 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 | |
---|---|
helpCode |
int : An integer identifying the error message |
helpString |
CharSequence : A human-readable string that can be shown in UI |
onAuthenticationSucceeded
public void onAuthenticationSucceeded (FingerprintManager.AuthenticationResult result)
Called when a fingerprint is recognized.
Parameters | |
---|---|
result |
FingerprintManager.AuthenticationResult : An object containing authentication-related data |