public
final
class
FingerprintManagerCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.hardware.fingerprint.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.
Nested classes | |
---|---|
class |
FingerprintManagerCompat.AuthenticationCallback
Callback structure provided to |
class |
FingerprintManagerCompat.AuthenticationResult
Container for callback data from |
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 |
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
|
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 |
FingerprintManagerCompat.CryptoObject :
object associated with the call or null if none required. |
flags |
int :
optional flags; should be 0 |
cancel |
CancellationSignal :
an object that can be used to cancel authentication |
callback |
FingerprintManagerCompat.AuthenticationCallback :
an object to receive authentication events |
handler |
Handler :
an optional handler for events
|
FingerprintManagerCompat from (Context context)
Get a FingerprintManagerCompat
instance for a provided context.
Parameters | |
---|---|
context |
Context
|
Returns | |
---|---|
FingerprintManagerCompat |
boolean hasEnrolledFingerprints ()
Determine if there is at least one fingerprint enrolled.
Returns | |
---|---|
boolean |
true if at least one fingerprint is enrolled, false otherwise |
boolean isHardwareDetected ()
Determine if fingerprint hardware is present and functional.
Returns | |
---|---|
boolean |
true if hardware is present and functional, false otherwise. |