NotificationEvent
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2023.
* Some parts of this feature may have varying levels of support.
Note: This feature is only available inService Workers.
TheNotificationEvent
interface of theNotifications API represents a notification event dispatched on theServiceWorkerGlobalScope
of aServiceWorker
.
This interface inherits from theExtendableEvent
interface.
Note:Only persistent notification events, fired at theServiceWorkerGlobalScope
object, implement theNotificationEvent
interface. Non-persistent notification events, fired at theNotification
object, implement theEvent
interface.
In this article
Constructor
NotificationEvent()
Creates a new
NotificationEvent
object.
Instance properties
Also inherits properties from its parent interface,ExtendableEvent
.
NotificationEvent.notification
Read onlyReturns a
Notification
object representing the notification that was clicked to fire the event.NotificationEvent.action
Read onlyReturns the string ID of the notification button the user clicked. This value returns an empty string if the user clicked the notification somewhere other than an action button, or the notification does not have a button.
Instance methods
Also inherits methods from its parent interface,ExtendableEvent
.
Example
self.addEventListener("notificationclick", (event) => { console.log(`On notification click: ${event.notification.tag}`); event.notification.close(); // This looks to see if the current is already open and // focuses if it is event.waitUntil( clients .matchAll({ type: "window", }) .then((clientList) => { for (const client of clientList) { if (client.url === "/" && "focus" in client) return client.focus(); } if (clients.openWindow) return clients.openWindow("/"); }), );});
Specifications
Specification |
---|
Notifications API> # notificationevent> |
Note:This interface is specified in theNotifications API, but accessed throughServiceWorkerGlobalScope
.
Browser compatibility
Loading…