chrome/common/extensions/docs/extensions/experimental.pushMessaging.html - Issue 10828087: Add skeleton implementation of ExtensionPushMessagingEventRouter.

Unified Diff: chrome/common/extensions/docs/extensions/experimental.pushMessaging.html

Issue 10828087: Add skeleton implementation of ExtensionPushMessagingEventRouter. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Rebase Created 8 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« chrome/common/extensions/api/experimental_push_messaging.idl ('K') | « chrome/common/extensions/docs/extensions/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/extensions/experimental.pushMessaging.html

diff --git a/chrome/common/extensions/docs/extensions/experimental.html b/chrome/common/extensions/docs/extensions/experimental.pushMessaging.html

similarity index 64%

copy from chrome/common/extensions/docs/extensions/experimental.html

copy to chrome/common/extensions/docs/extensions/experimental.pushMessaging.html

index f64a3f770811f05412cf630866c90769dc25dfca..4832cd3ad1959c06324dc97eca185d51ac74c431 100644

--- a/chrome/common/extensions/docs/extensions/experimental.html

+++ b/chrome/common/extensions/docs/extensions/experimental.pushMessaging.html

@@ -17,7 +17,7 @@

- <title>chrome.experimental.* APIs - Google Chrome Extensions - Google Code</title></head>

+ <meta name="description" content="Documentation for the chrome.experimental.pushMessaging module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.pushMessaging - Google Chrome Extensions - Google Code</title></head>

@@ -186,156 +186,189 @@

</script>

- <h1 class="page_title">chrome.experimental.* APIs</h1>

+ <h1 class="page_title">chrome.experimental.pushMessaging</h1>

</div>

<h2>Contents</h2>

<ol>

- <li>

- <a href="#overview">

-List of APIs

-</a>

- <ol>

- </ol>

- </li><li>

- <a href="#using">How to use experimental APIs</a>

- <ol>

- </ol>

- </li><li>

- <a href="#other">More APIs</a>

- <ol>

- </ol>

- </li>

+ <li>

+ <a href="#apiReference">API reference: chrome.experimental.pushMessaging</a>

+ <ol>

+ <li>

+ <a href="#global-events">Events</a>

+ <ol>

+ <li>

+ <a href="#event-onMessage">onMessage</a>

+ </li>

+ </ol>

+ </li>

+ <li>

+ <a href="#types">Types</a>

+ <ol>

+ <li>

+ <a href="#type-experimental.pushMessaging.Message">Message</a>

+ <ol>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

</ol>

</div>

+ <p id="classSummary">

+ For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

+ </p>

- <div id="static"><div id="pageData-name" class="pageData">chrome.experimental.* APIs</div>

-<div id="pageData-showTOC" class="pageData">true</div>

-<div class="doc-family extensions">

-<p>

-Before you start, <strong>choose the right version of this page.</strong>

-You should read either:

-</p>

-<ul>

- <li> <a href="http://code.google.com/chrome/extensions/trunk/experimental.html">Most recent experimental APIs</a>

- </li><li> <a href="http://code.google.com/chrome/extensions/dev/experimental.html">Dev channel experimental APIs</a></li>

-</ul>

-<p>

-For information about browser versions such as

-Canary (bleeding edge) and the Dev channel, see

-<a href="http://www.chromium.org/getting-involved/dev-channel">Chrome Release Channels</a>.

-For details about channel-specific docs,

-see <a href="docs.html#versions">Doc versions</a>.

-</p>

-</div>

-<h2 id="overview">

-List of APIs

-</h2>

-<p class="doc-family extensions">

-We'd like your <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">feedback</a>

-on the following experimental APIs:

-</p>

-<ul>

- <li>

- <a href="experimental.app.html">experimental.app</a></li><li>

- <a href="experimental.bluetooth.html">experimental.bluetooth</a></li><li>

- <a href="experimental.devtools.audits.html">experimental.devtools.audits</a></li><li>

- <a href="experimental.devtools.console.html">experimental.devtools.console</a></li><li>

- <a href="experimental.discovery.html">experimental.discovery</a></li><li>

- <a href="experimental.identity.html">experimental.identity</a></li><li>

- <a href="experimental.infobars.html">experimental.infobars</a></li><li>

- <a href="experimental.keybinding.html">experimental.keybinding</a></li><li>

- <a href="experimental.mediaGalleries.html">experimental.mediaGalleries</a></li><li>

- <a href="experimental.offscreenTabs.html">experimental.offscreenTabs</a></li><li>

