added in API level 23

Summary: Nested Classes | Constants | Methods | Inherited Methods | [Expand All]

FingerprintManager

public class FingerprintManager
extends Object

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

A class that coordinates access to the fingerprint hardware.

Use getSystemService(java.lang.String) with argument FINGERPRINT_SERVICE to get an instance of this class.

Summary

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

Constants
`int`	`FINGERPRINT_ACQUIRED_GOOD` The image acquired was good.
`int`	`FINGERPRINT_ACQUIRED_IMAGER_DIRTY` The fingerprint image was too noisy due to suspected or detected dirt on the sensor.
`int`	`FINGERPRINT_ACQUIRED_INSUFFICIENT` The fingerprint image was too noisy to process due to a detected condition (i.e.
`int`	`FINGERPRINT_ACQUIRED_PARTIAL` Only a partial fingerprint image was detected.
`int`	`FINGERPRINT_ACQUIRED_TOO_FAST` The fingerprint image was incomplete due to quick motion.
`int`	`FINGERPRINT_ACQUIRED_TOO_SLOW` The fingerprint image was unreadable due to lack of motion.
`int`	`FINGERPRINT_ERROR_CANCELED` The operation was canceled because the fingerprint sensor is unavailable.
`int`	`FINGERPRINT_ERROR_HW_UNAVAILABLE` The hardware is unavailable.
`int`	`FINGERPRINT_ERROR_LOCKOUT` The operation was canceled because the API is locked out due to too many attempts.
`int`	`FINGERPRINT_ERROR_NO_SPACE` Error state returned for operations like enrollment; the operation cannot be completed because there's not enough storage remaining to complete the operation.
`int`	`FINGERPRINT_ERROR_TIMEOUT` Error state returned when the current request has been running too long.
`int`	`FINGERPRINT_ERROR_UNABLE_TO_PROCESS` Error state returned when the sensor was unable to process the current image.

Public methods
`void`	`authenticate(FingerprintManager.CryptoObject crypto, CancellationSignal cancel, int flags, FingerprintManager.AuthenticationCallback callback, Handler handler)` Request authentication of a crypto object.
`boolean`	`hasEnrolledFingerprints()` Determine if there is at least one fingerprint enrolled.
`boolean`	`isHardwareDetected()` Determine if fingerprint hardware is present and functional.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

FINGERPRINT_ACQUIRED_GOOD

added in API level 23

int FINGERPRINT_ACQUIRED_GOOD

The image acquired was good.

Constant Value: 0 (0x00000000)

FINGERPRINT_ACQUIRED_IMAGER_DIRTY

added in API level 23

int FINGERPRINT_ACQUIRED_IMAGER_DIRTY

The fingerprint image was too noisy due to suspected or detected dirt on the sensor. For example, it's reasonable return this after multiple FINGERPRINT_ACQUIRED_INSUFFICIENT or actual detection of dirt on the sensor (stuck pixels, swaths, etc.). The user is expected to take action to clean the sensor when this is returned.

Constant Value: 3 (0x00000003)

FINGERPRINT_ACQUIRED_INSUFFICIENT

added in API level 23

int FINGERPRINT_ACQUIRED_INSUFFICIENT

The fingerprint image was too noisy to process due to a detected condition (i.e. dry skin) or a possibly dirty sensor (See FINGERPRINT_ACQUIRED_IMAGER_DIRTY).

Constant Value: 2 (0x00000002)

FINGERPRINT_ACQUIRED_PARTIAL

added in API level 23

int FINGERPRINT_ACQUIRED_PARTIAL

Only a partial fingerprint image was detected. During enrollment, the user should be informed on what needs to happen to resolve this problem, e.g. "press firmly on sensor."

Constant Value: 1 (0x00000001)

FINGERPRINT_ACQUIRED_TOO_FAST

added in API level 23

int FINGERPRINT_ACQUIRED_TOO_FAST

The fingerprint image was incomplete due to quick motion. While mostly appropriate for linear array sensors, this could also happen if the finger was moved during acquisition. The user should be asked to move the finger slower (linear) or leave the finger on the sensor longer.

Constant Value: 5 (0x00000005)

FINGERPRINT_ACQUIRED_TOO_SLOW

added in API level 23

int FINGERPRINT_ACQUIRED_TOO_SLOW

The fingerprint image was unreadable due to lack of motion. This is most appropriate for linear array sensors that require a swipe motion.

Constant Value: 4 (0x00000004)

FINGERPRINT_ERROR_CANCELED

added in API level 23

int FINGERPRINT_ERROR_CANCELED

The operation was canceled because the fingerprint sensor is unavailable. For example, this may happen when the user is switched, the device is locked or another pending operation prevents or disables it.

Constant Value: 5 (0x00000005)

FINGERPRINT_ERROR_HW_UNAVAILABLE

added in API level 23

int FINGERPRINT_ERROR_HW_UNAVAILABLE

The hardware is unavailable. Try again later.

Constant Value: 1 (0x00000001)

FINGERPRINT_ERROR_LOCKOUT

added in API level 23

int FINGERPRINT_ERROR_LOCKOUT

The operation was canceled because the API is locked out due to too many attempts.

Constant Value: 7 (0x00000007)

FINGERPRINT_ERROR_NO_SPACE

added in API level 23

int FINGERPRINT_ERROR_NO_SPACE

Error state returned for operations like enrollment; the operation cannot be completed because there's not enough storage remaining to complete the operation.

Constant Value: 4 (0x00000004)

FINGERPRINT_ERROR_TIMEOUT

added in API level 23

int FINGERPRINT_ERROR_TIMEOUT

Error state returned when the current request has been running too long. This is intended to prevent programs from waiting for the fingerprint sensor indefinitely. The timeout is platform and sensor-specific, but is generally on the order of 30 seconds.

Constant Value: 3 (0x00000003)

FINGERPRINT_ERROR_UNABLE_TO_PROCESS

added in API level 23

int FINGERPRINT_ERROR_UNABLE_TO_PROCESS

Error state returned when the sensor was unable to process the current image.

Constant Value: 2 (0x00000002)

Public methods

authenticate

added in API level 23

void authenticate (FingerprintManager.CryptoObject crypto, 
                CancellationSignal cancel, 
                int flags, 
                FingerprintManager.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 onAuthenticationSucceeded(AuthenticationResult) is called, at which point the object is no longer valid. The operation can be canceled by using the provided cancel object.

Requires the USE_FINGERPRINT permission.

Parameters
`crypto`	`FingerprintManager.CryptoObject`: object associated with the call or null if none required. This value may be `null`.
`cancel`	`CancellationSignal`: an object that can be used to cancel authentication This value may be `null`.
`flags`	`int`: optional flags; should be 0
`callback`	`FingerprintManager.AuthenticationCallback`: an object to receive authentication events This value must never be `null`.
`handler`	`Handler`: an optional handler to handle callback events This value may be `null`.

Throws
`IllegalArgumentException`	if the crypto operation is not supported or is not backed by Android Keystore facility.
`IllegalStateException`	if the crypto primitive is not initialized.

hasEnrolledFingerprints

added in API level 23

boolean hasEnrolledFingerprints ()

Determine if there is at least one fingerprint enrolled.

Requires the USE_FINGERPRINT permission.

Returns
`boolean`	true if at least one fingerprint is enrolled, false otherwise

isHardwareDetected

added in API level 23

boolean isHardwareDetected ()

Determine if fingerprint hardware is present and functional.

Requires the USE_FINGERPRINT permission.

Returns
`boolean`	true if hardware is present and functional, false otherwise.

Classes

Most visited

Recently visited

Results for

FingerprintManager

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

FINGERPRINT_ACQUIRED_GOOD

FINGERPRINT_ACQUIRED_IMAGER_DIRTY

FINGERPRINT_ACQUIRED_INSUFFICIENT

FINGERPRINT_ACQUIRED_PARTIAL

FINGERPRINT_ACQUIRED_TOO_FAST

FINGERPRINT_ACQUIRED_TOO_SLOW

FINGERPRINT_ERROR_CANCELED

FINGERPRINT_ERROR_HW_UNAVAILABLE

FINGERPRINT_ERROR_LOCKOUT

FINGERPRINT_ERROR_NO_SPACE

FINGERPRINT_ERROR_TIMEOUT

FINGERPRINT_ERROR_UNABLE_TO_PROCESS

Public methods

authenticate

hasEnrolledFingerprints

isHardwareDetected

Classes