Skip to content

Commit 949e2d6

Browse files
committed
chore: update docs
1 parent 64a6240 commit 949e2d6

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
"deep-link": patch
3+
"deep-link-js": patch
34
---
45

56
Implement `get_current` on Linux and Windows.

plugins/deep-link/guest-js/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ import { type UnlistenFn, listen } from '@tauri-apps/api/event'
1414
* const urls = await getCurrent();
1515
* ```
1616
*
17-
* #### - **Windows / Linux**: Unsupported.
17+
* #### - **Windows / Linux**: This function reads the command line arguments and checks if there's only one value, which must be an URL with scheme matching one of the configured values.
18+
* Note that you must manually check the arguments when registering deep link schemes dynamically with [`Self::register`].
19+
* Additionally, the deep link might have been provided as a CLI argument so you should check if its format matches what you expect..
1820
*
1921
* @since 2.0.0
2022
*/

plugins/deep-link/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ mod imp {
108108

109109
impl<R: Runtime> DeepLink<R> {
110110
/// Get the current URLs that triggered the deep link. Use this on app load to check whether your app was started via a deep link.
111+
///
112+
/// ## Platform-specific:
113+
///
114+
/// - **Windows / Linux**: This function reads the command line arguments and checks if there's only one value, which must be an URL with scheme matching one of the configured values.
115+
/// Note that you must manually check the arguments when registering deep link schemes dynamically with [`Self::register`].
116+
/// Additionally, the deep link might have been provided as a CLI argument so you should check if its format matches what you expect.
111117
pub fn get_current(&self) -> crate::Result<Option<Vec<url::Url>>> {
112118
self.0
113119
.run_mobile_plugin::<GetCurrentResponse>("getCurrent", ())

0 commit comments

Comments
 (0)