@tauri-apps/plugin-biometric
Enumerations
BiometryType
Enumeration Members
FaceID
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L12
Iris
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L14
None
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L8
TouchID
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L10
Interfaces
AuthOptions
Properties
Property | Type |
---|---|
allowDeviceCredential? | boolean |
cancelTitle? | string |
confirmationRequired? | boolean |
fallbackTitle? | string |
maxAttemps? | number |
subtitle? | string |
title? | string |
Status
Properties
Property | Type |
---|---|
biometryType | BiometryType |
error? | string |
errorCode? | | "appCancel" | "authenticationFailed" | "invalidContext" | "notInteractive" | "passcodeNotSet" | "systemCancel" | "userCancel" | "userFallback" | "biometryLockout" | "biometryNotAvailable" | "biometryNotEnrolled" |
isAvailable | boolean |
Functions
authenticate()
Prompts the user for authentication using the system interface (touchID, faceID or Android Iris). Rejects if the authentication fails.
Parameters
Parameter | Type | Description |
---|---|---|
reason | string | |
options ? | AuthOptions |
Returns
Promise
<void
>
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L69
checkStatus()
Checks if the biometric authentication is available.
Returns
a promise resolving to an object containing all the information about the status of the biometry.
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/biometric/guest-js/index.ts#L53
© 2024 Tauri Contributors. CC-BY / MIT