Saltar al contenido

@tauri-apps/plugin-notification

Envía notificaciones tipo toast (elemento breve de ventana del sistema operativo que expira automáticamente) a tu usuario. También se puede usar con la API web Notification.

Default: 3;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L293

High: 4;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L294

Low: 2;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L292

Min: 1;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L291

None: 0;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L290


Day: "day";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L165

Hour: "hour";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L166

Minute: "minute";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L167

Month: "month";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L162

Second: "second";

No soportado en iOS.

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L171

TwoWeeks: "twoWeeks";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L163

Week: "week";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L164

Year: "year";

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L161


Private: 0;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L299

Public: 1;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L300

Secret: -1;

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L298

new Schedule(): Schedule

Schedule

Propiedad Tipo Definido en
at undefined | object Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L175
every undefined | object Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L190
interval undefined | object Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L183

static at(
date,
repeating,
allowWhileIdle): Schedule
Parámetro Tipo Valor por defecto
date Date undefined
repeating boolean false
allowWhileIdle boolean false

Schedule

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L198

static every(
kind,
count,
allowWhileIdle): Schedule
Parámetro Tipo Valor por defecto
kind ScheduleEvery undefined
count number undefined
allowWhileIdle boolean false

Schedule

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L217

static interval(interval, allowWhileIdle): Schedule
Parámetro Tipo Valor por defecto
interval ScheduleInterval undefined
allowWhileIdle boolean false

Schedule

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L206

Propiedad Tipo Definido en
destructive? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L245
foreground? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L244
id string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L241
input? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L246
inputButtonTitle? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L247
inputPlaceholder? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L248
requiresAuthentication? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L243
title string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L242

Propiedad Tipo Descripción Definido en
actions Action[] La lista de acciones asociadas Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L259
allowInCarPlay? boolean - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L262
customDismissAction? boolean - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L261
hiddenPreviewsBodyPlaceholder? string - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L260
hiddenPreviewsShowSubtitle? boolean - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L264
hiddenPreviewsShowTitle? boolean - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L263
id string El identificador de este tipo de acción Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L255

Propiedad Tipo Definido en
actionTypeId? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L284
attachments Attachment[] Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L283
body? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L278
data Registro (Record)<string, string> Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L281
extra Registro (Record)<string, unknown> Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L282
group? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L279
groupSummary boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L280
id number Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L275
schedule? Schedule Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L285
sound? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L286
tag? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L276
title? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L277

Adjunto de una notificación.

Propiedad Tipo Descripción Definido en
id string Identificador del adjunto. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L235
url string URL del adjunto. Acepta los protocolos asset y file. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L237

Propiedad Tipo Definido en
description? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L306
id string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L304
importance? Importance Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L311
lightColor? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L309
lights? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L308
name string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L305
sound? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L307
vibration? boolean Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L310
visibility? Visibility Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L312

Opciones para enviar una notificación.

2.0.0

Propiedad Tipo Descripción Definido en
actionTypeId? string Define un tipo de acción para esta notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L62
attachments? Attachment[] Adjuntos de la notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L110
autoCancel? boolean Cancela automáticamente la notificación cuando el usuario hace clic en ella. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L126
body? string Cuerpo opcional de la notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L44
channelId? string Identificador del Channel que entrega esta notificación. Si el canal no existe, la notificación no se lanzará. Asegúrate de que el canal exista con listChannels y createChannel. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L36
extra? Registro (Record)<string, unknown> Payload adicional para almacenar en la notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L114
group? string Identificador utilizado para agrupar múltiples notificaciones. https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/1649872-threadidentifier Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L68
groupSummary? boolean Instruye al sistema que esta notificación es el resumen de un grupo en Android. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L72
icon? string Icono de la notificación. En Android el icono debe colocarse en la carpeta res/drawable de la app. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L96
iconColor? string Color del icono en Android. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L106
id? number El identificador de la notificación para hacer referencia a este objeto más adelante. Debe ser un entero de 32 bits. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L29
inboxLines? string[] Lista de líneas para agregar a la notificación. Cambia el estilo de la notificación a inbox. No se puede usar con largeBody. Solo admite hasta 5 líneas. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L90
largeBody? string Texto multilínea. Cambia el estilo de la notificación a texto grande (big text). No se puede usar con inboxLines. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L54
largeIcon? string Icono grande de la notificación (Android). El icono debe colocarse en la carpeta res/drawable de la app. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L102
number? number Establece la cantidad de elementos que representa esta notificación en Android. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L138
ongoing? boolean Si es true, el usuario no puede descartar la notificación en Android. Un servicio de la aplicación debe gestionar el descarte de la notificación. Generalmente se usa para indicar una tarea en segundo plano pendiente (p. ej. la descarga de un archivo) o en la que el usuario está participando (p. ej. reproducir música). Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L122
schedule? Schedule Programa esta notificación para que se lance más adelante o en un intervalo fijo. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L48
silent? boolean Cambia la presentación de la notificación para que sea silenciosa en iOS (sin globo, sin sonido, no listada). Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L130
sound? string El nombre del recurso de sonido o la ruta del archivo para la notificación. Comportamiento específico por plataforma: - En macOS: usa sonidos del sistema (p. ej., “Ping”, “Blow”) o archivos de sonido en el bundle de la app - En Linux: usa sonidos del tema XDG (p. ej., “message-new-instant”) o rutas de archivo - En Windows: usa rutas de archivo a archivos de sonido (formato .wav) - En dispositivos móviles: usa nombres de recursos Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L82
summary? string Texto de detalle para la notificación con largeBody, inboxLines o groupSummary. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L58
title string Título de la notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L40
visibility? Visibility Visibilidad de la notificación. Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L134

