@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.
Enumeraciones
Sección titulada «Enumeraciones»Importance
Sección titulada “Importance”Miembros de enumeraciones
Sección titulada «Miembros de enumeraciones»Por defecto
Sección titulada «Default»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
Ninguno
Sección titulada «None»None: 0;Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L290
ScheduleEvery
Sección titulada “ScheduleEvery”Miembros de enumeraciones
Sección titulada «Miembros de enumeraciones»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
Sección titulada “TwoWeeks”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
Visibility
Sección titulada “Visibility”Miembros de enumeraciones
Sección titulada «Miembros de enumeraciones»Private
Sección titulada “Private”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
Schedule
Sección titulada “Schedule”Constructores
Sección titulada «Constructores»new Schedule()
Sección titulada “new Schedule()”new Schedule(): ScheduleDevuelve
Sección titulada «Devuelve»Propiedades
Sección titulada «Propiedades»| 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 |
Métodos
Sección titulada «Métodos»static at( date, repeating, allowWhileIdle): ScheduleParámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Valor por defecto |
|---|---|---|
date |
Date |
undefined |
repeating |
boolean |
false |
allowWhileIdle |
boolean |
false |
Devuelve
Sección titulada «Devuelve»Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L198
every()
Sección titulada “every()”static every( kind, count, allowWhileIdle): ScheduleParámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Valor por defecto |
|---|---|---|
kind |
ScheduleEvery |
undefined |
count |
number |
undefined |
allowWhileIdle |
boolean |
false |
Devuelve
Sección titulada «Devuelve»Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L217
interval()
Sección titulada “interval()”static interval(interval, allowWhileIdle): ScheduleParámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Valor por defecto |
|---|---|---|
interval |
ScheduleInterval |
undefined |
allowWhileIdle |
boolean |
false |
Devuelve
Sección titulada «Devuelve»Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L206
Interfaces
Sección titulada «Interfaces»Propiedades
Sección titulada «Propiedades»ActionType
Sección titulada “ActionType”Propiedades
Sección titulada «Propiedades»ActiveNotification
Sección titulada “ActiveNotification”Propiedades
Sección titulada «Propiedades»Attachment
Sección titulada “Attachment”Adjunto de una notificación.
Propiedades
Sección titulada «Propiedades»| 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 |
Channel
Sección titulada “Channel”Propiedades
Sección titulada «Propiedades»Opciones
Sección titulada “Options”Opciones para enviar una notificación.
2.0.0
Propiedades
Sección titulada «Propiedades»| 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 |
PendingNotification
Sección titulada “PendingNotification”Propiedades
Sección titulada «Propiedades»| 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 |
ScheduleInterval
Sección titulada “ScheduleInterval”Propiedades
Sección titulada «Propiedades»| 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 |
Alias de tipos
Sección titulada «Alias de tipos»PermissionState
Sección titulada «PermissionState»type PermissionState: "granted" | "denied" | "prompt" | "prompt-with-rationale";Origen: undefined
Funciones
Sección titulada «Funciones»active()
Sección titulada “active()”function active(): Promise<ActiveNotification[]>Recupera la lista de notificaciones activas.
Devuelve
Sección titulada «Devuelve»Una promesa que se resuelve con la lista de notificaciones activas.
Ejemplo
Sección titulada «Ejemplo»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
cancel()
Sección titulada «cancel()»function cancel(notifications): Promise<void>Cancela las notificaciones pendientes con la lista dada de identificadores.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
notifications |
number[] |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
cancelAll()
Sección titulada “cancelAll()”function cancelAll(): Promise<void>Cancela todas las notificaciones pendientes.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
channels()
Sección titulada “channels()”function channels(): Promise<Channel[]>Recupera la lista de canales de notificación.
Devuelve
Sección titulada «Devuelve»Una promesa que se resuelve con la lista de canales de notificación.
Ejemplo
Sección titulada «Ejemplo»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
createChannel()
Sección titulada “createChannel()”function createChannel(channel): Promise<void>Crea un canal de notificación.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
channel |
Channel |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
isPermissionGranted()
Sección titulada “isPermissionGranted()”function isPermissionGranted(): Promise<boolean>Comprueba si se ha concedido el permiso para enviar notificaciones.
Devuelve
Sección titulada «Devuelve»Promise<boolean>
Ejemplo
Sección titulada «Ejemplo»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
onAction()
Sección titulada “onAction()”function onAction(cb): Promise<PluginListener>Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
cb |
(notification) => void |
Devuelve
Sección titulada «Devuelve»Promise<PluginListener>
Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L569
onNotificationReceived()
Sección titulada “onNotificationReceived()”function onNotificationReceived(cb): Promise<PluginListener>Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
cb |
(notification) => void |
Devuelve
Sección titulada «Devuelve»Promise<PluginListener>
Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L563
pending()
Sección titulada “pending()”function pending(): Promise<PendingNotification[]>Recupera la lista de notificaciones pendientes.
Devuelve
Sección titulada «Devuelve»Promise<PendingNotification[]>
Una promesa que se resuelve con la lista de notificaciones pendientes.
Ejemplo
Sección titulada «Ejemplo»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
registerActionTypes()
Sección titulada “registerActionTypes()”function registerActionTypes(types): Promise<void>Registra las acciones que se realizan cuando el usuario hace clic en la notificación.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
types |
ActionType[] |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
removeActive()
Sección titulada “removeActive()”function removeActive(notifications): Promise<void>Elimina las notificaciones activas con la lista dada de identificadores.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
notifications |
object[] |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
removeAllActive()
Sección titulada “removeAllActive()”function removeAllActive(): Promise<void>Elimina todas las notificaciones activas.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
removeChannel()
Sección titulada “removeChannel()”function removeChannel(id): Promise<void>Elimina el canal con el identificador dado.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
id |
string |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»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
requestPermission()
Sección titulada “requestPermission()”function requestPermission(): Promise<NotificationPermission>Solicita el permiso para enviar notificaciones.
Devuelve
Sección titulada «Devuelve»Promise<NotificationPermission>
Una promesa que se resuelve indicando si el usuario concedió el permiso o no.
Ejemplo
Sección titulada «Ejemplo»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
sendNotification()
Sección titulada “sendNotification()”function sendNotification(options): voidEnvía una notificación al usuario.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
options |
string | Opciones |
Devuelve
Sección titulada «Devuelve»void
Ejemplo
Sección titulada «Ejemplo»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