W3cubDocs

/Web APIs

NotificationEvent

The parameter passed into the onnotificationclick handler, the NotificationEvent interface represents a notification click event that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker.

This interface inherits from the ExtendableEvent interface.

Event ExtendableEvent NotificationEvent

Constructor

NotificationEvent()

Creates a new NotificationEvent object.

Properties

Inherits properties from its ancestor, Event.

NotificationEvent.notification Read only

Returns a Notification object representing the notification that was clicked to fire the event.

NotificationEvent.action Read only

Returns 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.

Methods

Inherits methods from its parent, ExtendableEvent.

ExtendableEvent.waitUntil()

Extends the lifetime of the event. Tells the browser that work is ongoing.

Example

self.addEventListener('notificationclick', function(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(function(clientList) {
    for (var i = 0; i < clientList.length; i++) {
      var client = clientList[i];
      if (client.url == '/' && 'focus' in client)
        return client.focus();
    }
    if (clients.openWindow)
      return clients.openWindow('/');
  }));
});

Specifications

Note: This interface is specified in the Notifications API, but accessed through ServiceWorkerGlobalScope.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
NotificationEvent
42
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
37
No
No
42
44
37
No
4.0
NotificationEvent
42
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
37
No
No
42
44
37
No
4.0
action
48
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
No
No
No
48
44
No
No
5.0
notification
42
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
37
No
No
42
44
37
No
4.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/NotificationEvent