@tauri-apps/plugin-biometric

Enumeraciones

BiometryType

Miembros de enumeraciones

FaceID

FaceID: 2;

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

Iris

Iris: 3;

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

Ninguno

None: 0;

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

TouchID

TouchID: 1;

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

Interfaces

AuthOptions

Propiedades

Propiedad	Tipo	Definido en
allowDeviceCredential?	boolean	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L36
cancelTitle?	string	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L37
confirmationRequired?	boolean	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L45
fallbackTitle?	string	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L40
maxAttemps?	number	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L46
subtitle?	string	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L44
title?	string	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L43

---

Status

Propiedades

Propiedad	Tipo	Definido en
biometryType	BiometryType	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L19
error?	string	Origen: 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"	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L21
isAvailable	boolean	Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L18

Funciones

authenticate()

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

Solicita autenticación al usuario mediante la interfaz del sistema (touchID, faceID o Android Iris). Se rechaza si la autenticación falla.

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

Parámetros

Parámetro	Tipo	Descripción
reason	string
options?	AuthOptions

Devuelve

Promise<void>

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

---

checkStatus()

function checkStatus(): Promise<Status>

Comprueba si la autenticación biométrica está disponible.

Devuelve

Promise<Status>

una promesa que se resuelve con un objeto que contiene toda la información sobre el estado de la biometría.

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