通知(notification)
向用户发送toast通知（简短的自动消失的操作系统窗口元素）。也可以与 Notification Web API 一起使用。
当 tauri.conf.json 中 build.withGlobalTauri 设置为 true 时，该包也可以通过 window.__TAURI__.notification 访问。
这些 API 必须添加到 tauri.conf.json 中的 tauri.allowlist.notification ：
{
"tauri": {
"allowlist": {
"notification": {
"all": true // enable all notification APIs
}
}
}
}建议只允许列出您使用的 API，以优化捆绑包大小和安全性。
Interfaces
Options
发送通知的选项。
Since: 1.0.0
属性
-
Optionalbody:string
可选的通知正文。
定义在: notification.ts:38
-
Optionalicon:string
可选的通知图标。
定义在: notification.ts:40
-
title:
string
通知标题。
定义在: notification.ts:36
Functions
isPermissionGranted
-
isPermissionGranted():
Promise<boolean>
检查是否已获得发送通知的权限。
示例
import { isPermissionGranted } from '@tauri-apps/api/notification';
const permissionGranted = await isPermissionGranted();Since: 1.0.0
返回: Promise<boolean>
requestPermission
-
requestPermission():
Promise<Permission>
请求发送通知的权限。
示例
import { isPermissionGranted, requestPermission } from '@tauri-apps/api/notification';
let permissionGranted = await isPermissionGranted();
if (!permissionGranted) {
const permission = await requestPermission();
permissionGranted = permission === 'granted';
}Since: 1.0.0
返回: Promise<Permission>
一个 Promise，解析为用户是否授予权限。
sendNotification
-
sendNotification(
options:string|Options):void
向用户发送通知。
示例
import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/api/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: 1.0.0
参数
名称 |
类型 |
|
|
返回: void