Device
Methods
getAvailableHardware
Gets the types of biometrics the device supports.
Usage
_10const hardware = await Device.getAvailableHardware();_10hardware.forEach((biometricType) => console.log("Type: " + biometricType));
Returns: Promise<SupportedBiometricType[]>
getBiometricStrengthLevel
Checks the device biometric strength level.
On iOS this will always return 'strong'.
Usage
_10const biometricStrength = await Device.getBiometricStrengthLevel();
Returns: Promise<BiometricSecurityStrength>
hasSecureHardware
Check if the device has a secure hardware enclave.
Usage
_10const hasSecureHardware = await Device.hasSecureHardware();_10if (!hasSecureHardware) {_10 // this device doesn't have secure hardware_10}
Returns: Promise<boolean>
isBiometricsAllowed
Returns the current state of biometric permissions.
On Android and iOS devices with TouchID, this always returns granted.
Usage
_10const permissions = await Device.isBiometricsAllowed();_10if (permissions === BiometricPermissionState.Denied) {_10 // user must enable FaceID for the application..._10}
Returns: Promise<BiometricPermissionState>
isBiometricsEnabled
Check whether or not biometrics is supported by the device and has been configured by the current user of the device.
Usage
_10const biometricsEnabled = await Device.isBiometricsEnabled();_10if (!biometricsEnabled) {_10 // biometrics not enabled on this device..._10}
Returns: Promise<boolean>
isBiometricsSupported
Check whether or not biometrics is supported by the device.
Usage
_10const biometricsSupported = await Device.isBiometricsSupported();_10if (biometricsSupported) {_10 // biometrics is supported on this device..._10}
Returns: Promise<boolean>
isHideScreenOnBackgroundEnabled
Check whether or not the screen will be obscured in app switcher mode.
Usage
_10const willHideScreen = await Device.isHideScreenOnBackgroundEnabled();
Returns: Promise<boolean>
isLockedOutOfBiometrics
Check whether biometrics are locked out on the device.
On Android, the locked out state will only known after an attempted biometric unlock.
Usage
_10const isLockedOut = await Device.isLockedOutOfBiometrics();_10if (isLockedOut) {_10 // device is locked out ..._10}
Returns: Promise<boolean>
isSystemPasscodeSet
Check whether the device OS-level passcode has been set.
Usage
_10const hasSystemPasscode = await Device.isSystemPasscodeSet();_10if (hasSystemPasscode) {_10 // device has a system passcode_10}
Returns: Promise<boolean>
setHideScreenOnBackground
Set whether or not the screen will be obscured in app switcher mode. If enabled, by default the screen behind biometric prompts will be obscured via the splash screen.
For Android, an optional boolean dimBiometrics can be set to obscure the screen behind biometric prompts via dimming the background instead.
Usage
_10await Device.setHideScreenOnBackground(true, true);
Parameters
| Name | Type | Default value |
|---|---|---|
enabled | boolean | false |
dimBiometrics | boolean | false |
Returns: Promise<void>
showBiometricPrompt
Show a biometric prompt.
Usage
_10try {_10 const promptConfig = {...};_10 await Device.showBiometricPrompt(promptConfig);_10 // biometric prompt succeeded successfully_10} catch (err) {_10 // handle error_10}
Parameters
| Name | Type |
|---|---|
config | PromptConfig |
Returns: Promise<void>