NotificationEvent

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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.

Constructor

NotificationEvent.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 undefined 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.  It is intended to be called in the install EventHandler for the installing worker and on the active EventHandler for the active worker.

Example

JavaScript
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

Specification Status Comment
Notifications API
The definition of 'NotificationEvent' in that specification.
Recommendation Living standard.

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

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42 44.0 (44.0)[1] ? ? ?
action 48        
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support 44.0 (44.0) (Yes) ? ? ? 42
action No support No support           48

[1] Service workers (and Push) have been disabled in the Firefox 45 Extended Support Release (ESR.)

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/notificationevent

API Experimental Interface NotificationEvent Reference Service Workers ServiceWorker