- <a href="experimental.processes.html">experimental.processes</a></li><li>

- <a href="experimental.serial.html">experimental.serial</a></li><li>

- <a href="experimental.speechInput.html">experimental.speechInput</a></li><li>

- <a href="experimental.usb.html">experimental.usb</a></li>

-</ul>

-<p class="doc-family extensions">

-Pay special attention to the following APIs,

-which we expect to finalize soon:

-<b>devtools</b>,

-<b>infobars</b>,

-<b>permissions</b>,

-For examples of using the experimental APIs, see

-<a href="samples.html#experimental">Samples</a>.

-</p>

-<p class="warning">

-<b>Caution:</b>

-Don't depend on these experimental APIs.

-They might disappear,

-and they <em>will</em> change.

-Also, the Chrome Web Store doesn't allow you to

-upload items that use experimental APIs.

-</p>

-<h2 id="using">How to use experimental APIs</h2>

-<ol>

- <li class="doc-family extensions">

- Make sure you're using either

- <a href="http://tools.google.com/dlpage/chromesxs">Canary</a>

- (which you can use at the same time as other Chrome channels) or the

-<a href="http://www.chromium.org/getting-involved/dev-channel">Dev channel</a>.

- Although the experimental APIs might work in other versions,

- we need your feedback on the latest incarnation of the APIs,

- which you can find in Canary and on the Dev channel.

- </li>

- <li class="doc-family extensions">

- Using either the

- <a href="http://code.google.com/chrome/extensions/trunk/experimental.html">most recent API documentation</a> (if you're using Canary) or the

- <a href="http://code.google.com/chrome/extensions/dev/experimental.html">API documentation for the Dev channel</a>,

- write the code for your extension.

- </li>

- <li>

- Specify the "experimental"

- <a href="manifest.html#permissions">permission</a>

- in your manifest, like this:

-<pre>"permissions": [

- <b>"experimental"</b>,

- ...

-],

-</pre>

- </li>

- <li>

- Enable the experimental API in your browser.

- You can do this in either of two ways:

- <ul>

- <li> Go to <b>chrome://flags</b>,

- find "Experimental Extension APIs",

- click its "Enable" link,

- and restart Chrome.

- From now on,

- unless you return to that page and disable experimental APIs,

- you'll be able to run extensions and apps that use experimental APIs.

- </li>

- <li> Specify the <b>--enable-experimental-extension-apis</b> flag

- each time you launch the browser.

- On Windows, you can do this by modifying

- the properties of the shortcut that you use to launch Google Chrome.

- For example:

-<pre><em>path_to_chrome.exe</em> <b>--enable-experimental-extension-apis</b></pre>

- </li>

- </ul>

- </li>

- <li class="doc-family extension">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">Give us feedback!</a>

- Your comments and suggestions help us

- improve the APIs and decide

- which ones should move from experimental to supported.

- </li>

-</ol>

-<h2 id="other">More APIs</h2>

-<p>

-For information on the standard APIs that packaged apps can use, see

-<a href="api_index.html">chrome.* APIs</a> and

-<a href="api_other.html">Other APIs</a>.

-</p>

-</div>

+ <div id="static"></div>

-

+ <div class="apiPage">

+ <a name="apiReference"></a>

+ <h2>API reference: chrome.experimental.pushMessaging</h2>

+

+

+

+

+

+ <div id="eventsTemplate" class="apiGroup">

+ <a name="global-events"></a>

+ <h3>Events</h3>

+

+ <div class="apiItem">

+ <a name="event-onMessage"></a>

+ <h4>onMessage</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.pushMessaging.</span><span>onMessage</span><span class="subdued">.addListener</span>(function(<span>experimental.pushMessaging.Message message</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p>Fired when a push message has been received.</p>

+

+ <div>

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

+ <dt>

+ <var>message</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <a href="experimental.pushMessaging.html#type-experimental.pushMessaging.Message">experimental.pushMessaging.Message</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>The details associated with the message.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+

+ <dl>

+ </dl>

+ </div>

+

+ </div>

+ </div>

+

+ <div class="apiGroup">

+ <a name="types"></a>

+ <h3 id="types">Types</h3>

+

+ <div class="apiItem">

+ <a name="type-experimental.pushMessaging.Message"></a>

+ <h4>experimental.pushMessaging.Message</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+ <dd>

+ <dl>

+ <div>

+ <dt>

+ <var>payload</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>The payload associated with the message, if any.</dd>

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>subchannel</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>The subchannel the message was sent on.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div>

+ </div>

+ </div>

</div>

</div>

</div>