W3cubDocs

/DOM

PushEvent

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The PushEvent interface of the Push API represents a push message that has been received. This event is sent to the global scope of a ServiceWorker. It contains the information sent from an application server to a PushSubscription.

Constructor

PushEvent.PushEvent()
Creates a new PushEvent object.

Properties

Inherits properties from its parent, ExtendableEvent. Additional properties:

PushEvent.data Read only
Returns a reference to a PushMessageData object containing data sent to the PushSubscription.

Methods

Inherits methods from its parent, ExtendableEvent.

Examples

The following example takes data from a PushEvent and displays it on all of the service worker's clients.

self.addEventListener('push', function(event) {
  if (!(self.Notification && self.Notification.permission === 'granted')) {
    return;
  }

  var data = {};
  if (event.data) {
    data = event.data.json();
  }
  var title = data.title || "Something Has Happened";
  var message = data.message || "Here's something you might want to check out.";
  var icon = "images/new-notification.png";

  var notification = new self.Notification(title, {
    body: message,
    tag: 'simple-push-demo-notification',
    icon: icon
  });

  notification.addEventListener('click', function() {
    if (clients.openWindow) {
      clients.openWindow('https://example.blog.com/2015/03/04/something-new.html');
    }
  });
});

Specifications

Specification Status Comment
Push API
The definition of 'PushEvent' in that specification.
Working Draft Initial definition.

Browser CompatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 42 16
Disabled
16
Disabled
Disabled From version 16: this feature is behind the Enable service workers preference.
17
44
44
Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)
Enabled only in Nightly, Developer Edition, and Beta channels.
No 37 No
PushEvent() constructor 42 16
Disabled
16
Disabled
Disabled From version 16: this feature is behind the Enable service workers preference.
17
44
44
Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)
Enabled only in Nightly, Developer Edition, and Beta channels.
No 37 No
data 57 16
Disabled
16
Disabled
Disabled From version 16: this feature is behind the Enable service workers preference.
17
44
44
Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)
Enabled only in Nightly, Developer Edition, and Beta channels.
No 44 No
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support No 42 No 44
44
48
Push enabled by default.
37 No 4.0
PushEvent() constructor No 42 No 44
44
48
Push enabled by default.
37 No 4.0
data No 57 No 44
44
48
Push enabled by default.
44 No 4.0

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PushEvent