Skip to content

GitLab

T
tangled
Commit 099769c8 authored by asargent@chromium.org's avatar asargent@chromium.org
Browse files
Options

Updates to documentation for experimental.apps 

-Put nodoc on experimental.apps.{notify,clearAllNotifications} since those
aren't available in new packaged apps and we'll probably be doing some changes
to them before we'd move them to supported anyway.

-Remove nodoc from experimental.apps.onLaunched

BUG=138754
TEST=none

Review URL: https://chromiumcodereview.appspot.com/10810074

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@148848 0039d316-1c4b-4281-b951-d872f2087c98
parent b4935f39
Hide whitespace changes
Inline Side-by-side
Showing with 97 additions and 329 deletions
chrome/common/extensions/api/experimental_app.json
View file @ 099769c8
......@@ -10,6 +10,7 @@
"name": "notify",
"type": "function",
"description": "Creates a notification from this app.",
"nodoc": true,
"parameters": [
{
"type": "object",
......@@ -55,6 +56,7 @@
"name": "clearAllNotifications",
"type": "function",
"description": "Clears all previously sent notifications.",
"nodoc": true,
"parameters": [
{
"type": "object",
......@@ -80,7 +82,6 @@
],
"events": [
{
"nodoc": true,
"name": "onLaunched",
"type": "function",
"description": "Fired when the app is launched.",
......
chrome/common/extensions/docs/apps/experimental.app.html
View file @ 099769c8
......@@ -167,12 +167,10 @@
<a href="#apiReference">API reference: chrome.experimental.app</a>
<ol>
<li>
<a href="#global-methods">Methods</a>
<a href="#global-events">Events</a>
<ol>
<li>
<a href="#method-clearAllNotifications">clearAllNotifications</a>
</li><li>
<a href="#method-notify">notify</a>
<a href="#event-onLaunched">onLaunched</a>
</li>
</ol>
</li>
......@@ -195,27 +193,29 @@
<!-- PROPERTIES -->
<!-- /apiGroup -->
<!-- METHODS -->
<div id="methodsTemplate" class="apiGroup">
<a name="global-methods"></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
<!-- /apiGroup -->
<!-- EVENTS -->
<div id="eventsTemplate" class="apiGroup">
<a name="global-events"></a>
<h3>Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="method-clearAllNotifications"></a> <!-- method-anchor -->
<h4>clearAllNotifications</h4>
<a name="event-onLaunched"></a>
<h4>onLaunched</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.app.clearAllNotifications</span>(<span class="optional"><span>object</span>
<var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.experimental.app.</span><span>onLaunched</span><span class="subdued">.addListener</span>(function(<span>object launchData</span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p>Clears all previously sent notifications.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<p>Fired when the app is launched.</p>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
<dt>
<var>details</var>
<var>launchData</var>
<em>
<!-- TYPE -->
<div style="display:inline">
......@@ -230,92 +230,14 @@
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>Optional data for the launch.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
<dt>
<var>extensionId</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div><div>
<div>
<dt>
<var>callback</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
<!-- RETURNS -->
<dl>
</dl>
<!-- CALLBACK -->
<!-- MIN_VERSION -->
</div> <!-- /description -->
</div><div class="apiItem">
<a name="method-notify"></a> <!-- method-anchor -->
<h4>notify</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.app.notify</span>(<span class="null"><span>object</span>
<var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
<p>Creates a notification from this app.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
<dt>
<var>details</var>
<var>intent</var>
<em>
<!-- TYPE -->
<div style="display:inline">
......@@ -329,21 +251,18 @@
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>A WebIntents intent object.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
<dt>
<var>extensionId</var>
<var>action</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
......@@ -353,7 +272,7 @@
</div>
</em>
</dt>
<dd>An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable.</dd>
<dd>The WebIntent being invoked.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -362,12 +281,11 @@
</div><div>
<div>
<dt>
<var>title</var>
<var>type</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
......@@ -377,7 +295,7 @@
</div>
</em>
</dt>
<dd>The title of the notification.</dd>
<dd>The MIME type of the data.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -386,22 +304,21 @@
</div><div>
<div>
<dt>
<var>bodyText</var>
<var>data</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>any</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>The text content of the notification.</dd>
<dd>Data associated with the intent.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -410,22 +327,21 @@
</div><div>
<div>
<dt>
<var>linkUrl</var>
<var>postResult</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText.</dd>
<dd>Null callback to be compatible with WebIntents.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -434,22 +350,21 @@
</div><div>
<div>
<dt>
<var>linkText</var>
<var>postFailure</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd>
<dd>Null callback to be compatible with WebIntents.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -462,42 +377,24 @@
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div><div>
<div>
<dt>
<var>callback</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd>
<!-- OBJECT PROPERTIES -->
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
<!-- RETURNS -->
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<!-- LISTENER RETURN VALUE -->
<dl>
</dl>
<!-- CALLBACK -->
<!-- MIN_VERSION -->
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<!-- /apiGroup -->
<!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<!-- /apiGroup -->
</div> <!-- /apiPage -->
......
chrome/common/extensions/docs/extensions/experimental.app.html
View file @ 099769c8
......@@ -196,12 +196,10 @@
<a href="#apiReference">API reference: chrome.experimental.app</a>
<ol>
<li>
<a href="#global-methods">Methods</a>
<a href="#global-events">Events</a>
<ol>
<li>
<a href="#method-clearAllNotifications">clearAllNotifications</a>
</li><li>
<a href="#method-notify">notify</a>
<a href="#event-onLaunched">onLaunched</a>
</li>
</ol>
</li>
......@@ -224,27 +222,29 @@
<!-- PROPERTIES -->
<!-- /apiGroup -->
<!-- METHODS -->
<div id="methodsTemplate" class="apiGroup">
<a name="global-methods"></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
<!-- /apiGroup -->
<!-- EVENTS -->
<div id="eventsTemplate" class="apiGroup">
<a name="global-events"></a>
<h3>Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="method-clearAllNotifications"></a> <!-- method-anchor -->
<h4>clearAllNotifications</h4>
<a name="event-onLaunched"></a>
<h4>onLaunched</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.app.clearAllNotifications</span>(<span class="optional"><span>object</span>
<var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.experimental.app.</span><span>onLaunched</span><span class="subdued">.addListener</span>(function(<span>object launchData</span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p>Clears all previously sent notifications.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<p>Fired when the app is launched.</p>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
<dt>
<var>details</var>
<var>launchData</var>
<em>
<!-- TYPE -->
<div style="display:inline">
......@@ -259,105 +259,14 @@
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>Optional data for the launch.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
<dt>
<var>extensionId</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div><div>
<div>
<dt>
<var>callback</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
<!-- RETURNS -->
<dl>
</dl>
<!-- CALLBACK -->
<div>
<div>
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
<dl>
</dl>
</div>
</div>
<!-- MIN_VERSION -->
</div> <!-- /description -->
</div><div class="apiItem">
<a name="method-notify"></a> <!-- method-anchor -->
<h4>notify</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.app.notify</span>(<span class="null"><span>object</span>
<var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
<p>Creates a notification from this app.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
<dt>
<var>details</var>
<var>intent</var>
<em>
<!-- TYPE -->
<div style="display:inline">
......@@ -371,21 +280,18 @@
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>A WebIntents intent object.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
<dt>
<var>extensionId</var>
<var>action</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
......@@ -395,7 +301,7 @@
</div>
</em>
</dt>
<dd>An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable.</dd>
<dd>The WebIntent being invoked.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -404,12 +310,11 @@
</div><div>
<div>
<dt>
<var>title</var>
<var>type</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
......@@ -419,7 +324,7 @@
</div>
</em>
</dt>
<dd>The title of the notification.</dd>
<dd>The MIME type of the data.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -428,22 +333,21 @@
</div><div>
<div>
<dt>
<var>bodyText</var>
<var>data</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>any</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>The text content of the notification.</dd>
<dd>Data associated with the intent.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -452,22 +356,21 @@
</div><div>
<div>
<dt>
<var>linkUrl</var>
<var>postResult</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText.</dd>
<dd>Null callback to be compatible with WebIntents.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -476,22 +379,21 @@
</div><div>
<div>
<dt>
<var>linkText</var>
<var>postFailure</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>string</span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd>
<dd>Null callback to be compatible with WebIntents.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
......@@ -504,55 +406,24 @@
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div><div>
<div>
<dt>
<var>callback</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<span>function</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd>
<!-- OBJECT PROPERTIES -->
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
<!-- FUNCTION PARAMETERS -->
</div>
</div>
</dl>
<!-- RETURNS -->
<dl>
</dl>
<!-- CALLBACK -->
<div>
<div>
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
<dl>
</div>
</dl>
</div>
</div>
<!-- MIN_VERSION -->
<!-- EXTRA PARAMETERS -->
<!-- LISTENER RETURN VALUE -->
<dl>
</dl>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<!-- /apiGroup -->
<!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<!-- /apiGroup -->
</div> <!-- /apiPage -->
......
chrome/common/extensions/docs/samples.json
View file @ 099769c8
......@@ -120,8 +120,7 @@
"chrome.events.Event.hasListeners": "events.html#method-Event-hasListeners",
"chrome.events.Event.removeListener": "events.html#method-Event-removeListener",
"chrome.events.Event.removeRules": "events.html#method-Event-removeRules",
"chrome.experimental.app.clearAllNotifications": "experimental.app.html#method-clearAllNotifications",
"chrome.experimental.app.notify": "experimental.app.html#method-notify",
"chrome.experimental.app.onLaunched": "experimental.app.html#event-onLaunched",
"chrome.experimental.bluetooth.connect": "experimental.bluetooth.html#method-connect",
"chrome.experimental.bluetooth.disconnect": "experimental.bluetooth.html#method-disconnect",
"chrome.experimental.bluetooth.getAddress": "experimental.bluetooth.html#method-getAddress",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment