PushMessageData

Experimental: 这是一个实验中的功能
此功能某些浏览器尚在开发中,请参考浏览器兼容性表格以得到在不同浏览器中适合使用的前缀。由于该功能对应的标准文档可能被重新修订,所以在未来版本的浏览器中该功能的语法和行为可能随之改变。

The PushMessageData interface of the Push API provides methods which let you retrieve the push data sent by a server in various formats.

Unlike the similar methods in the Fetch API, which only allow the method to be invoked once, these methods can be called multiple times.

Properties

None.

Methods

PushMessageData.arrayBuffer() (en-US)
Extracts the data as an ArrayBuffer object.
PushMessageData.blob() (en-US)
Extracts the data as a Blob object.
PushMessageData.json()
Extracts the data as a JSON object.
PushMessageData.text() (en-US)
Extracts the data as a plain text string.

Examples

In our Push API Demo, we send JSON objects via push messages from our server by first converting them to strings via JSON.stringify() (see server.js example):

webPush.sendNotification(subscriber[2], 200, obj.key, JSON.stringify({
  action: 'chatMsg',
  name: obj.name,
  msg: obj.msg
}));

When the message reaches the service worker, we convert the data back to a JSON object using PushMessageData.json() before working out what to do with it next:

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

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

Specifications

Specification Status Comment
Push API
PushMessageData
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also