@tauri-apps/plugin-notification

Send toast notifications (brief auto-expiring OS window element) to your user. Can also be used with the Notification Web API.

Enumerations

Importance

Enumeration Members

Default

Default: 3;

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

High

High: 4;

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

Low

Low: 2;

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

Min

Min: 1;

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

None

None: 0;

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

---

ScheduleEvery

Enumeration Members

Day

Day: "day";

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

Hour

Hour: "hour";

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

Minute

Minute: "minute";

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

Month

Month: "month";

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

Second

Second: "second";

Not supported on iOS.

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

TwoWeeks

TwoWeeks: "twoWeeks";

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

Week

Week: "week";

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

Year

Year: "year";

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

---

Visibility

Enumeration Members

Private

Private: 0;

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

Public

Public: 1;

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

Secret

Secret: -1;

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

Classes

Schedule

Constructors

new Schedule()

new Schedule(): Schedule

Returns

Schedule

Properties

Property	Type
at	undefined | object
every	undefined | object
interval	undefined | object

Methods

at()

static at(
   date,
   repeating,
   allowWhileIdle): Schedule

Parameters

Parameter	Type	Default value
date	Date	undefined
repeating	boolean	false
allowWhileIdle	boolean	false

Returns

Schedule

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

every()

static every(
   kind,
   count,
   allowWhileIdle): Schedule

Parameters

Parameter	Type	Default value
kind	ScheduleEvery	undefined
count	number	undefined
allowWhileIdle	boolean	false

Returns

Schedule

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

interval()

static interval(interval, allowWhileIdle): Schedule

Parameters

Parameter	Type	Default value
interval	ScheduleInterval	undefined
allowWhileIdle	boolean	false

Returns

Schedule

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

Interfaces

Action

Properties

Property	Type
destructive?	boolean
foreground?	boolean
id	string
input?	boolean
inputButtonTitle?	string
inputPlaceholder?	string
requiresAuthentication?	boolean
title	string

---

ActionType

Properties

Property	Type	Description
actions	Action[]	The list of associated actions
allowInCarPlay?	boolean	-
customDismissAction?	boolean	-
hiddenPreviewsBodyPlaceholder?	string	-
hiddenPreviewsShowSubtitle?	boolean	-
hiddenPreviewsShowTitle?	boolean	-
id	string	The identifier of this action type

---

ActiveNotification

Properties

Property	Type
actionTypeId?	string
attachments	Attachment[]
body?	string
data	Record<string, string>
extra	Record<string, unknown>
group?	string
groupSummary	boolean
id	number
schedule?	Schedule
sound?	string
tag?	string
title?	string

---

Attachment

Attachment of a notification.

Properties

Property	Type	Description
id	string	Attachment identifier.
url	string	Attachment URL. Accepts the asset and file protocols.

---

Channel

Properties

Property	Type
description?	string
id	string
importance?	Importance
lightColor?	string
lights?	boolean
name	string
sound?	string
vibration?	boolean
visibility?	Visibility

---

Options

Options to send a notification.

Since

2.0.0

Properties

Property	Type	Description
actionTypeId?	string	Defines an action type for this notification.
attachments?	Attachment[]	Notification attachments.
autoCancel?	boolean	Automatically cancel the notification when the user clicks on it.
body?	string	Optional notification body.
channelId?	string	Identifier of the Channel that deliveres this notification. If the channel does not exist, the notification won’t fire. Make sure the channel exists with listChannels and createChannel.
extra?	Record<string, unknown>	Extra payload to store in the notification.
group?	string	Identifier used to group multiple notifications. https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/1649872-threadidentifier
groupSummary?	boolean	Instructs the system that this notification is the summary of a group on Android.
icon?	string	Notification icon. On Android the icon must be placed in the app’s res/drawable folder.
iconColor?	string	Icon color on Android.
id?	number	The notification identifier to reference this object later. Must be a 32-bit integer.
inboxLines?	string[]	List of lines to add to the notification. Changes the notification style to inbox. Cannot be used with largeBody. Only supports up to 5 lines.
largeBody?	string	Multiline text. Changes the notification style to big text. Cannot be used with inboxLines.
largeIcon?	string	Notification large icon (Android). The icon must be placed in the app’s res/drawable folder.
number?	number	Sets the number of items this notification represents on Android.
ongoing?	boolean	If true, the notification cannot be dismissed by the user on Android. An application service must manage the dismissal of the notification. It is typically used to indicate a background task that is pending (e.g. a file download) or the user is engaged with (e.g. playing music).
schedule?	Schedule	Schedule this notification to fire on a later time or a fixed interval.
silent?	boolean	Changes the notification presentation to be silent on iOS (no badge, no sound, not listed).
sound?	string	The sound resource name. Only available on mobile.
summary?	string	Detail text for the notification with largeBody, inboxLines or groupSummary.
title	string	Notification title.
visibility?	Visibility	Notification visibility.

