Skip to main content

BiometricOptionsAndroid

@authgear/capacitor

@authgear/capacitor / BiometricOptionsAndroid

Interface: BiometricOptionsAndroid

Android specific options for biometric authentication.

Properties​

allowedAuthenticatorsOnAuthenticate​

allowedAuthenticatorsOnAuthenticate: BiometricAuthenticatorAndroid[]

Set the allowed authenticators when the user performs biometric authentication. This must be a superset of allowedAuthenticatorsOnEnable because you normally want to ensure the user performed at least once biometric authentication during setup, but allow the user to fallback to passcode for subsequent biometric authentication.

See BiometricAuthenticatorAndroid

allowedAuthenticatorsOnEnable​

allowedAuthenticatorsOnEnable: BiometricAuthenticatorAndroid[]

Set the allowed authenticators when the user enables biometric. This must be a subset of allowedAuthenticatorsOnAuthenticate because you normally want to ensure the user performed at least once biometric authentication during setup, but allow the user to fallback to passcode for subsequent biometric authentication.

See BiometricAuthenticatorAndroid

description​

description: string

See https://developer.android.com/reference/androidx/biometric/BiometricPrompt.PromptInfo#getDescription()

invalidatedByBiometricEnrollment​

invalidatedByBiometricEnrollment: boolean

The user needs to set up biometric again when a new biometric is enrolled or all enrolled biometrics are removed.

See https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec#isInvalidatedByBiometricEnrollment()

negativeButtonText​

negativeButtonText: string

https://developer.android.com/reference/androidx/biometric/BiometricPrompt.PromptInfo#getNegativeButtonText()

subtitle​

subtitle: string

See https://developer.android.com/reference/androidx/biometric/BiometricPrompt.PromptInfo#getSubtitle()

title​

title: string

See https://developer.android.com/reference/androidx/biometric/BiometricPrompt.PromptInfo#getTitle()