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 thePushSubscription
.
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 Compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
PushEvent | Chrome Full support 42 | Edge
Full support
16
| Firefox
Full support
44
| IE No support No | Opera Full support 37 | Safari No support No | WebView Android No support No | Chrome Android Full support 42 | Firefox Android
Full support
44
| Opera Android Full support 37 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
PushEvent() constructor | Chrome Full support 42 | Edge
Full support
16
| Firefox
Full support
44
| IE No support No | Opera Full support 37 | Safari No support No | WebView Android No support No | Chrome Android Full support 42 | Firefox Android
Full support
44
| Opera Android Full support 37 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
data | Chrome Full support 57 | Edge
Full support
16
| Firefox
Full support
44
| IE No support No | Opera Full support 44 | Safari No support No | WebView Android No support No | Chrome Android Full support 57 | Firefox Android
Full support
44
| Opera Android Full support 43 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- See implementation notes.
- User must explicitly enable this feature.
- User must explicitly enable this feature.