Propiedad Tipo Definido en
body? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L270
id number Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L268
schedule Schedule Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L271
title? string Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L269

Propiedad Tipo Descripción Definido en
day? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L144
hour? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L155
minute? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L156
month? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L143
second? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L157
weekday? number 1 - Domingo 2 - Lunes 3 - Martes 4 - Miércoles 5 - Jueves 6 - Viernes 7 - Sábado Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L154
year? number - Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L142

type PermissionState: "granted" | "denied" | "prompt" | "prompt-with-rationale";

Origen: undefined

function active(): Promise<ActiveNotification[]>

Recupera la lista de notificaciones activas.

Promise<ActiveNotification[]>

Una promesa que se resuelve con la lista de notificaciones activas.

import { active } from '@tauri-apps/plugin-notification';
const activeNotifications = await active();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L465


function cancel(notifications): Promise<void>

Cancela las notificaciones pendientes con la lista dada de identificadores.

Parámetro Tipo
notifications number[]

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { cancel } from '@tauri-apps/plugin-notification';
await cancel([-34234, 23432, 4311]);

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L431


function cancelAll(): Promise<void>

Cancela todas las notificaciones pendientes.

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { cancelAll } from '@tauri-apps/plugin-notification';
await cancelAll();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L448


function channels(): Promise<Channel[]>

Recupera la lista de canales de notificación.

Promise<Channel[]>

Una promesa que se resuelve con la lista de canales de notificación.

import { channels } from '@tauri-apps/plugin-notification';
const notificationChannels = await channels();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L559


function createChannel(channel): Promise<void>

Crea un canal de notificación.

Parámetro Tipo
channel Channel

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
await createChannel({
id: 'new-messages',
name: 'New Messages',
lights: true,
vibration: true,
importance: Importance.Default,
visibility: Visibility.Private
});

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L525


function isPermissionGranted(): Promise<boolean>

Comprueba si se ha concedido el permiso para enviar notificaciones.

Promise<boolean>

import { isPermissionGranted } from '@tauri-apps/plugin-notification';
const permissionGranted = await isPermissionGranted();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L325


function onAction(cb): Promise<PluginListener>
Parámetro Tipo
cb (notification) => void

Promise<PluginListener>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L569


function onNotificationReceived(cb): Promise<PluginListener>
Parámetro Tipo
cb (notification) => void

Promise<PluginListener>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L563


function pending(): Promise<PendingNotification[]>

Recupera la lista de notificaciones pendientes.

Promise<PendingNotification[]>

Una promesa que se resuelve con la lista de notificaciones pendientes.

import { pending } from '@tauri-apps/plugin-notification';
const pendingNotifications = await pending();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L414


function registerActionTypes(types): Promise<void>

Registra las acciones que se realizan cuando el usuario hace clic en la notificación.

Parámetro Tipo
types ActionType[]

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { registerActionTypes } from '@tauri-apps/plugin-notification';
await registerActionTypes([{
id: 'tauri',
actions: [{
id: 'my-action',
title: 'Settings'
}]
}])

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L397


function removeActive(notifications): Promise<void>

Elimina las notificaciones activas con la lista dada de identificadores.

Parámetro Tipo
notifications object[]

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { cancel } from '@tauri-apps/plugin-notification';
await cancel([-34234, 23432, 4311])

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L482


function removeAllActive(): Promise<void>

Elimina todas las notificaciones activas.

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { removeAllActive } from '@tauri-apps/plugin-notification';
await removeAllActive()

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L501


function removeChannel(id): Promise<void>

Elimina el canal con el identificador dado.

Parámetro Tipo
id string

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

import { removeChannel } from '@tauri-apps/plugin-notification';
await removeChannel();

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L542


function requestPermission(): Promise<NotificationPermission>

Solicita el permiso para enviar notificaciones.

Promise<NotificationPermission>

Una promesa que se resuelve indicando si el usuario concedió el permiso o no.

import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
let permissionGranted = await isPermissionGranted();
if (!permissionGranted) {
const permission = await requestPermission();
permissionGranted = permission === 'granted';
}

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L348


function sendNotification(options): void

Envía una notificación al usuario.

Parámetro Tipo
options string | Opciones

void

import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
let permissionGranted = await isPermissionGranted();
if (!permissionGranted) {
const permission = await requestPermission();
permissionGranted = permission === 'granted';
}
if (permissionGranted) {
sendNotification('Tauri is awesome!');
sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
}

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L370


© 2026 Colaboradores de Tauri. CC-BY / MIT