@tauri-apps/plugin-deep-link

Funciones

getCurrent()

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

Obtén las URL actuales que activaron el deep link. Usa esto al cargar la aplicación para comprobar si tu aplicación se inició mediante un deep link.

Devuelve

Promise<string[] | null>

Ejemplo

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

Específico de la plataforma

• Windows / Linux: Esta función lee los argumentos de la línea de comandos y comprueba si solo hay un valor, el cual debe ser una URL con un esquema que coincida con uno de los valores configurados. Ten en cuenta que debes comprobar manualmente los argumentos al registrar esquemas de deep link dinámicamente con [Self::register]. Además, el deep link podría haberse proporcionado como un argumento CLI, por lo que deberías comprobar si su formato coincide con lo que esperas.

Desde

2.0.0

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

---

isRegistered()

function isRegistered(protocol): Promise<boolean>

Comprueba si la aplicación es el manejador predeterminado para el protocolo especificado.

Parámetros

Parámetro	Tipo	Descripción
protocol	string	El nombre del protocolo sin ://.

Devuelve

Promise<boolean>

Ejemplo

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

Específico de la plataforma

• macOS / Android / iOS: No soportado.

Desde

2.0.0

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

---

onOpenUrl()

function onOpenUrl(handler): Promise<UnlistenFn>

Función auxiliar para el evento deep-link://new-url para ejecutar una función cada vez que se activa el protocolo mientras la aplicación está en ejecución. Usa getCurrent al cargar la aplicación para comprobar si tu aplicación se inició mediante un deep link.

Parámetros

Parámetro	Tipo
handler	(urls) => void

Devuelve

Promise<UnlistenFn>

Ejemplo

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

Específico de la plataforma

• Windows / Linux: No soportado sin el plugin de instancia única (single-instance). El SO creará una nueva instancia de la aplicación pasando la URL como argumento CLI.

Desde

2.0.0

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

---

register()

function register(protocol): Promise<null>

Registra la aplicación como el manejador predeterminado para el protocolo especificado.

Parámetros

Parámetro	Tipo	Descripción
protocol	string	El nombre del protocolo sin ://. Por ejemplo, si quieres que tu aplicación maneje enlaces tauri://, llama a este método con tauri como protocolo.

Devuelve

Promise<null>

Ejemplo

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

Específico de la plataforma

• macOS / Android / iOS: No soportado.

Desde

2.0.0

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

---

unregister()

function unregister(protocol): Promise<null>

Anula el registro de la aplicación como el manejador predeterminado para el protocolo especificado.

Parámetros

Parámetro	Tipo	Descripción
protocol	string	El nombre del protocolo sin ://.

Devuelve

Promise<null>

Ejemplo

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

Específico de la plataforma

• macOS / Linux / Android / iOS: No soportado.

Desde

2.0.0

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