---

PendingNotification

Properties

Property	Type
body?	string
id	number
schedule	Schedule
title?	string

---

ScheduleInterval

Properties

Property	Type	Description
day?	number	-
hour?	number	-
minute?	number	-
month?	number	-
second?	number	-
weekday?	number	1 - Sunday 2 - Monday 3 - Tuesday 4 - Wednesday 5 - Thursday 6 - Friday 7 - Saturday
year?	number	-

Type Aliases

PermissionState

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

Source: undefined

Functions

active()

function active(): Promise<ActiveNotification[]>

Retrieves the list of active notifications.

Returns

Promise<ActiveNotification[]>

A promise resolving to the list of active notifications.

Example

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

Since

2.0.0

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

---

cancel()

function cancel(notifications): Promise<void>

Cancels the pending notifications with the given list of identifiers.

Parameters

Parameter	Type
notifications	number[]

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

cancelAll()

function cancelAll(): Promise<void>

Cancels all pending notifications.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

channels()

function channels(): Promise<Channel[]>

Retrieves the list of notification channels.

Returns

Promise<Channel[]>

A promise resolving to the list of notification channels.

Example

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

Since

2.0.0

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

---

createChannel()

function createChannel(channel): Promise<void>

Creates a notification channel.

Parameters

Parameter	Type
channel	Channel

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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
});

Since

2.0.0

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

---

isPermissionGranted()

function isPermissionGranted(): Promise<boolean>

Checks if the permission to send notifications is granted.

Returns

Promise<boolean>

Example

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

Since

2.0.0

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

---

onAction()

function onAction(cb): Promise<PluginListener>

Parameters

Parameter	Type
cb	(notification) => void

Returns

Promise<PluginListener>

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

---

onNotificationReceived()

function onNotificationReceived(cb): Promise<PluginListener>

Parameters

Parameter	Type
cb	(notification) => void

Returns

Promise<PluginListener>

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

---

pending()

function pending(): Promise<PendingNotification[]>

Retrieves the list of pending notifications.

Returns

Promise<PendingNotification[]>

A promise resolving to the list of pending notifications.

Example

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

Since

2.0.0

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

---

registerActionTypes()

function registerActionTypes(types): Promise<void>

Register actions that are performed when the user clicks on the notification.

Parameters

Parameter	Type
types	ActionType[]

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

removeActive()

function removeActive(notifications): Promise<void>

Removes the active notifications with the given list of identifiers.

Parameters

Parameter	Type
notifications	object[]

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

removeAllActive()

function removeAllActive(): Promise<void>

Removes all active notifications.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

removeChannel()

function removeChannel(id): Promise<void>

Removes the channel with the given identifier.

Parameters

Parameter	Type
id	string

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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

---

requestPermission()

function requestPermission(): Promise<NotificationPermission>

Requests the permission to send notifications.

Returns

Promise<NotificationPermission>

A promise resolving to whether the user granted the permission or not.

Example

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

Since

2.0.0

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

---

sendNotification()

function sendNotification(options): void

Sends a notification to the user.

Parameters

Parameter	Type
options	string | Options

Returns

void

Example

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!' });
}

Since

2.0.0

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