@tauri-apps/plugin-biometric

Enumerations

BiometryType

Defined in: plugins/biometric/guest-js/index.ts:7

Enumeration Members

FaceID

FaceID: 2;

Defined in: plugins/biometric/guest-js/index.ts:12

Iris

Iris: 3;

Defined in: plugins/biometric/guest-js/index.ts:14

None

None: 0;

Defined in: plugins/biometric/guest-js/index.ts:8

TouchID

TouchID: 1;

Defined in: plugins/biometric/guest-js/index.ts:10

Interfaces

AuthOptions

Defined in: plugins/biometric/guest-js/index.ts:35

Properties

Property	Type	Defined in
allowDeviceCredential?	boolean	plugins/biometric/guest-js/index.ts:36
cancelTitle?	string	plugins/biometric/guest-js/index.ts:37
confirmationRequired?	boolean	plugins/biometric/guest-js/index.ts:45
fallbackTitle?	string	plugins/biometric/guest-js/index.ts:40
maxAttemps?	number	plugins/biometric/guest-js/index.ts:46
subtitle?	string	plugins/biometric/guest-js/index.ts:44
title?	string	plugins/biometric/guest-js/index.ts:43

---

Status

Defined in: plugins/biometric/guest-js/index.ts:17

Properties

Property	Type	Defined in
biometryType	BiometryType	plugins/biometric/guest-js/index.ts:19
error?	string	plugins/biometric/guest-js/index.ts:20
errorCode?	| "appCancel" | "authenticationFailed" | "invalidContext" | "notInteractive" | "passcodeNotSet" | "systemCancel" | "userCancel" | "userFallback" | "biometryLockout" | "biometryNotAvailable" | "biometryNotEnrolled"	plugins/biometric/guest-js/index.ts:21
isAvailable	boolean	plugins/biometric/guest-js/index.ts:18

Functions

authenticate()

function authenticate(reason, options?): Promise<void>;

Defined in: plugins/biometric/guest-js/index.ts:69

Prompts the user for authentication using the system interface (touchID, faceID or Android Iris). Rejects if the authentication fails.

import { authenticate } from "@tauri-apps/plugin-biometric";
await authenticate('Open your wallet');

Parameters

Parameter	Type	Description
reason	string	-
options?	AuthOptions	-

Returns

Promise<void>

---

checkStatus()

function checkStatus(): Promise<Status>;

Defined in: plugins/biometric/guest-js/index.ts:53

Checks if the biometric authentication is available.

Returns

Promise<Status>

a promise resolving to an object containing all the information about the status of the biometry.