FingerprintManager.AuthenticationCallback

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

Summary

Public Constructors
	FingerprintManager.AuthenticationCallback()

Public Constructors

FingerprintManager.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.

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public void onAuthenticationError (int errorCode, CharSequence errString)

Added in API level 23

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

Parameters

errorCode	An integer identifying the error message
errString	A human-readable error string that can be shown in UI

public void onAuthenticationFailed ()

Added in API level 23

Called when a fingerprint is valid but not recognized.

public void onAuthenticationHelp (int helpCode, CharSequence helpString)

Added in API level 23

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

public void onAuthenticationSucceeded (FingerprintManager.AuthenticationResult result)

Added in API level 23

Called when a fingerprint is recognized.

Parameters

result	An object containing authentication-related data

Results

Classes

Class Overview

Summary

Public Constructors

public FingerprintManager.AuthenticationCallback ()

Public Methods

public void onAuthenticationError (int errorCode, CharSequence errString)

Parameters

public void onAuthenticationFailed ()

public void onAuthenticationHelp (int helpCode, CharSequence helpString)

Parameters

public void onAuthenticationSucceeded (FingerprintManager.AuthenticationResult result)

Parameters

java.lang.Object
↳	android.hardware.fingerprint.FingerprintManager.AuthenticationCallback