1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
---
title: PushMessageData
slug: Web/API/PushMessageData
tags:
- API
- Experimental
- Interface
- NeedsTranslation
- Push
- Push API
- PushMessageData
- Reference
- Service Workers
- TopicStub
translation_of: Web/API/PushMessageData
---
<p>{{APIRef("Push API")}}{{SeeCompatTable()}}</p>
<p>The <code><strong>PushMessageData</strong></code> interface of the <a href="/en-US/docs/Web/API/Push_API">Push API</a> provides methods which let you retrieve the push data sent by a server in various formats.</p>
<p>Unlike the similar methods in the <a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a>, which only allow the method to be invoked once, these methods can be called multiple times.</p>
<h2 id="Properties">Properties</h2>
<p>None.</p>
<h2 id="Methods">Methods</h2>
<dl>
<dt>{{domxref("PushMessageData.arrayBuffer()")}}</dt>
<dd>Extracts the data as an {{domxref("ArrayBuffer")}} object.</dd>
<dt>{{domxref("PushMessageData.blob()")}}</dt>
<dd>Extracts the data as a {{domxref("Blob")}} object.</dd>
<dt>{{domxref("PushMessageData.json()")}}</dt>
<dd>Extracts the data as a <a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON">JSON</a> object.</dd>
<dt>{{domxref("PushMessageData.text()")}}</dt>
<dd>Extracts the data as a plain text string.</dd>
</dl>
<h2 id="Examples">Examples</h2>
<p>In our <a href="https://github.com/chrisdavidmills/push-api-demo">Push API Demo</a>, we send JSON objects via push messages from our server by first converting them to strings via {{jsxref("JSON.stringify()")}} (<a href="https://github.com/chrisdavidmills/push-api-demo/blob/gh-pages/server.js#L30-L34">see server.js example</a>):</p>
<pre class="brush: js">webPush.sendNotification(subscriber[2], 200, obj.key, JSON.stringify({
action: 'chatMsg',
name: obj.name,
msg: obj.msg
}));</pre>
<p>When the message reaches the <a href="https://github.com/chrisdavidmills/push-api-demo/blob/gh-pages/sw.js">service worker</a>, we <a href="https://github.com/chrisdavidmills/push-api-demo/blob/gh-pages/sw.js#L4">convert the data back to a JSON object</a> using {{domxref("PushMessageData.json()")}} before working out what to do with it next:</p>
<pre class="brush: js">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);
}
});</pre>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Push API', '#pushmessagedata-interface', 'PushMessageData')}}</td>
<td>{{Spec2('Push API')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
{{Compat("api.PushMessageData")}}
<h2 id="See_also">See also</h2>
<ul>
<li><a href="/en-US/docs/Web/API/Push_API/Using_the_Push_API">Using the Push API</a></li>
</ul>
|
