public
static
abstract
class
FingerprintManagerCompat.AuthenticationCallback
extends Object
java.lang.Object | |
↳ | android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback |
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.
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. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
FingerprintManagerCompat.AuthenticationCallback ()
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 |
int :
An integer identifying the error message |
errString |
CharSequence :
A human-readable error string that can be shown in UI
|
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. 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
|
void onAuthenticationSucceeded (FingerprintManagerCompat.AuthenticationResult result)
Called when a fingerprint is recognized.
Parameters | |
---|---|
result |
FingerprintManagerCompat.AuthenticationResult :
An object containing authentication-related data
|