Interface BiometricManager

interface BiometricManager {
    enrollBiometric(
        authenticators?: BiometricAuthenticator[],
    ): Promise<boolean>;
    getBiometricStatus(
        authenticators?: BiometricAuthenticator[],
    ): BiometricStatus;
}

Index

Methods

enrollBiometric getBiometricStatus

Methods

enrollBiometric

enrollBiometric(authenticators?: BiometricAuthenticator[]): Promise<boolean>
Prompts the user to register credentials for given authenticators. If user already enrolled then returns a promise without any user interaction.

Note: This operation requires the user interaction, consider using ActivityManager.runUserInteraction to ensure that consequent UI-related operations are suspended until this one is completed.
Parameters
- Optionalauthenticators: BiometricAuthenticator[]
  The array of authenticators that must be supported for successful enrollment. If omitted, or if an empty array is provided then BiometricAuthenticator.BIOMETRIC_STRONG is used.
Returns Promise<boolean>
true if biometric enrollment succeeded, or false otherwise.

getBiometricStatus

getBiometricStatus(authenticators?: BiometricAuthenticator[]): BiometricStatus
Returns the status of the biometric authentication support for a given set of authenticators.
Parameters
- Optionalauthenticators: BiometricAuthenticator[]
  The array of authenticators that must be supported for successful result. If omitted, or if an empty array is provided then BiometricAuthenticator.BIOMETRIC_STRONG is used.
Returns BiometricStatus