BiometricManager
open class BiometricManager
kotlin.Any | |
↳ | android.hardware.biometrics.BiometricManager |
A class that contains biometric utilities. For authentication, see BiometricPrompt
.
Summary
Nested classes | |
---|---|
abstract |
Types of authenticators, defined at a level of granularity supported by |
open |
Provides localized strings for an application that uses |
Constants | |
---|---|
static Int |
The hardware is unavailable. |
static Int |
The user does not have any biometrics enrolled. |
static Int |
There is no biometric hardware. |
static Int |
A security vulnerability has been discovered and the sensor is unavailable until a security update has addressed this issue. |
static Int |
No error detected. |
Public methods | |
---|---|
open Int |
Determine if biometrics can be used. |
open Int |
canAuthenticate(authenticators: Int) Determine if any of the provided authenticators can be used. |
open BiometricManager.Strings |
getStrings(authenticators: Int) Produces an instance of the |
Constants
BIOMETRIC_ERROR_HW_UNAVAILABLE
static val BIOMETRIC_ERROR_HW_UNAVAILABLE: Int
The hardware is unavailable. Try again later.
Value: 1
BIOMETRIC_ERROR_NONE_ENROLLED
static val BIOMETRIC_ERROR_NONE_ENROLLED: Int
The user does not have any biometrics enrolled.
Value: 11
BIOMETRIC_ERROR_NO_HARDWARE
static val BIOMETRIC_ERROR_NO_HARDWARE: Int
There is no biometric hardware.
Value: 12
BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED
static val BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED: Int
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
.
Value: 15
BIOMETRIC_SUCCESS
static val BIOMETRIC_SUCCESS: Int
No error detected.
Value: 0
Public methods
canAuthenticate
open funcanAuthenticate(): Int
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 android.Manifest.permission#USE_BIOMETRIC
Return | |
---|---|
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 android.hardware.biometrics.BiometricManager#BIOMETRIC_SUCCESS , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_HW_UNAVAILABLE , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_NONE_ENROLLED , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_NO_HARDWARE , or android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED |
canAuthenticate
open fun canAuthenticate(authenticators: Int): Int
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 android.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 android.hardware.biometrics.BiometricManager.Authenticators#BIOMETRIC_STRONG , android.hardware.biometrics.BiometricManager.Authenticators#BIOMETRIC_WEAK , android.hardware.biometrics.BiometricManager.Authenticators.BIOMETRIC_CONVENIENCE, and android.hardware.biometrics.BiometricManager.Authenticators#DEVICE_CREDENTIAL |
Return | |
---|---|
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 android.hardware.biometrics.BiometricManager#BIOMETRIC_SUCCESS , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_HW_UNAVAILABLE , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_NONE_ENROLLED , android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_NO_HARDWARE , or android.hardware.biometrics.BiometricManager#BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED |
getStrings
open fun getStrings(authenticators: Int): BiometricManager.Strings
Produces an instance of the Strings
class, which provides localized strings for an application, given a set of allowed authenticator types.
Requires android.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 android.hardware.biometrics.BiometricManager.Authenticators#BIOMETRIC_STRONG , android.hardware.biometrics.BiometricManager.Authenticators#BIOMETRIC_WEAK , android.hardware.biometrics.BiometricManager.Authenticators.BIOMETRIC_CONVENIENCE, and android.hardware.biometrics.BiometricManager.Authenticators#DEVICE_CREDENTIAL |
Return | |
---|---|
BiometricManager.Strings |
A Strings collection for the given allowed authenticator types. This value cannot be null . |