@tauri-apps/plugin-deep-link
Functions
getCurrent()
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.
Returns
Promise
<string
[] | null
>
Example
- Windows / Linux: Unsupported.
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L21
isRegistered()
Check whether the app is the default handler for the specified protocol.
Parameters
Parameter | Type | Description |
---|---|---|
protocol | string | The name of the protocol without :// . |
Returns
Promise
<boolean
>
Example
- macOS / Android / iOS: Unsupported, always returns true
.
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L78
onOpenUrl()
Helper function for the deep-link://new-url
event to run a function each time the protocol is triggered while the app is running. Use getCurrent
on app load to check whether your app was started via a deep link.
Parameters
Parameter | Type |
---|---|
handler | (urls ) => void |
Returns
Promise
<UnlistenFn
>
Example
- Windows / Linux: Unsupported, the OS will spawn a new app instance passing the URL as a CLI argument.
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L97
register()
Register the app as the default handler for the specified protocol.
Parameters
Parameter | Type | Description |
---|---|---|
protocol | string | The name of the protocol without :// . For example, if you want your app to handle tauri:// links, call this method with tauri as the protocol. |
Returns
Promise
<null
>
Example
- macOS / Android / iOS: Unsupported.
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L40
unregister()
Unregister the app as the default handler for the specified protocol.
Parameters
Parameter | Type | Description |
---|---|---|
protocol | string | The name of the protocol without :// . |
Returns
Promise
<null
>
Example
- macOS / Linux / Android / iOS: Unsupported.
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L59
© 2024 Tauri Contributors. CC-BY / MIT