BiometricManager
public class BiometricManager
A class that provides system information related to biometrics (e.g. fingerprint, face, etc.).
On devices running Android 10 (API 29) and above, this will query the framework's version of android.hardware.biometrics.BiometricManager. On Android 9.0 (API 28) and prior versions, this will query androidx.biometric.internal.FingerprintManagerCompat.
| See also | |
|---|---|
BiometricPrompt |
To prompt the user to authenticate with their biometric. |
Summary
Nested types |
|---|
public interface BiometricManager.AuthenticatorsTypes of authenticators, defined at a level of granularity supported by |
public class BiometricManager.StringsProvides localized strings for an application that uses |
Constants |
|
|---|---|
static final int |
The user can't authenticate because the hardware is unavailable. |
static final int |
Identity Check is currently not active. |
static final int |
The user can't authenticate because no biometric or device credential is enrolled. |
static final int |
The user can't authenticate because there is no suitable hardware (e.g. no biometric sensor or no keyguard). |
static final int |
The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors. |
static final int |
The user can't authenticate because the specified options are incompatible with the current Android version. |
static final int |
Unable to determine whether the user can authenticate. |
static final int |
The user can successfully authenticate. |
Public methods |
|
|---|---|
int |
This method is deprecated. Use |
int |
canAuthenticate(int authenticators)Checks if the user can authenticate with an authenticator that meets the given requirements. |
static @NonNull BiometricManager |
Creates a |
@Nullable BiometricManager.Strings |
@RequiresPermission(value = Manifest.permission.USE_BIOMETRIC)Produces an instance of the |
Constants
BIOMETRIC_ERROR_HW_UNAVAILABLE
public static final int BIOMETRIC_ERROR_HW_UNAVAILABLE = 1
The user can't authenticate because the hardware is unavailable. Try again later.
BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE
public static final int BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE = 20
Identity Check is currently not active. This device either doesn't have this feature enabled, or it's not considered in a high-risk environment that requires extra security measures for accessing sensitive data.
BIOMETRIC_ERROR_NONE_ENROLLED
public static final int BIOMETRIC_ERROR_NONE_ENROLLED = 11
The user can't authenticate because no biometric or device credential is enrolled.
BIOMETRIC_ERROR_NO_HARDWARE
public static final int BIOMETRIC_ERROR_NO_HARDWARE = 12
The user can't authenticate because there is no suitable hardware (e.g. no biometric sensor or no keyguard).
BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED
public static final int BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED = 15
The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors. The affected sensor(s) are unavailable until a security update has addressed the issue.
BIOMETRIC_ERROR_UNSUPPORTED
public static final int BIOMETRIC_ERROR_UNSUPPORTED = -2
The user can't authenticate because the specified options are incompatible with the current Android version.
BIOMETRIC_STATUS_UNKNOWN
public static final int BIOMETRIC_STATUS_UNKNOWN = -1
Unable to determine whether the user can authenticate.
This status code may be returned on older Android versions due to partial incompatibility with a newer API. Applications that wish to enable biometric authentication on affected devices may still call BiometricPrompt#authenticate() after receiving this status code but should be prepared to handle possible errors.
BIOMETRIC_SUCCESS
public static final int BIOMETRIC_SUCCESS = 0
The user can successfully authenticate.
Public methods
public int canAuthenticate()Checks if the user can authenticate with biometrics. This requires at least one biometric sensor to be present, enrolled, and available on the device.
| Returns | |
|---|---|
int |
|
canAuthenticate
public int canAuthenticate(int authenticators)
Checks if the user can authenticate with an authenticator that meets the given requirements. This requires at least one of the specified authenticators to be present, enrolled, and available on the device.
Note that not all combinations of authenticator types are supported prior to Android 11 (API 30). Specifically, DEVICE_CREDENTIAL alone is unsupported prior to API 30, and BIOMETRIC_STRONG | DEVICE_CREDENTIAL is unsupported on API 28-29. Developers that wish to check for the presence of a PIN, pattern, or password on these versions should instead use isDeviceSecure.
| Parameters | |
|---|---|
int authenticators |
A bit field representing the types of |
| Returns | |
|---|---|
int |
|
from
public static @NonNull BiometricManager from(@NonNull Context context)
Creates a BiometricManager instance from the given context.
| Returns | |
|---|---|
@NonNull BiometricManager |
An instance of |
getStrings
@RequiresPermission(value = Manifest.permission.USE_BIOMETRIC)
public @Nullable 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.
| Parameters | |
|---|---|
int authenticators |
A bit field representing the types of |
| Returns | |
|---|---|
@Nullable BiometricManager.Strings |
A |