Class: LocalAuthenticationHelper

LocalAuthenticationHelper

This class contains helper methods for local authentication related functionality.

Members

(static, readonly) Availability

Device level availability states for local authentication.

Properties:
Name Type Description
Enrolled string

Local auth type is supported and configured on device. This type of local auth is ready to be enabled.

NotEnrolled string

Local auth type is supported but not configured on device. User should be prompted to enroll the auth type on device and try again.

LockedOut string

Local auth type is supported but is locked out due to many failed attempts. User should be prompted to unlock the auth type and then try again.

NotAvailable string

Local auth type is not supported by the device.

Source:

Methods

(static) getLocalAuthSupportInfo() → {Promise.<Object.<LocalAuthPropertiesBuilder.LocalAuthenticatorType, LocalAuthenticationHelper.Availability>>}

The method returns capabilities supported by device. LocalAuthentications supported by the device can be obtained from this.

Source:
Returns:

Local authentications supported by the device and their availability.

Type
Promise.<Object.<LocalAuthPropertiesBuilder.LocalAuthenticatorType, LocalAuthenticationHelper.Availability>>