biometric
Enumerations
BiometryType
Enumeration Members
FaceID
FaceID: 2;Iris
Iris: 3;None
None: 0;TouchID
TouchID: 1;Interfaces
AuthOptions
Properties
| Property | Type | Defined in |
|---|---|---|
allowDeviceCredential? | boolean | |
cancelTitle? | string | |
confirmationRequired? | boolean | |
fallbackTitle? | string | |
maxAttemps? | number | |
subtitle? | string | |
title? | string |
Status
Properties
| Property | Type | Defined in |
|---|---|---|
biometryType | BiometryType | |
error? | string | |
errorCode? | | "appCancel" | "authenticationFailed" | "invalidContext" | "notInteractive" | "passcodeNotSet" | "systemCancel" | "userCancel" | "userFallback" | "biometryLockout" | "biometryNotAvailable" | "biometryNotEnrolled" | |
isAvailable | boolean |
Functions
authenticate()
function authenticate(reason, options?): Promise<void>Prompts the user for authentication using the system interface (touchID, faceID or Android Iris). Rejects if the authentication fails.
import { authenticate } from "@crabnebula/taurify-api/biometric";await authenticate('Open your wallet');Parameters
| Parameter | Type | Description |
|---|---|---|
reason | string | |
options? | AuthOptions |
Returns
Promise<void>
checkStatus()
function checkStatus(): Promise<Status>Checks if the biometric authentication is available.
Returns
a promise resolving to an object containing all the information about the status of the biometry.