Web Notifications
ServiceWorkerRegistration 接口的 showNotification() 方法在一个活动状态下的 Service Worker 上创建通知。
语法
showNotification(title)
showNotification(title, options)
参数
title- : 定义通知的标题,显示在通知窗口的顶部。
options- : 允许配置通知的对象。它可以具有以下属性:
-
actions-
: 要在通知中显示的一系列操作的数组,默认值为空数组。数组中的每个元素都是一个具有以下成员的对象:
action- : 一个标识要在通知上显示的用户操作的字符串。
title- : 一个包含要向用户显示的操作文本的字符串。
icon- : 一个包含与操作一起显示的图标 URL 的字符串。
使用 ServiceWorkerGlobalScope.notificationclick_event 事件中的
event.action构建适当的响应。
-
-
badge- : 一个当没有足够的空间来显示通知本身(例如 Android 通知栏)时来表示通知的图像 URL 的字符串。在 Android 设备上,徽章应适应高达 4 倍分辨率(约 96 x 96 像素)的设备,并且图像将被自动遮罩。
-
body- : 一个表示通知正文的字符串,显示在标题下方,默认值是一个空字符串。
-
data- : 你想要与通知关联的任意数据。它可以是任何可结构化克隆的数据类型。默认值为
null。
- : 你想要与通知关联的任意数据。它可以是任何可结构化克隆的数据类型。默认值为
-
dir- : 表示通知的方向。默认为
auto,即采用浏览器的语言设置行为,但你可以通过设置ltr和rtl的值来覆盖该行为(尽管大多数浏览器似乎会忽略这些设置)。
- : 表示通知的方向。默认为
-
icon- : 一个包含要在通知中显示的图标的 URL 的字符串。
-
image- : 一个包含要在通知中显示的图像的 URL 的字符串。
-
lang- : 指定通知的语言,根据 使用表示语言标签的字符串指定。请参阅 Sitepoint ISO 2 字母语言代码页面以获取简单参考。默认值为空字符串。
-
renotify- : 一个布尔值,指示重复使用
tag值时是否阻止振动和声音提醒。默认为false,表示不会通知。如果为true,则还必须设置tag参数。
- : 一个布尔值,指示重复使用
-
requireInteraction- : 表示通知应保持活动状态直到用户点击或关闭它,而不是自动关闭。默认值为
false。
- : 表示通知应保持活动状态直到用户点击或关闭它,而不是自动关闭。默认值为
-
silent- : 一个布尔值,用于指定通知是否静音(不发出声音或振动),无论设备设置如何。默认值为
null,表示遵循设备默认值。如果为true,则vibrate参数不得指定。
- : 一个布尔值,用于指定通知是否静音(不发出声音或振动),无论设备设置如何。默认值为
-
tag- : 表示通知的标签的字符串。默认值为空字符串。
-
timestamp- : 一个时间戳,以毫秒为单位的 Unix time,表示与通知关联的时间。这可能是在过去,当通知用于因设备离线而无法立即发送的消息时,或者在将来,当通知用于即将开始的会议时。
-
vibrate- : 设备振动硬件随通知一起发出的振动模式。当该值被指定时,
silent参数不得设置为true。
- : 设备振动硬件随通知一起发出的振动模式。当该值被指定时,
-
- : 允许配置通知的对象。它可以具有以下属性:
返回值
一个兑现 undefined 的 Promise。
异常
TypeError- : 如果当前 Service Worker 的状态不是
activating或activated,或者用户明确拒绝了浏览器使用 API 的权限请求,则抛出该异常。
- : 如果当前 Service Worker 的状态不是
- TypeError
- : 如果满足以下条件之一,则抛出该异常:
- 当前 service worker 的状态不是
activating或activated。 - 用户已明确拒绝浏览器使用该 API 的权限请求。
silent选项是true且vibrate选项被同时指定。renotify选项是true但是tag选项为空值。
- 当前 service worker 的状态不是
- : 如果满足以下条件之一,则抛出该异常:
DataCloneErrorDOMException- : 若由于某种原因序列化
data选项失败,则抛出该异常。
- : 若由于某种原因序列化
示例
navigator.serviceWorker.register("sw.js");
function showNotification() {
Notification.requestPermission().then((result) => {
if (result === "granted") {
navigator.serviceWorker.ready.then((registration) => {
registration.showNotification("Vibration Sample", {
body: "Buzz! Buzz!",
icon: "../images/touch/chrome-touch-icon-192x192.png",
vibrate: [200, 100, 200, 100, 200, 100, 200],
tag: "vibration-sample",
});
});
}
});
}
要在适当的时间调用上述函数,你可以监听 ServiceWorkerGlobalScope.notificationclick_event 事件。
你还可以使用以下 ServiceWorkerRegistration.getNotifications() 方法检索当前 Service Worker 已触发的 Notification 的详细信息。
规范
浏览器兼容性
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
