# Print output for @column tags ?>
public
class
BiometricManager
extends Object
java.lang.Object | |
↳ | android.hardware.biometrics.BiometricManager |
A class that contains biometric utilities. For authentication, see BiometricPrompt
.
Nested classes | |
---|---|
interface |
BiometricManager.Authenticators
Types of authenticators, defined at a level of granularity supported by
|
class |
BiometricManager.Strings
Provides localized strings for an application that uses |
Constants | |
---|---|
int |
BIOMETRIC_ERROR_HW_UNAVAILABLE
The hardware is unavailable. |
int |
BIOMETRIC_ERROR_NONE_ENROLLED
The user does not have any biometrics enrolled. |
int |
BIOMETRIC_ERROR_NO_HARDWARE
There is no biometric hardware. |
int |
BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED
A security vulnerability has been discovered and the sensor is unavailable until a security update has addressed this issue. |
int |
BIOMETRIC_SUCCESS
No error detected. |
Public methods | |
---|---|
int
|
canAuthenticate()
This method is deprecated.
See |
int
|
canAuthenticate(int authenticators)
Determine if any of the provided authenticators can be used. |
BiometricManager.Strings
|
getStrings(int authenticators)
Produces an instance of the |
Inherited methods | |
---|---|
public static final int BIOMETRIC_ERROR_HW_UNAVAILABLE
The hardware is unavailable. Try again later.
Constant Value: 1 (0x00000001)
public static final int BIOMETRIC_ERROR_NONE_ENROLLED
The user does not have any biometrics enrolled.
Constant Value: 11 (0x0000000b)
public static final int BIOMETRIC_ERROR_NO_HARDWARE
There is no biometric hardware.
Constant Value: 12 (0x0000000c)
public static final int BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED
A security vulnerability has been discovered and the sensor is unavailable until a
security update has addressed this issue. This error can be received if for example,
authentication was requested with Authenticators#BIOMETRIC_STRONG
, but the
sensor's strength can currently only meet Authenticators#BIOMETRIC_WEAK
.
Constant Value: 15 (0x0000000f)
public static final int BIOMETRIC_SUCCESS
No error detected.
Constant Value: 0 (0x00000000)
public int canAuthenticate ()
This method is deprecated.
See canAuthenticate(int)
.
Determine if biometrics can be used. In other words, determine if
BiometricPrompt
can be expected to be shown (hardware available, templates enrolled,
user-enabled). This is the equivalent of canAuthenticate(int)
with
Authenticators#BIOMETRIC_WEAK
Requires Manifest.permission.USE_BIOMETRIC
Returns | |
---|---|
int |
BIOMETRIC_ERROR_NONE_ENROLLED if the user does not have any strong
biometrics enrolled, or BIOMETRIC_ERROR_HW_UNAVAILABLE if none are currently
supported/enabled. Returns BIOMETRIC_SUCCESS if a strong biometric can currently
be used (enrolled and available).
Value is BIOMETRIC_SUCCESS , BIOMETRIC_ERROR_HW_UNAVAILABLE , BIOMETRIC_ERROR_NONE_ENROLLED , BIOMETRIC_ERROR_NO_HARDWARE , or BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED |
public int canAuthenticate (int authenticators)
Determine if any of the provided authenticators can be used. In other words, determine if
BiometricPrompt
can be expected to be shown (hardware available, templates enrolled,
user-enabled).
For biometric authenticators, determine if the device can currently authenticate with at
least the requested strength. For example, invoking this API with
Authenticators#BIOMETRIC_WEAK
on a device that currently only has
Authenticators#BIOMETRIC_STRONG
enrolled will return BIOMETRIC_SUCCESS
.
Invoking this API with Authenticators#DEVICE_CREDENTIAL
can be used to determine
if the user has a PIN/Pattern/Password set up.
Requires Manifest.permission.USE_BIOMETRIC
Parameters | |
---|---|
authenticators |
int : bit field consisting of constants defined in Authenticators .
If multiple authenticators are queried, a logical OR will be applied.
For example, if Authenticators#DEVICE_CREDENTIAL |
Authenticators#BIOMETRIC_STRONG is queried and only
Authenticators#DEVICE_CREDENTIAL is set up, this API will
return BIOMETRIC_SUCCESS
Value is either 0 or a combination of BiometricManager.Authenticators.BIOMETRIC_STRONG , BiometricManager.Authenticators.BIOMETRIC_WEAK , android.hardware.biometrics.BiometricManager.Authenticators.BIOMETRIC_CONVENIENCE, and BiometricManager.Authenticators.DEVICE_CREDENTIAL |
Returns | |
---|---|
int |
BIOMETRIC_ERROR_NONE_ENROLLED if the user does not have any of the
requested authenticators enrolled, or BIOMETRIC_ERROR_HW_UNAVAILABLE if none are
currently supported/enabled. Returns BIOMETRIC_SUCCESS if one of the requested
authenticators can currently be used (enrolled and available).
Value is BIOMETRIC_SUCCESS , BIOMETRIC_ERROR_HW_UNAVAILABLE , BIOMETRIC_ERROR_NONE_ENROLLED , BIOMETRIC_ERROR_NO_HARDWARE , or BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED |
public BiometricManager.Strings getStrings (int authenticators)
Produces an instance of the Strings
class, which provides localized strings for an
application, given a set of allowed authenticator types.
Requires Manifest.permission.USE_BIOMETRIC
Parameters | |
---|---|
authenticators |
int : A bit field representing the types of Authenticators that may
be used for authentication.
Value is either 0 or a combination of BiometricManager.Authenticators.BIOMETRIC_STRONG , BiometricManager.Authenticators.BIOMETRIC_WEAK , android.hardware.biometrics.BiometricManager.Authenticators.BIOMETRIC_CONVENIENCE, and BiometricManager.Authenticators.DEVICE_CREDENTIAL |
Returns | |
---|---|
BiometricManager.Strings |
A Strings collection for the given allowed authenticator types.
This value cannot be null . |