FingerprintManagerCompat

A class that coordinates access to the fingerprint hardware.

On platforms before M, this class behaves as there would be no fingerprint hardware available.

Summary

Nested Classes
class	FingerprintManagerCompat.AuthenticationCallback	Callback structure provided to `authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler)`.
class	FingerprintManagerCompat.AuthenticationResult	Container for callback data from `authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler)`.
class	FingerprintManagerCompat.CryptoObject	A wrapper class for the crypto objects supported by FingerprintManager.

Nested Classes

class

FingerprintManagerCompat.AuthenticationCallback

Callback structure provided to authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler).

class

FingerprintManagerCompat.AuthenticationResult

Container for callback data from authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler).

class

FingerprintManagerCompat.CryptoObject

A wrapper class for the crypto objects supported by FingerprintManager.

Public Methods
void	authenticate(FingerprintManagerCompat.CryptoObject crypto, int flags, CancellationSignal cancel, FingerprintManagerCompat.AuthenticationCallback callback, Handler handler) Request authentication of a crypto object.
static FingerprintManagerCompat	from(Context context) Get a `FingerprintManagerCompat` instance for a provided context.
boolean	hasEnrolledFingerprints() Determine if there is at least one fingerprint enrolled.
boolean	isHardwareDetected() Determine if fingerprint hardware is present and functional.

Public Methods

void

authenticate(FingerprintManagerCompat.CryptoObject crypto, int flags, CancellationSignal cancel, FingerprintManagerCompat.AuthenticationCallback callback, Handler handler)

Request authentication of a crypto object.

static FingerprintManagerCompat

from(Context context)

Get a FingerprintManagerCompat instance for a provided context.

boolean

hasEnrolledFingerprints()

Determine if there is at least one fingerprint enrolled.

boolean

isHardwareDetected()

Determine if fingerprint hardware is present and functional.

[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 authenticate (FingerprintManagerCompat.CryptoObject crypto, int flags, CancellationSignal cancel, FingerprintManagerCompat.AuthenticationCallback callback, Handler handler)

Request authentication of a crypto object. This call warms up the fingerprint hardware and starts scanning for a fingerprint. It terminates when onAuthenticationError(int, CharSequence) or {@link AuthenticationCallback#onAuthenticationSucceeded(AuthenticationResult) is called, at which point the object is no longer valid. The operation can be canceled by using the provided cancel object.

Parameters

crypto	object associated with the call or null if none required.
flags	optional flags; should be 0
cancel	an object that can be used to cancel authentication
callback	an object to receive authentication events
handler	an optional handler for events

public boolean hasEnrolledFingerprints ()

Determine if there is at least one fingerprint enrolled.

Returns

true if at least one fingerprint is enrolled, false otherwise

public boolean isHardwareDetected ()

Determine if fingerprint hardware is present and functional.

Returns

true if hardware is present and functional, false otherwise.

Results

Classes

Class Overview

Summary

Public Methods

public void authenticate (FingerprintManagerCompat.CryptoObject crypto, int flags, CancellationSignal cancel, FingerprintManagerCompat.AuthenticationCallback callback, Handler handler)

Parameters

public static FingerprintManagerCompat from (Context context)

public boolean hasEnrolledFingerprints ()

Returns

public boolean isHardwareDetected ()

Returns

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