Skip to main content
Version: 5.0.0-beta

Device

Methods#

getAvailableHardware#

Gets the types of biometrics the device supports.

Usage#

const hardware = await Device.getAvailableHardware();
hardware.forEach((biometricType) => console.log("Type: " + biometricType));

Returns: Promise<SupportedBiometricType[]>

getBiometricStrengthLevel#

Checks the device biometric strength level.

On iOS this will always return 'strong'.

Usage#

const biometricStrength = await Device.getBiometricStrengthLevel();

Returns: Promise<BiometricSecurityStrength>

isBiometricsEnabled#

Check whether or not biometrics is supported by the device and has been configured by the current user of the device.

Usage#

const biometricsEnabled = await Device.isBiometricsEnabled();
if (!biometricsEnabled) {
// biometrics not enabled on this device...
}

Returns: Promise<boolean>

isBiometricsSupported#

Check whether or not biometrics is supported by the device.

Usage#

const biometricsSupported = await Device.isBiometricsSupported();
if (biometricsSupported) {
// biometrics is supported on this device...
}

Returns: Promise<boolean>

isHideScreenOnBackgroundEnabled#

Check whether or not the screen will be obscured in app switcher mode.

Usage#

const willHideScreen = await Device.isHideScreenOnBackgroundEnabled();

Returns: Promise<boolean>

isLockedOutOfBiometrics#

Check whether biometrics are locked out on the device.

Usage#

const isLockedOut = await Device.isLockedOutOfBiometrics();
if (isLockedOut) {
// device is locked out ...
}

Returns: Promise<boolean>

isSystemPasscodeSet#

Check whether the device OS-level passcode has been set.

Usage#

const hasSystemPasscode = await Device.isSystemPasscodeSet();
if (hasSystemPasscode) {
// device has a system passcode
}

Returns: Promise<boolean>

setHideScreenOnBackground#

Set whether or not the screen will be obscured in app switcher mode

Usage#

await Device.setHideScreenOnBackground(true);

Parameters#

NameType
enabledboolean

Returns: Promise<void>