aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/web/api/pushmessagedata/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'files/zh-cn/web/api/pushmessagedata/index.html')
-rw-r--r--files/zh-cn/web/api/pushmessagedata/index.html145
1 files changed, 145 insertions, 0 deletions
diff --git a/files/zh-cn/web/api/pushmessagedata/index.html b/files/zh-cn/web/api/pushmessagedata/index.html
new file mode 100644
index 0000000000..bf38ec955b
--- /dev/null
+++ b/files/zh-cn/web/api/pushmessagedata/index.html
@@ -0,0 +1,145 @@
+---
+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>
+
+<div>{{CompatibilityTable}}</div>
+
+<div id="compat-desktop">
+<table class="compat-table">
+ <tbody>
+ <tr>
+ <th>Feature</th>
+ <th>Chrome</th>
+ <th>Firefox (Gecko)</th>
+ <th>Internet Explorer</th>
+ <th>Opera</th>
+ <th>Safari (WebKit)</th>
+ </tr>
+ <tr>
+ <td>Basic support</td>
+ <td>{{CompatChrome(50.0)}}</td>
+ <td>{{CompatGeckoDesktop(44.0)}}<sup>[1]</sup></td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<div id="compat-mobile">
+<table class="compat-table">
+ <tbody>
+ <tr>
+ <th>Feature</th>
+ <th>Android</th>
+ <th>Android Webview</th>
+ <th>Firefox Mobile (Gecko)</th>
+ <th>Firefox OS</th>
+ <th>IE Mobile</th>
+ <th>Opera Mobile</th>
+ <th>Safari Mobile</th>
+ <th>Chrome for Android</th>
+ </tr>
+ <tr>
+ <td>Basic support</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatGeckoMobile(48)}}<sup>[2]</sup></td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatNo}}</td>
+ <td>{{CompatChrome(50.0)}}</td>
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<ul>
+ <li>[1] Push (and <a href="/en-US/docs/Web/API/Service_Worker_API">Service Workers</a>) have been disabled in the <a href="https://www.mozilla.org/en-US/firefox/organizations/">Firefox 45 and 52 Extended Support Releases</a> (ESR.)</li>
+ <li>[2] Push has been enabled by default on Firefox for Android version 48.</li>
+</ul>
+
+<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>