@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
属性 | 类型 | 定义于 |
---|---|---|
at | undefined | object | 来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L169 |
every | undefined | object | 来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L184 |
interval | undefined | 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 |
通知附件。
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
id | 字符串 | 附件标识符。 | 来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L229 |
url | 字符串 | 附件 URL。支持 asset 和 file 协议。 | 来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/notification/guest-js/index.ts#L231 |
发送通知的选项。
2.0.0
type PermissionState: "granted" | "denied" | "prompt" | "prompt-with-rationale";
来源: 未定义
function active(): 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。
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>
注册用户点击通知时执行的操作。
参数 | 类型 |
---|---|
types | ActionType [] |
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