tauri-apps/archived-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-01-31 00:45:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(biometrics): Improve Rust API docs (#1532)

Browse Source 
* Improve Rust API docs

* Add changes file
This commit is contained in:
Naman Garg
2024-07-10 05:48:38 +05:30
committed by GitHub
parent ac9a25cc12
commit 08243e94c7
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.changes/biometric-auth-options-docs.md Normal file
View File

@@ -0,0 +1,5 @@
---
"biometric": patch
---
Provide more context to the `AuthOptions` in the Biometric Plugin for Rust API documentation.

13
plugins/biometric/src/models.rs
View File

@@ -7,16 +7,17 @@ use serde::{Deserialize, Serialize};
#[derive(Debug, Default, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AuthOptions {
/// Enables authentication using the device's password. This feature is available on both Android and iOS.
pub allow_device_credential: bool,
/// iOS only.
pub fallback_title: Option<String>,
/// iOS only.
/// Label for the Cancel button. This feature is available on both Android and iOS.
pub cancel_title: Option<String>,
/// Android only.
/// Specifies the text displayed on the fallback button if biometric authentication fails. This feature is available iOS only.
pub fallback_title: Option<String>,
/// Title indicating the purpose of biometric verification. This feature is available Android only.
pub title: Option<String>,
/// Android only.
/// SubTitle providing contextual information of biometric verification. This feature is available Android only.
pub subtitle: Option<String>,
/// Android only.
/// Specifies whether additional user confirmation is required, such as pressing a button after successful biometric authentication. This feature is available Android only.
pub confirmation_required: Option<bool>,
}