The ServiceWorkerGlobalScope.onpush
event of the ServiceWorkerGlobalScope
interface is fired whenever a push message is received by a service worker via a push server.
Syntax
ServiceWorkerGlobalScope.onpush = function(PushEvent) { ... } self.addEventListener('push', function(PushEvent) { ... })
Example
The following example takes data from a PushEvent
and displays it on all of the service worker's clients. The data payload of the push message is available in the event object's data
property (PushEvent.data
, which contains a PushMessageData
object.)
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 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 APIThe definition of 'onpush' in that specification. | Working Draft | Initial definition. This event is specified in the Push API, but accessed through ServiceWorkerGlobalScope .
|
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.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 40 |
Edge
Full support ≤79 |
Firefox Full support 44 Full support 44 Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API. |
IE
No support No |
Opera
Full support 24 |
Safari
Full support 11.1 |
WebView Android
Full support 40 |
Chrome Android
Full support 40 |
Firefox Android
Full support 44 |
Opera Android
Full support 24 |
Safari iOS
Full support 11.3 |
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.
See also
ServiceWorkerGlobalScope.onpush by Mozilla Contributors is licensed under CC-BY-SA 2.5.