跳到内容
Tauri

@tauri-apps/plugin-notification

向用户发送 Toast 通知(短暂自动消失的操作系统窗口元素)。也可与 Notification Web API 配合使用。

Default: 3;

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

High: 4;

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

Low: 2;

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

Min: 1;

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

None: 0;

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


Day: "day";

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

Hour: "hour";

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

Minute: "minute";

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

Month: "month";

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

Second: "second";

iOS 不支持。

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

TwoWeeks: "twoWeeks";

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

Week: "week";

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

Year: "year";

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


Private: 0;

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

Public: 1;

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

Secret: -1;

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

new Schedule(): Schedule

计划

属性类型定义于
atundefined | object来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L169
everyundefined | object来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L184
intervalundefined | object来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L177

static at(
date,
repeating,
allowWhileIdle): Schedule
参数类型默认值
日期日期未定义
重复布尔值 (boolean)false
allowWhileIdle布尔值 (boolean)false

计划

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

static every(
kind,
count,
allowWhileIdle): Schedule
参数类型默认值
类型ScheduleEvery未定义
计数数字未定义
allowWhileIdle布尔值 (boolean)false

计划

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

static interval(interval, allowWhileIdle): Schedule
参数类型默认值
间隔ScheduleInterval未定义
allowWhileIdle布尔值 (boolean)false

计划

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

属性类型定义于
destructive?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L239
foreground?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L238
id字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L235
input?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L240
inputButtonTitle?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L241
inputPlaceholder?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L242
requiresAuthentication?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L237
title字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L236

属性类型描述定义于
actions操作[]关联动作列表来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L253
allowInCarPlay?布尔值 (boolean)-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L256
customDismissAction?布尔值 (boolean)-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L255
hiddenPreviewsBodyPlaceholder?字符串-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L254
hiddenPreviewsShowSubtitle?布尔值 (boolean)-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L258
hiddenPreviewsShowTitle?布尔值 (boolean)-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L257
id字符串此动作类型的标识符来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L249

属性类型定义于
actionTypeId?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L278
attachmentsAttachment[]来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L277
body?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L272
dataRecord<string, string>来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L275
extraRecord<string, unknown>来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L276
group?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L273
groupSummary布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L274
id数字来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L269
schedule?计划来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L279
sound?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L280
tag?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L270
title?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L271

通知附件。

属性类型描述定义于
id字符串附件标识符。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L229
url字符串附件 URL。支持 assetfile 协议。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L231

属性类型定义于
description?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L300
id字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L298
importance?Importance来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L305
lightColor?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L303
lights?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L302
name字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L299
sound?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L301
vibration?布尔值 (boolean)来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L304
visibility?可见性来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L306

发送通知的选项。

2.0.0

属性类型描述定义于
actionTypeId?字符串定义此通知的动作类型。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L62
attachments?Attachment[]通知附件。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L104
autoCancel?布尔值 (boolean)当用户点击通知时自动取消通知。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L120
body?字符串可选通知正文。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L44
channelId?字符串发送此通知的 Channel 标识符。如果频道不存在,通知将不会触发。请确保频道通过 listChannels 和 createChannel 存在。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L36
extra?Record<string, unknown>存储在通知中的额外负载。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L108
group?字符串用于将多个通知分组的标识符。https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/1649872-threadidentifier来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L68
groupSummary?布尔值 (boolean)指示系统此通知是 Android 上组的摘要。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L72
icon?字符串通知图标。在 Android 上,图标必须放在应用的 res/drawable 文件夹中。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L90
iconColor?字符串Android 上的图标颜色。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L100
id?数字通知标识符,用于稍后引用此对象。必须是 32 位整数。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L29
inboxLines?字符串[]要添加到通知的行列表。将通知样式更改为收件箱。不能与 largeBody 一起使用。仅支持最多 5 行。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L84
largeBody?字符串多行文本。将通知样式更改为大文本。不能与 inboxLines 一起使用。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L54
largeIcon?字符串通知大图标(Android)。图标必须放在应用的 res/drawable 文件夹中。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L96
number?数字设置此通知在 Android 上表示的项数。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L132
ongoing?布尔值 (boolean)如果为 true,则通知不能在 Android 上被用户关闭。应用程序服务必须管理通知的关闭。它通常用于指示正在等待的后台任务(例如文件下载)或用户正在参与的任务(例如播放音乐)。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L116
schedule?计划计划此通知在稍后时间或固定间隔触发。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L48
silent?布尔值 (boolean)在 iOS 上将通知显示更改为静默(无徽章、无声音、未列出)。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L124
sound?字符串声音资源名称。仅在移动设备上可用。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L76
summary?字符串带有 largeBodyinboxLinesgroupSummary 的通知的详细文本。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L58
title字符串通知标题。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L40
visibility?可见性通知可见性。来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L128

属性类型定义于
body?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L264
id数字来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L262
schedule计划来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L265
title?字符串来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L263

属性类型描述定义于
day?数字-来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L138
hour?数字-: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L149
minute?数字-: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L150
month?数字-: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L137
second?数字-: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L151
weekday?数字1 - 星期日 2 - 星期一 3 - 星期二 4 - 星期三 5 - 星期四 6 - 星期五 7 - 星期六: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L148
year?数字-: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L136

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

来源: 未定义

function active(): Promise<ActiveNotification[]>

检索活动通知列表。

Promise<ActiveNotification[]>

一个解析为活动通知列表的 Promise。

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

2.0.0

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


function cancel(notifications): Promise<void>

取消具有给定标识符列表的待处理通知。

参数类型
notifications数字[]

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function cancelAll(): Promise<void>

取消所有待处理通知。

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function channels(): Promise<Channel[]>

检索通知通道列表。

Promise<Channel[]>

一个解析为通知通道列表的 Promise。

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

2.0.0

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


function createChannel(channel): Promise<void>

创建通知通道。

参数类型
channel频道

Promise<void>

表示操作成功或失败的 Promise。

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

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


function isPermissionGranted(): Promise<boolean>

检查是否授予发送通知的权限。

Promise<boolean>

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

2.0.0

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


function onAction(cb): Promise<PluginListener>
参数类型
cb(notification) => void

Promise<PluginListener>

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


function onNotificationReceived(cb): Promise<PluginListener>
参数类型
cb(notification) => void

Promise<PluginListener>

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


function pending(): Promise<PendingNotification[]>

检索待处理通知列表。

Promise<PendingNotification[]>

一个解析为待处理通知列表的 Promise。

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

2.0.0

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


function registerActionTypes(types): Promise<void>

注册用户点击通知时执行的操作。

参数类型
typesActionType[]

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function removeActive(notifications): Promise<void>

移除具有给定标识符列表的活动通知。

参数类型
notifications对象[]

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function removeAllActive(): Promise<void>

移除所有活动通知。

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function removeChannel(id): Promise<void>

移除具有给定标识符的通道。

参数类型
ID字符串

Promise<void>

表示操作成功或失败的 Promise。

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

2.0.0

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


function requestPermission(): Promise<NotificationPermission>

请求发送通知的权限。

Promise<NotificationPermission>

一个 Promise,解析为用户是否授予权限。

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

2.0.0

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


function sendNotification(options): void

向用户发送通知。

参数类型
选项string | Options

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

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


© 2025 Tauri 贡献者。CC-BY / MIT