| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: 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 mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated 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>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta 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="pageTitle" jstcache="1">Overview</title> <link href="css/A
piRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="te
xt/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstc
ache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js
" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" js
tcache="0"></script> </head><!-- <body> content is completely generated. Do not
edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" js
tcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHe
ader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="
breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Exten
sions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a
href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="h1He
ader" jstcache="2">Overview</span> </div> <div id="searchbox" jstcache="0"> <for
m action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstc
ache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtn
o" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <inp
ut type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" v
alue="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="h
ttp://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript
" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</scr
ipt> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?for
m=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/ja
vascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang
=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jsconte
nt="h1Header" jstcache="2">Overview</h1> </div> </div> <!-- /pageHeader --> <div
id="pageContent" jstcache="0"> <!-- 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">Get Started</a></l
i> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li
jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html
" jstcache="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstca
che="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" jstc
ache="0">Background pages</a> </li><li jstcache="0"><a href="content_scripts.htm
l" jstcache="0">Content scripts</a> </li><li jstcache="0"><a href="tabs.html" js
tcache="0">Tabs</a> </li><li jstcache="0"><a href="windows.html" jstcache="0">Wi
ndows</a> </li><li jstcache="0"><a href="self.html" jstcache="0">Self</a> </li><
li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jst
cache="0"><a href="packaging.html" jstcache="0">Packaging</a> </li><li jstcache=
"0"><a href="autoupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li js
tcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1] </li><li jstcac
he="0">[sample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0"
> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"
style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jst
cache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <l
i jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <
li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol
> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcac
he="0"> <li jsselect="functions" jstcache="4"> <a jscontent="name" jsvalues=".hr
ef:'#method-' + name" href="#method-anchor" jstcache="17">methodName</a> </li> <
/ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstca
che="0"> <li jsselect="events" jstcache="5"> <a jscontent="name" jsvalues=".href
:'#event-' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol>
</li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a hre
f="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><
a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PEND
ING: links to all h2s and h3s should go here -- would it be possible to link to
overview h3s, as well? if so, how should we create their anchor/id values?] </di
v> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="stat
ic" jstcache="0"><p jstcache="0"> This page should perhaps be renamed from "over
view" to "concepts". In any case, what I'd like to cover here is the conceptual
underpinning of extensions, such as: </p><ul jstcache="0"> <li jstcache="0">Zip
file of web pages </li><li jstcache="0">All resources accessible with a URL sche
me </li><li jstcache="0">How IDs are generated </li><li jstcache="0">The manifes
t </li><li jstcache="0">The background page, how extensions are typically struct
ured </li><li jstcache="0">Process model </li><li jstcache="0">Content scripts (
lightweight, link off to other page for details) </li><li jstcache="0">Asynchron
ous APIs </li><li jstcache="0">Extension IDs, how they are generated </li><li js
tcache="0">How packaging works at a high level (lightweight, link off to other p
age for details) </li></ul></div> <!-- API PAGE --> <div class="apiPage" jsselec
t="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div cl
ass="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <
h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="ap
iItem" jsselect="functions" jstcache="4"> <a jsvalues=".name:'method-' + name" j
stcache="6"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="7">method
name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent
="returns.typeName" jstcache="9">void</span> <!-- Note: intentionally longer 80
columns --> <span jscontent="fullName" jstcache="10">chrome.module.methodName</s
pan>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jst
cache="11"><span jsdisplay="$index" jstcache="19">, </span><span jscontent="type
Name" jstcache="20"></span> <var jstcache="0"><span jscontent="name" jstcache="7
"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="t
odo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="desc
ription" jsvalues=".innerHTML:description" jstcache="13"> A description from the
json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcach
e="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21"
> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconten
t="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" j
sdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jst
cache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descr
iption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsv
alues=".innerHTML:$this.description" jstcache="24"> Description of this paramete
r from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propert
yList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="
29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscon
tent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional
" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName"
jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.de
scription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this param
eter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --
> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcache="0"> <div jsse
lect="returns" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longer
80 columns --> <var jscontent="name" jstcache="7">paramName</var> <em jstcache="
0">(<span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd cl
ass="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd
jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache=
"24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROP
ERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div j
sselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionall
y longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em js
tcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional
</span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd
class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd>
<dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcac
he="24"> Description of this parameter from the json schema. </dd> </div> </dl>
</dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jst
cache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you spec
ify the <em jstcache="0">callback</em> parameter, it should specify a function t
hat looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre js
tcache="0">function(<span jscontent="callbackSignature" jstcache="26">Type param
1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <
dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27"> <dt jstcache=
"0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac
he="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20
">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j
stcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".i
nnerHTML:$this.description" jstcache="24"> Description of this parameter from th
e json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" js
tcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt
jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam
e" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdispl
ay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache=
"20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description
" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=
".innerHTML:$this.description" jstcache="24"> Description of this parameter from
the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /desc
ription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <
div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></
a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <d
iv jsselect="events" class="apiItem" jstcache="5"> <a jsvalues=".name:'event-' +
name" jstcache="8"></a> <h3 jscontent="name" jstcache="7">event name</h3> <div
class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <sp
an class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" j
stcache="7">onEvent</span><span class="subdued" jstcache="0">.addListener</span>
(function(<span jscontent="callSignature" jstcache="16">Type param1, Type param2
</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="de
scription" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">
Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" j
stcache="13"> A description from the json schema def of the event goes here. </p
> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div js
select="parameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally lo
nger 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcac
he="0"> (<span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <
dd class="todo" jsdisplay="!$this.description" jstcache="23">Undocumented.</dd>
<dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcac
he="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT P
ROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <di
v jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intention
ally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em
jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">option
al </span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt>
<dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </d
d> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jst
cache="24"> Description of this parameter from the json schema. </dd> </div> </d
l> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div
> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div>
<!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <
br jstcache="0"> TBD: copyright/license should be automatically included here </
div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> | 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: 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 mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated 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>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta 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="pageTitle" jstcache="1">Overview</title> <link href="css/A
piRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="te
xt/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstc
ache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js
" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" js
tcache="0"></script> </head><!-- <body> content is completely generated. Do not
edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" js
tcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHe
ader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="
breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Exten
sions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a
href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="h1He
ader" jstcache="2">Overview</span> </div> <div id="searchbox" jstcache="0"> <for
m action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstc
ache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtn
o" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <inp
ut type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" v
alue="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="h
ttp://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript
" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</scr
ipt> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?for
m=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/ja
vascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang
=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jsconte
nt="h1Header" jstcache="2">Overview</h1> </div> </div> <!-- /pageHeader --> <div
id="pageContent" jstcache="0"> <!-- 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">Get Started</a></l
i> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li
jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html
" jstcache="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstca
che="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" jstc
ache="0">Background pages</a> </li><li jstcache="0"><a href="content_scripts.htm
l" jstcache="0">Content scripts</a> </li><li jstcache="0"><a href="extension.htm
l" jstcache="0">Extension</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="self.html" jstcache="0">Self</a> </li><li jst
cache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jstcache=
"0"><a href="packaging.html" jstcache="0">Packaging</a> </li><li jstcache="0"><a
href="autoupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li jstcache
="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1] </li><li jstcache="0"
>[sample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0"> <!--
TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style
="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache=
"0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstc
ache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jst
cache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li
> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"
> <li jsselect="functions" jstcache="4"> <a jscontent="name" jsvalues=".href:'#m
ethod-' + name" href="#method-anchor" jstcache="17">methodName</a> </li> </ol> <
/li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0
"> <li jsselect="events" jstcache="5"> <a jscontent="name" jsvalues=".href:'#eve
nt-' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li>
<!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#st
ructs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href
="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: l
inks to all h2s and h3s should go here -- would it be possible to link to overvi
ew h3s, as well? if so, how should we create their anchor/id values?] </div> <!-
- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" js
tcache="0"><p jstcache="0"> This page should perhaps be renamed from "overview"
to "concepts". In any case, what I'd like to cover here is the conceptual underp
inning of extensions, such as: </p><ul jstcache="0"> <li jstcache="0">Zip file o
f web pages </li><li jstcache="0">All resources accessible with a URL scheme </l
i><li jstcache="0">How IDs are generated </li><li jstcache="0">The manifest </li
><li jstcache="0">The background page, how extensions are typically structured <
/li><li jstcache="0">Process model </li><li jstcache="0">Content scripts (lightw
eight, link off to other page for details) </li><li jstcache="0">Asynchronous AP
Is </li><li jstcache="0">Extension IDs, how they are generated </li><li jstcache
="0">How packaging works at a high level (lightweight, link off to other page fo
r details) </li></ul></div> <!-- API PAGE --> <div class="apiPage" jsselect="api
Definition" jstcache="3" style="display: none; "> <!-- METHODS --> <div class="a
piGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jst
cache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem"
jsselect="functions" jstcache="4"> <a jsvalues=".name:'method-' + name" jstcach
e="6"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="7">method name<
/h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="retu
rns.typeName" jstcache="9">void</span> <!-- Note: intentionally longer 80 column
s --> <span jscontent="fullName" jstcache="10">chrome.module.methodName</span>(<
span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache=
"11"><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName"
jstcache="20"></span> <var jstcache="0"><span jscontent="name" jstcache="7"></sp
an></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" j
sdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="descriptio
n" jsvalues=".innerHTML:description" jstcache="13"> 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="21"> <dt
jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam
e" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdispl
ay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache=
"20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description
" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=
".innerHTML:$this.description" jstcache="24"> Description of this parameter from
the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList"
jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <
dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="
name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdi
splay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcac
he="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descript
ion" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalu
es=".innerHTML:$this.description" jstcache="24"> Description of this parameter f
rom the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4
jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcache="0"> <div jsselect="
returns" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longer 80 col
umns --> <var jscontent="name" jstcache="7">paramName</var> <em jstcache="0">(<s
pan jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="t
odo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdis
play="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24">
Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES
--> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselec
t="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally long
er 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache
="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span
><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class
="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd js
display="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24
"> Description of this parameter from the json schema. </dd> </div> </dl> </dd>
</div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="1
5"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the
<em jstcache="0">callback</em> parameter, it should specify a function that look
s like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="
0">function(<span jscontent="callbackSignature" jstcache="26">Type param1, Type
param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstca
che="0"> <div jsselect="callbackParameters" jstcache="27"> <dt jstcache="0"> <!-
- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">p
aramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramT
ype</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache=
"23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML
:$this.description" jstcache="24"> Description of this parameter from the json s
chema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="
25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache
="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstca
che="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="opti
onal" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">par
amType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcac
he="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerH
TML:$this.description" jstcache="24"> Description of this parameter from the jso
n schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description
--> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div clas
s="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 i
d="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jssel
ect="events" class="apiItem" jstcache="5"> <a jsvalues=".name:'event-' + name" j
stcache="8"></a> <h3 jscontent="name" jstcache="7">event name</h3> <div class="s
ummary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class
="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache=
"7">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(functio
n(<span jscontent="callSignature" jstcache="16">Type param1, Type param2</span>)
<span class="subdued" jstcache="0">{...}</span>); </div> <div class="descriptio
n" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocume
nted.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache=
"13"> A description from the json schema def of the event goes here. </p> <!-- P
ARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="
parameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80
columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0">
(<span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class
="todo" jsdisplay="!$this.description" jstcache="23">Undocumented.</dd> <dd jsdi
splay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24">
Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIE
S --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jssele
ct="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally lon
ger 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcach
e="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </spa
n><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd clas
s="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd j
sdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="2
4"> Description of this parameter from the json schema. </dd> </div> </dl> </dd>
</div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /
apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /p
ageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstca
che="0"> TBD: copyright/license should be automatically included here </div> <!-
- /pageFooter --> </div> <!-- /container --> </body></html> |
Chromium Code Reviews
Issue 165323:
Add chrome.extension to extension_api.json and docs (Closed)
