BiometricManager

public class BiometricManager
extends Object

java.lang.Object
   ↳ androidx.biometric.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 BiometricManager. On Android 9.0 (API 28) and prior versions, this will query FingerprintManagerCompat.

Summary

Nested classes

interface BiometricManager.Authenticators

Types of authenticators, defined at a level of granularity supported by BiometricManager and BiometricPrompt

class BiometricManager.Strings

Provides localized strings for an application that uses BiometricPrompt to authenticate the user. 

Constants

int BIOMETRIC_ERROR_HW_UNAVAILABLE

The user can't authenticate because the hardware is unavailable.

int BIOMETRIC_ERROR_NONE_ENROLLED

The user can't authenticate because no biometric or device credential is enrolled.

int BIOMETRIC_ERROR_NO_HARDWARE

The user can't authenticate because there is no suitable hardware (e.g.

int BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED

The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors.

int BIOMETRIC_ERROR_UNSUPPORTED

The user can't authenticate because the specified options are incompatible with the current Android version.

int BIOMETRIC_STATUS_UNKNOWN

Unable to determine whether the user can authenticate.

int BIOMETRIC_SUCCESS

The user can successfully authenticate.

Public methods

int canAuthenticate()

This method is deprecated. Use canAuthenticate(int) instead.

int canAuthenticate(int authenticators)

Checks if the user can authenticate with an authenticator that meets the given requirements.

static BiometricManager from(Context context)

Creates a Biom