ExtendableMessageEvent

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

 

The ExtendableMessageEvent interface of the ServiceWorker API represents the event object of a message event fired on a service worker (when a channel message is received on the ServiceWorkerGlobalScope from another context) — extends the lifetime of such events.

This interface inherits from the ExtendableEvent interface.

Constructor

ExtendableMessageEvent.ExtendableMessageEvent()
Creates a new ExtendableMessageEvent object instance.

Properties

Inherits properties from its parent, ExtendableEvent.

ExtendableMessageEvent.data Read only
Returns the event's data. It can be any data type.
ExtendableMessageEvent.origin Read only
Returns the origin of the ServiceWorkerClient that sent the message
ExtendableMessageEvent.lastEventId Read only
Represents, in server-sent events, the last event ID of the event source.
ExtendableMessageEvent.source Read only
Returns a reference to the service worker that sent the message.
ExtendableMessageEvent.ports Read only
Returns the array containing the MessagePort objects representing the ports of the associated message channel.

Methods

Inherits methods from its parent, ExtendableEvent.

Examples

When the following code is used inside a service worker to respond to a push messages by sending the data received via PushMessageData to the main context via a channel message, the event object of onmessage will be a ExtendableMessageEvent.

var port;

self.addEventListener('push', function(e) {
  var obj = e.data.json();

  if(obj.action === 'subscribe' || obj.action === 'unsubscribe') {
    port.postMessage(obj);
  } else if(obj.action === 'init' || obj.action === 'chatMsg') {
    port.postMessage(obj);
  }
});

self.onmessage = function(e) {
  console.log(e);
  port = e.ports[0];
}

Specifications

Specification Status Comment
Service Workers
The definition of 'ExtendableMessageEvent' in that specification.
Working Draft Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome Full support YesEdge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support YesEdge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
ExtendableMessageEvent
Experimental
Chrome ? Edge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android ? Edge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
data
Experimental
Chrome Full support 51Edge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 51Edge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
lastEventId
Experimental
Chrome ? Edge Full support 17Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE ? Opera ? Safari No support NoWebView Android No support NoChrome Android ? Edge Mobile Full support 17Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
origin
Experimental
Chrome ? Edge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android ? Edge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
ports
Experimental
Chrome ? Edge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android ? Edge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?
source
Experimental
Chrome ? Edge ? Firefox Full support 45
Notes
Full support 45
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android ? Edge Mobile ? Firefox Android Full support 45Opera Android ? Safari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.

See also

Document Tags and Contributors

Contributors to this page: fscholz, chrisdavidmills, jpmedley
Last updated by: fscholz,