summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/extension.html
diff options
context:
space:
mode:
Diffstat (limited to 'chrome/common/extensions/docs/extension.html')
-rw-r--r--chrome/common/extensions/docs/extension.html527
1 files changed, 485 insertions, 42 deletions
diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html
index a0e11fd..9e99f0e 100644
--- a/chrome/common/extensions/docs/extension.html
+++ b/chrome/common/extensions/docs/extension.html
@@ -81,6 +81,16 @@
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd>
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd>
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd>
<div></div>
@@ -269,7 +279,7 @@
</ol>
</li>
<li>
- <a href="#methods">Methods</a>
+ <a href="#global-methods">Methods</a>
<ol>
<li>
<a href="#method-connect">connect</a>
@@ -291,7 +301,7 @@
</ol>
</li>
<li>
- <a href="#events">Events</a>
+ <a href="#global-events">Events</a>
<ol>
<li>
<a href="#event-onConnect">onConnect</a>
@@ -490,6 +500,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -500,6 +520,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -609,6 +639,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -619,6 +659,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -630,8 +680,8 @@ For details, see
</div> <!-- /apiGroup -->
<!-- METHODS -->
- <div class="apiGroup" id="methods">
- <a name="methods"></a>
+ <div id="methodsTemplate" class="apiGroup">
+ <a name="global-methods"></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
@@ -704,6 +754,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -809,6 +869,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -819,6 +889,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -883,6 +963,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -936,10 +1026,10 @@ For details, see
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
- <p>Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no backround page.</p>
+ <p>Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.</p>
<!-- PARAMETERS -->
- <h4>Parameters</h4>
+ <h4 style="display: none; ">Parameters</h4>
<dl>
<div style="display: none; ">
<div>
@@ -1004,6 +1094,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1246,6 +1346,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1310,6 +1420,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1467,6 +1587,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1525,6 +1655,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1535,6 +1675,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1610,6 +1760,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1722,6 +1882,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1782,6 +1952,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1842,6 +2022,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd>
<div>
@@ -1899,6 +2089,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -1991,6 +2191,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -2081,6 +2291,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -2137,10 +2357,9 @@ For details, see
</div> <!-- /apiGroup -->
<!-- EVENTS -->
- <div class="apiGroup">
- <a name="events"></a>
- <h3 id="events">Events</h3>
-
+ <div id="eventsTemplate" class="apiGroup">
+ <a name="global-events"></a>
+ <h3>Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="event-onConnect"></a>
@@ -2156,10 +2375,11 @@ For details, see
<p>Fired when a connection is made from either an extension process or a content script.</p>
<!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ <div>
+ <h4>Parameters</h4>
+ <dl>
<div>
+ <div>
<dt>
<var>port</var>
<em>
@@ -2212,15 +2432,25 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div>
- </dl>
-
+ </div>
+ </dl>
+ </div>
</div> <!-- /decription -->
</div><div class="apiItem">
@@ -2237,10 +2467,11 @@ For details, see
<p>Fired when a connection is made from another extension.</p>
<!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ <div>
+ <h4>Parameters</h4>
+ <dl>
<div>
+ <div>
<dt>
<var>port</var>
<em>
@@ -2293,15 +2524,25 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div>
- </dl>
-
+ </div>
+ </dl>
+ </div>
</div> <!-- /decription -->
</div><div class="apiItem">
@@ -2318,10 +2559,11 @@ For details, see
<p>Fired when a request is sent from either an extension process or a content script.</p>
<!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ <div>
+ <h4>Parameters</h4>
+ <dl>
<div>
+ <div>
<dt>
<var>request</var>
<em>
@@ -2372,14 +2614,24 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
<var>sender</var>
<em>
@@ -2432,14 +2684,24 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
<var>sendResponse</var>
<em>
@@ -2490,15 +2752,25 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div>
- </dl>
-
+ </div>
+ </dl>
+ </div>
</div> <!-- /decription -->
</div><div class="apiItem">
@@ -2515,10 +2787,11 @@ For details, see
<p>Fired when a request is sent from another extension.</p>
<!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ <div>
+ <h4>Parameters</h4>
+ <dl>
<div>
+ <div>
<dt>
<var>request</var>
<em>
@@ -2569,14 +2842,24 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
<var>sender</var>
<em>
@@ -2629,14 +2912,24 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
<var>sendResponse</var>
<em>
@@ -2687,15 +2980,25 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
- </div>
- </dl>
-
+ </div>
+ </dl>
+ </div>
</div> <!-- /decription -->
</div> <!-- /apiItem -->
@@ -2808,6 +3111,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -2866,6 +3179,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -2876,6 +3199,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -2985,6 +3318,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3045,6 +3388,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3105,6 +3458,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3165,6 +3528,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3175,6 +3548,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3284,6 +3667,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3344,6 +3737,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3404,6 +3807,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3464,6 +3877,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3522,6 +3945,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
@@ -3532,6 +3965,16 @@ For details, see
</dl>
</dd>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>