- Source:
Methods
changePin() → {Promise.<undefined>}
Change pin for currently enabled local authenticator.
- Source:
Returns:
If the promise is rejected, the callback will receive and object of type AuthError
- Type
- Promise.<undefined>
disable(type) → {Promise.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>}
Disable local authenticator denoted by localAuthenticationType. Note: User can disable PIN only after disabling fingerprint or biometric.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
LocalAuthPropertiesBuilder.LocalAuthenticatorType | local auth type to be disabled. |
- Source:
Returns:
- Type
- Promise.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>
enable(type) → {Promise.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>}
Enable authenticator denoted by localAuthenticationType. Note: PIN has to be enabled before fingerprint or biometric is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
LocalAuthPropertiesBuilder.LocalAuthenticatorType | local auth type to be enabled. |
- Source:
Returns:
If the promise is rejected, the callback will receive and object of type AuthError
- Type
- Promise.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>
getEnabled() → {Promise.<Array.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>>}
Get all enabled local authenticator types, in primary first order. This means that if LocalAuthenticationFlow#login is triggered on the corresponding LocalAuthenticationFlow, it will trigger the first authentication type returned. Note: PIN is always allowed. Fingerprint or Biometric is allowed based on device capabilities.
- Source:
Returns:
Enabled local auths, in primary first order.
- Type
- Promise.<Array.<LocalAuthPropertiesBuilder.LocalAuthenticatorType>>