summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/xhr.html
diff options
context:
space:
mode:
Diffstat (limited to 'chrome/common/extensions/docs/xhr.html')
-rwxr-xr-xchrome/common/extensions/docs/xhr.html479
1 files changed, 240 insertions, 239 deletions
diff --git a/chrome/common/extensions/docs/xhr.html b/chrome/common/extensions/docs/xhr.html
index 772b48e..db1c253 100755
--- a/chrome/common/extensions/docs/xhr.html
+++ b/chrome/common/extensions/docs/xhr.html
@@ -2,141 +2,186 @@
1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the
templating mechanism.
- 2) The <body> tag *must* retain id="body"
3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
browser, it will be re-generated from the template, json schema and
authored overview content.
4) The <body>.innerHTML is also generated by an offline step so that this
page may easily be indexed by search engines.
-
- TODO(rafaelw): Abstract this into a "pageshell" that becomes the single
- version of page template shell and the "instance" pages (bookmarks.html,
- etc...) can be generated with a build step.
---><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0">
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0">
- <title jscontent="getPageTitle()" jstcache="1">Cross-Origin XMLHttpRequest</title>
- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0">
- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0">
+--><html xmlns="http://www.w3.org/1999/xhtml"><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
+ <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
</script>
- <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script>
- <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script>
- </head><!-- <body> content is completely generated. Do not edit, as it will be
- and rewritten. --><body jstcache="0"> <div id="container" jstcache="0">
- <a name="top" jstcache="0"> </a>
+ <script type="text/javascript" src="js/api_page_generator.js"></script>
+ <script type="text/javascript" src="js/bootstrap.js"></script>
+ <title>Cross-Origin XMLHttpRequest</title></head><body> <div id="container">
+ <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
+ <!-- In particular, sub-templates that recursive, must be used by allowing
+ jstemplate to make a copy of the template in this section which
+ are not operated on by way of the jsskip="true" -->
+ <div style="display:none">
+
+ <!-- VALUE -->
+ <div id="valueTemplate">
+ <dt>
+ <var>paramName</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional">optional</span>
+ <span id="typeTemplate">
+ <span>
+ <a> Type</a>
+ </span>
+ <span>
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo">
+ Undocumented.
+ </dd>
+ <dd>
+ Description of this parameter from the json schema.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div> <!-- /VALUE -->
+
+ </div> <!-- /SUBTEMPLATES -->
+
+ <a name="top"> </a>
<!-- API HEADER -->
- <div id="pageHeader" jstcache="0">
- <div id="searchbox" jstcache="0">
- <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0">
- <div jstcache="0">
- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0">
- <input type="hidden" name="ie" value="UTF-8" jstcache="0">
- <input type="text" name="q" size="31" jstcache="0">
- <input type="submit" name="sa" value="Search" jstcache="0">
+ <div id="pageHeader">
+ <div id="searchbox">
+ <form action="http://www.google.com/cse" id="cse-search-box">
+ <div>
+ <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="31">
+ <input type="submit" name="sa" value="Search">
</div>
</form>
- <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script>
- <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>
- <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en" jstcache="0"></script>
- <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&amp;lang=en" jstcache="0"></script>
+ <script type="text/javascript" src="http://www.google.com/jsapi"></script>
+ <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en"></script>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&amp;lang=en"></script>
</div>
- <div id="pageTitle" jstcache="0">
- <h1 jscontent="getPageTitle()" jstcache="1">Cross-Origin XMLHttpRequest</h1>
+ <div id="pageTitle">
+ <h1>Cross-Origin XMLHttpRequest</h1>
</div>
</div> <!-- /pageHeader -->
- <div id="pageContent" jstcache="0">
+ <div id="pageContent">
<!-- SIDENAV -->
- <div id="leftNav" jstcache="0">
- <ul jstcache="0">
- <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li>
- <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li>
- <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li>
- <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a>
- <ul jstcache="0">
- <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li>
- <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Actions</a></li>
- <li jstcache="0"><a href="background_pages.html" jstcache="0">Background Pages</a></li>
- <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content Scripts</a></li>
- <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li>
- <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li>
- <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li>
- <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</a></li>
- <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li>
- <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li>
- <li jstcache="0" class="leftNavSelected">Cross-Origin XHR</li>
- <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li>
- <li jstcache="0">Autoupdate</li>
+ <div id="leftNav">
+ <ul>
+ <li> <a href="index.html">Home</a></li>
+ <li> <a href="getstarted.html">Getting Started</a></li>
+ <li> <a href="overview.html">Overview</a></li>
+ <li> <a href="devguide.html"><div>Developer's Guide</div></a>
+ <ul>
+ <li><a href="toolstrip.html">Toolstrips</a></li>
+ <li><a href="pageActions.html">Page Actions</a></li>
+ <li><a href="background_pages.html">Background Pages</a></li>
+ <li><a href="content_scripts.html">Content Scripts</a></li>
+ <li><a href="events.html">Events</a></li>
+ <li><a href="tabs.html">Tabs</a></li>
+ <li><a href="windows.html">Windows</a></li>
+ <li><a href="bookmarks.html">Bookmarks</a></li>
+ <li><a href="themes.html">Themes</a></li>
+ <li><a href="npapi.html">NPAPI Plugins</a></li>
+ <li class="leftNavSelected">Cross-Origin XHR</li>
+ <li><a href="packaging.html">Packaging</a></li>
+ <li>Autoupdate</li>
</ul>
</li>
- <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorials</div></a>
- <ul jstcache="0">
- <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debugging</a></li>
+ <li><a href="tutorials.html"><div>Tutorials</div></a>
+ <ul>
+ <li><a href="tut_debugging.html">Debugging</a></li>
</ul>
</li>
- <li jstcache="0">Reference
- <ul jstcache="0">
- <li jstcache="0"> Formats
- <ul jstcache="0">
- <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li>
- <li jstcache="0"><a href="match_patterns.html" jstcache="0">Match Patterns</a></li>
- <li jstcache="0">Packages (.crx)</li>
+ <li>Reference
+ <ul>
+ <li> Formats
+ <ul>
+ <li><a href="manifest.html">Manifest Files</a></li>
+ <li><a href="match_patterns.html">Match Patterns</a></li>
+ <li>Packages (.crx)</li>
</ul>
</li>
- <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* APIs</a> </li>
- <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs</a> </li>
+ <li> <a href="api_index.html">chrome.* APIs</a> </li>
+ <li> <a href="api_other.html">Other APIs</a> </li>
</ul>
</li>
- <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Samples</a></li>
+ <li><a href="http://dev.chromium.org/developers/design-documents/extensions/samples">Samples</a></li>
</ul>
</div>
- <div id="mainColumn" jstcache="0">
+ <div id="mainColumn">
<!-- TABLE OF CONTENTS -->
- <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: none; ">
- <p jstcache="0">Contents</p>
- <ol jstcache="0">
- <li jsselect="getStaticTOC()" jstcache="9">
- <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Name</a>
- <ol jstcache="0">
- <li jsselect="$this.children" jstcache="22">
- <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name</a>
+ <div id="toc" style="display: none; ">
+ <p>Contents</p>
+ <ol>
+ <li>
+ <a>h2Name</a>
+ <ol>
+ <li>
+ <a>h3Name</a>
</li>
</ol>
</li>
- <div jsselect="apiDefinition" jstcache="3">
- <li jstcache="0">
- <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference</a>
- <ol jstcache="0">
- <li jsdisplay="$this.properties" jstcache="5">
- <a href="#properties" jstcache="0">Properties</a>
- <ol jstcache="0">
- <li jsselect="getPropertyListFromObject($this)" jstcache="10">
- <a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>
+ <div>
+ <li>
+ <a href="#apiReference">API reference</a>
+ <ol>
+ <li>
+ <a href="#properties">Properties</a>
+ <ol>
+ <li>
+ <a href="#property-anchor">propertyName</a>
</li>
</ol>
</li>
- <li jsdisplay="functions &amp;&amp; functions.length &gt; 0" jstcache="6">
- <a href="#methods" jstcache="0">Methods</a>
- <ol jstcache="0">
- <li jsselect="functions.sort(sortByName)" jstcache="11">
- <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="43">methodName</a>
+ <li>
+ <a href="#methods">Methods</a>
+ <ol>
+ <li>
+ <a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
- <li jsdisplay="events &amp;&amp; events.length &gt; 0" jstcache="7">
- <a href="#events" jstcache="0">Events</a>
- <ol jstcache="0">
- <li jsselect="events.sort(sortByName)" jstcache="12">
- <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="44">eventName</a>
+ <li>
+ <a href="#events">Events</a>
+ <ol>
+ <li>
+ <a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
- <li jsdisplay="types &amp;&amp; types.length &gt; 0" jstcache="8">
- <a href="#types" jstcache="0">Types</a>
- <ol jstcache="0">
- <li jsselect="types.sort(sortByName)" jstcache="38">
- <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="45">id</a>
+ <li>
+ <a href="#types">Types</a>
+ <ol>
+ <li>
+ <a href="#id-anchor">id</a>
</li>
</ol>
</li>
@@ -148,78 +193,78 @@
<!-- /TABLE OF CONTENTS -->
<!-- STATIC CONTENT PLACEHOLDER -->
- <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Cross-Origin XMLHttpRequest</div>
+ <div id="static"><div id="pageData-title" class="pageData">Cross-Origin XMLHttpRequest</div>
<!-- BEGIN AUTHORED CONTENT -->
-<p id="classSummary" jstcache="0">
+<p id="classSummary">
Regular web pages can use the
-<a href="http://www.w3.org/TR/XMLHttpRequest/" jstcache="0">XMLHttpRequest</a>
+<a href="http://www.w3.org/TR/XMLHttpRequest/">XMLHttpRequest</a>
object to send and receive data from remote servers,
but they're limited by the
-<a href="http://en.wikipedia.org/wiki/Same_origin_policy" jstcache="0">same origin policy</a>.
+<a href="http://en.wikipedia.org/wiki/Same_origin_policy">same origin policy</a>.
Extensions aren't so limited.
An extension can talk to remote servers outside of its origin,
as long as it first requests cross-origin permissions.</p>
-<h2 id="extension-origin" jstcache="0">Extension origin</h2>
-<p jstcache="0">Each running extension exists within its own separate security origin. Without
+<h2 id="extension-origin">Extension origin</h2>
+<p>Each running extension exists within its own separate security origin. Without
requesting additional privileges, the extension can use
XMLHttpRequest to get resources within its installation. For example, if
-an extension contains a JSON configuration file called <code jstcache="0">config.json</code>,
-in a <code jstcache="0">config_resources</code> folder, the extension can retrieve the file's contents like
+an extension contains a JSON configuration file called <code>config.json</code>,
+in a <code>config_resources</code> folder, the extension can retrieve the file's contents like
this:</p>
-<pre jstcache="0">var xhr = new XMLHttpRequest();
+<pre>var xhr = new XMLHttpRequest();
xhr.onreadystatechange = handleStateChange; // Implemented elsewhere.
xhr.open("GET", chrome.extension.getURL('/config_resources/config.json'), true);
xhr.send();
</pre>
-<p jstcache="0">If the extension attempts to use a security origin other than itself,
+<p>If the extension attempts to use a security origin other than itself,
say http://www.google.com,
the browser disallows it
unless the extension has requested the appropriate cross-origin permissions.
</p>
-<h2 id="requesting-permission" jstcache="0">Requesting cross-origin permissions</h2>
+<h2 id="requesting-permission">Requesting cross-origin permissions</h2>
-<p jstcache="0">By adding hosts or host match patterns (or both) to the
-<a href="manifest.html#permissions" jstcache="0">permissions</a><a jstcache="0"> section of the
-</a><a href="manifest.html" jstcache="0">manifest</a> file, the extension can request access to
+<p>By adding hosts or host match patterns (or both) to the
+<a href="manifest.html#permissions">permissions</a><a> section of the
+</a><a href="manifest.html">manifest</a> file, the extension can request access to
remote servers outside of its origin.</p>
-<pre jstcache="0">"permissions": [
+<pre>"permissions": [
"http://www.google.com/",
],
</pre>
-<p jstcache="0">Cross-origin permission values can be fully qualified host names,
+<p>Cross-origin permission values can be fully qualified host names,
like these:</p>
-<ul jstcache="0">
- <li jstcache="0"> "http://www.google.com/" </li>
- <li jstcache="0"> "http://www.gmail.com/" </li>
+<ul>
+ <li> "http://www.google.com/" </li>
+ <li> "http://www.gmail.com/" </li>
</ul>
-<p jstcache="0">Or they can be match patterns, like these:</p>
+<p>Or they can be match patterns, like these:</p>
-<ul jstcache="0">
- <li jstcache="0"> "http://*.google.com/" </li>
- <li jstcache="0"> "http://*/" </li>
+<ul>
+ <li> "http://*.google.com/" </li>
+ <li> "http://*/" </li>
</ul>
-<p jstcache="0">
+<p>
A match pattern of "http://*/" allows HTTP access to all reachable domains.
Note that here,
-match patterns are similar to <a href="match_patterns.html" jstcache="0">content script
+match patterns are similar to <a href="match_patterns.html">content script
match patterns</a>,
but any path information following the host is ignored.</p>
-<p jstcache="0">Also note that access is granted both by host and by scheme. If an extension
+<p>Also note that access is granted both by host and by scheme. If an extension
wants both secure and non-secure HTTP access to a given host or set
of hosts, it must declare the permissions separately:</p>
-<pre jstcache="0">"permissions": [
+<pre>"permissions": [
"http://www.google.com/",
"https://www.google.com/",
],
@@ -230,125 +275,81 @@ of hosts, it must declare the permissions separately:</p>
</div>
<!-- API PAGE -->
- <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; ">
- <a name="apiReference" jstcache="0"></a>
- <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.apiname </h2>
+ <div class="apiPage" style="display: none; ">
+ <a name="apiReference"></a>
+ <h2>API reference: chrome.apiname </h2>
<!-- PROPERTIES -->
- <div jsdisplay="$this.properties" class="apiGroup" jstcache="5">
- <a name="properties" jstcache="0"></a>
- <h3 id="properties" jstcache="0">Properties</h3>
-
- <div jsselect="getPropertyListFromObject($this)" jstcache="10">
- <a jsvalues=".name:'property-' + name" jstcache="15"></a>
- <h4 jscontent="name" jstcache="16">getLastError</h4>
- <div class="summary" jstcache="0">
+ <div class="apiGroup">
+ <a name="properties"></a>
+ <h3 id="properties">Properties</h3>
+
+ <div>
+ <a></a>
+ <h4>getLastError</h4>
+ <div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstcache="24">lastError</span>
+ <span>chrome.extension</span><span>lastError</span>
</div>
- <div transclude="valueTemplate" jstcache="17">
+ <div>
</div>
</div>
</div> <!-- /apiGroup -->
<!-- METHODS -->
- <div jsdisplay="functions &amp;&amp; functions.length &gt; 0" class="apiGroup" id="methods" jstcache="6">
- <a name="methods" jstcache="0"></a>
- <h3 jstcache="0">Methods</h3>
+ <div class="apiGroup" id="methods">
+ <a name="methods"></a>
+ <h3>Methods</h3>
<!-- iterates over all functions -->
- <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11">
- <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- method-anchor -->
- <h4 jscontent="name" jstcache="16">method name</h4>
+ <div class="apiItem">
+ <a></a> <!-- method-anchor -->
+ <h4>method name</h4>
- <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">void</span>
+ <div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
- <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span>
- <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div>
+ <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
+ <var><span></span></var></span>)</div>
- <div class="description" jstcache="0">
- <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>
- <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">
+ <div class="description">
+ <p class="todo">Undocumented.</p>
+ <p>
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
- <h4 jstcache="0">Parameters</h4>
- <dl jstcache="0">
- <div jsselect="parameters" jstcache="35">
-
- <!-- VALUE: This is a subtemplate that is used elsewhere
- via jsTemplate *transclude* -->
- <div id="valueTemplate" jstcache="0">
- <dt jstcache="0">
- <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">paramName</var>
- <em jstcache="0">
-
- <!-- TYPE -->
- <div style="display:inline" jstcache="0">
- (
- <span class="optional" jsdisplay="optional" jstcache="47">optional</span>
- <span id="typeTemplate" jstcache="0">
- <span jsdisplay="getTypeRef($this)" jstcache="48">
- <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a>
- </span>
- <span jsdisplay="!getTypeRef($this)" jstcache="49">
- <span jsdisplay="isArray($this)" jstcache="51">
- array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span>
- </span>
- <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">paramType</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" jsdisplay="!$this.description" jstcache="39">
- Undocumented.
- </dd>
- <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40">
- Description of this parameter from the json schema.
- </dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd jsdisplay="shouldExpandObject($this)" jstcache="41">
- <dl jstcache="0">
- <div jsselect="getPropertyListFromObject($this)" jstcache="10">
- <div transclude="valueTemplate" jstcache="17">
- </div>
- </div>
- </dl>
- </dd>
- </div> <!-- /VALUE -->
-
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
</div>
</dl>
<!-- RETURNS -->
- <h4 jsdisplay="returns" jstcache="30">Returns</h4>
- <dl jstcache="0">
- <div jsselect="returns" jstcache="36">
- <div transclude="valueTemplate" jstcache="17">
+ <h4>Returns</h4>
+ <dl>
+ <div>
+ <div>
</div>
</div>
</dl>
<!-- CALLBACK -->
- <div jsdisplay="hasCallback(parameters)" jstcache="31">
- <div jsselect="getCallbackParameters(parameters)" jstcache="37">
- <h4 jstcache="0">Callback function</h4>
- <p jstcache="0">
- If you specify the <em jstcache="0">callback</em> parameter,
+ <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 jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre>
- <dl jstcache="0">
- <div jsselect="parameters" jstcache="35">
- <div transclude="valueTemplate" jstcache="17">
+ <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
+ <dl>
+ <div>
+ <div>
</div>
</div>
</dl>
@@ -362,31 +363,31 @@ of hosts, it must declare the permissions separately:</p>
</div> <!-- /apiGroup -->
<!-- EVENTS -->
- <div jsdisplay="events &amp;&amp; events.length &gt; 0" class="apiGroup" jstcache="7">
- <a name="events" jstcache="0"></a>
- <h3 id="events" jstcache="0">Events</h3>
+ <div class="apiGroup">
+ <a name="events"></a>
+ <h3 id="events">Events</h3>
<!-- iterates over all events -->
- <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12">
- <a jsvalues=".name:'event-' + name" jstcache="19"></a>
- <h4 jscontent="name" jstcache="16">event name</h4>
+ <div class="apiItem">
+ <a></a>
+ <h4>event name</h4>
- <div class="summary" jstcache="0">
+ <div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);
+ <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);
</div>
- <div class="description" jstcache="0">
- <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>
- <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">
+ <div class="description">
+ <p class="todo">Undocumented.</p>
+ <p>
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
- <h4 jstcache="0">Parameters</h4>
- <dl jstcache="0">
- <div jsselect="parameters" jstcache="35">
- <div transclude="valueTemplate" jstcache="17">
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
</div>
</div>
</dl>
@@ -398,16 +399,16 @@ of hosts, it must declare the permissions separately:</p>
</div> <!-- /apiGroup -->
<!-- TYPES -->
- <div jsdisplay="types &amp;&amp; types.length &gt; 0" class="apiGroup" jstcache="8">
- <a name="types.sort(sortByName)" jstcache="0"></a>
- <h3 id="types" jstcache="0">Types</h3>
+ <div class="apiGroup">
+ <a name="types.sort(sortByName)"></a>
+ <h3 id="types">Types</h3>
<!-- iterates over all types -->
- <div jsselect="types" class="apiItem" jstcache="13">
- <a jsvalues=".name:'type-' + id" jstcache="20"></a>
- <h4 jscontent="id" jstcache="21">type name</h4>
+ <div class="apiItem">
+ <a></a>
+ <h4>type name</h4>
- <div transclude="valueTemplate" jstcache="17">
+ <div>
</div>
</div> <!-- /apiItem -->
@@ -417,17 +418,17 @@ of hosts, it must declare the permissions separately:</p>
</div> <!-- /apiPage -->
</div> <!-- /mainColumn -->
</div> <!-- /pageContent -->
- <div id="pageFooter" --="" jstcache="0">
- <p jstcache="0">
- Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache="0">noted</a>,
- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons
+ <div id="pageFooter" --="">
+ <p>
+ Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
+ the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
- <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD License</a>.
+ <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
- <p jstcache="0">
+ <p>
©2009 Google
</p>
</div> <!-- /pageFooter -->
</div> <!-- /container -->
</body></html>
-#EOF
+