Skip to content

Commit 08243e9

Browse files
feat(biometrics): Improve Rust API docs (#1532)
* Improve Rust API docs * Add changes file
1 parent ac9a25c commit 08243e9

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"biometric": patch
3+
---
4+
5+
Provide more context to the `AuthOptions` in the Biometric Plugin for Rust API documentation.

plugins/biometric/src/models.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ use serde::{Deserialize, Serialize};
77
#[derive(Debug, Default, Serialize)]
88
#[serde(rename_all = "camelCase")]
99
pub struct AuthOptions {
10+
/// Enables authentication using the device's password. This feature is available on both Android and iOS.
1011
pub allow_device_credential: bool,
11-
/// iOS only.
12-
pub fallback_title: Option<String>,
13-
/// iOS only.
12+
/// Label for the Cancel button. This feature is available on both Android and iOS.
1413
pub cancel_title: Option<String>,
15-
/// Android only.
14+
/// Specifies the text displayed on the fallback button if biometric authentication fails. This feature is available iOS only.
15+
pub fallback_title: Option<String>,
16+
/// Title indicating the purpose of biometric verification. This feature is available Android only.
1617
pub title: Option<String>,
17-
/// Android only.
18+
/// SubTitle providing contextual information of biometric verification. This feature is available Android only.
1819
pub subtitle: Option<String>,
19-
/// Android only.
20+
/// Specifies whether additional user confirmation is required, such as pressing a button after successful biometric authentication. This feature is available Android only.
2021
pub confirmation_required: Option<bool>,
2122
}
2223

0 commit comments

Comments
 (0)