@tauri-apps/plugin-deep-link

函数

getCurrent()

function getCurrent(): Promise<string[] | null>

获取触发深度链接的当前 URL。在应用加载时使用此功能，以检查您的应用是否通过深度链接启动。

返回

Promise<string[] | null>

示例

import { getCurrent } from '@tauri-apps/plugin-deep-link';
const urls = await getCurrent();

- **Windows / Linux**: 此函数读取命令行参数，并检查是否只有一个值，该值必须是与配置值之一匹配的方案的 URL。

请注意，使用 [Self::register] 动态注册深度链接方案时，您必须手动检查参数。此外，深度链接可能作为 CLI 参数提供，因此您应该检查其格式是否符合您的预期。

始于

2.0.0

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L23

---

isRegistered()

function isRegistered(protocol): Promise<boolean>

检查应用程序是否是指定协议的默认处理程序。

参数

参数	类型	描述
协议	字符串	不带 :// 的协议名称。

返回

Promise<boolean>

示例

import { isRegistered } from '@tauri-apps/plugin-deep-link';
await isRegistered("my-scheme");

- **macOS / Android / iOS**: 不支持。

始于

2.0.0

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L80

---

onOpenUrl()

function onOpenUrl(handler): Promise<UnlistenFn>

deep-link://new-url 事件的辅助函数，用于在应用程序运行时每次触发协议时运行一个函数。在应用程序加载时使用 getCurrent 检查应用程序是否通过深度链接启动。

参数

参数	类型
处理程序	(urls) => void

返回

Promise<UnlistenFn>

示例

import { onOpenUrl } from '@tauri-apps/plugin-deep-link';
await onOpenUrl((urls) => { console.log(urls) });

- **Windows / Linux**: 没有 single-instance 插件时不支持。操作系统将生成一个新的应用程序实例，并将 URL 作为 CLI 参数传递。

始于

2.0.0

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L99

---

register()

function register(protocol): Promise<null>

将应用程序注册为指定协议的默认处理程序。

参数

参数	类型	描述
协议	字符串	不带 :// 的协议名称。例如，如果您想让您的应用程序处理 tauri:// 链接，请将此方法与 tauri 作为协议进行调用。

返回

Promise<null>

示例

import { register } from '@tauri-apps/plugin-deep-link';
await register("my-scheme");

- **macOS / Android / iOS**: 不支持。

始于

2.0.0

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L42

---

unregister()

function unregister(protocol): Promise<null>

将应用程序取消注册为指定协议的默认处理程序。

参数

参数	类型	描述
协议	字符串	不带 :// 的协议名称。

返回

Promise<null>

示例

import { unregister } from '@tauri-apps/plugin-deep-link';
await unregister("my-scheme");

- **macOS / Linux / Android / iOS**: 不支持。

始于

2.0.0

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/deep-link/guest-js/index.ts#L61