@tauri-apps/plugin-biometric

枚举

生物识别类型

枚举成员

FaceID

FaceID: 2;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L12

虹膜

Iris: 3;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L14

无

None: 0;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L8

TouchID

TouchID: 1;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L10

接口

AuthOptions

属性

属性	类型	定义于
allowDeviceCredential?	布尔值	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L36
cancelTitle?	字符串	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L37
confirmationRequired?	布尔值	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L45
fallbackTitle?	字符串	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L40
maxAttemps?	数字	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L46
subtitle?	字符串	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L44
title?	字符串	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L43

---

状态

属性

属性	类型	定义于
biometryType	生物识别类型	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L19
error?	字符串	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L20
errorCode?	| "appCancel" | "authenticationFailed" | "invalidContext" | "notInteractive" | "passcodeNotSet" | "systemCancel" | "userCancel" | "userFallback" | "biometryLockout" | "biometryNotAvailable" | "biometryNotEnrolled"	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L21
isAvailable	布尔值	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L18

函数

authenticate()

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

提示用户使用系统界面（TouchID、FaceID 或 Android 虹膜）进行身份验证。如果身份验证失败，则拒绝。

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

参数

参数	类型	描述
reason	字符串
options?	AuthOptions

返回值

Promise<void>

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L69

---

checkStatus()

function checkStatus(): Promise<Status>

检查生物识别身份验证是否可用。

返回值

Promise<Status>

一个 Promise，解析为一个包含生物识别状态所有信息的对象。

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L53