| 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">Index</title> <link href="css/ApiR
efStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/
javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcach
e="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" j
stcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstca
che="0"></script> </head><!-- <body> content is completely generated. Do not edi
t, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstca
che="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeade
r" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="bre
adcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensio
ns</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a hr
ef="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="h1Heade
r" jstcache="2">Index</span> </div> <div id="searchbox" jstcache="0"> <form acti
on="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="
0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jst
cache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input typ
e="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="
Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://
www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstc
ache="0">google.load("elements", "1", {packages: "transliteration"});</script> <
script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-
search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascri
pt" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" j
stcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1
Header" jstcache="2">Index</h1> </div> </div> <!-- /pageHeader --> <div id="page
Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc
ache="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></li> <li js
tcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache=
"0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcach
e="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstcache="0">T
oolstrips</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" jstcac
he="0">Content scripts</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 jstcac
he="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 hr
ef="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">[s
ample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0"> <!-- TA
BLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="d
isplay: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"
> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcach
e="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcac
he="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:'#meth
od-' + 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:'#event-
' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-
- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#struc
ts" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#
struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: link
s 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?] </div> <!-- /
TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstca
che="0"><p jstcache="0"> If you want to customize Google Chrome, you've come to
the right place. An <em jstcache="0">extension</em> is a bundle of web
code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a
bit of user interface (usually both) to the browser. <a href="http://dev.ch
romium.org/developers/design-documents/extensions/samples" jstcache="0">Examples
of extensions</a> include a mail checker, a newsfeed subscriber, and a sta
tus monitor.<br jstcache="0"> </p> <p jstcache="0">[Maybe add some nice enticing
pictures of toolstrips and moles (when we have them)]</p> <p jstcache="0">If yo
u just want to dive in, try <a href="getstarted.html" jstcache="0">Get Started</
a>. Otherwise, if you'd prefer to start with the high level overview, try <a hre
f="overview.html" jstcache="0">Overview</a>. </p></div> <!-- API PAGE --> <div c
lass="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!
-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#method
s" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functi
ons --> <div class="apiItem" jsselect="functions" jstcache="4"> <a jsvalues=".na
me:'method-' + name" jstcache="6"></a> <!-- method-anchor --> <h3 jscontent="nam
e" jstcache="7">method name</h3> <div class="summary" jstcache="0"><span jsdispl
ay="returns" jscontent="returns.typeName" jstcache="9">void</span> <!-- Note: in
tentionally longer 80 columns --> <span jscontent="fullName" jstcache="10">chrom
e.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 jscont
ent="name" jstcache="7"></span></var></span>)</div> <div class="description" jst
cache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.<
/p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13">
A description from the json schema def of the function goes here. </p> <!-- PARA
METERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="par
ameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 col
umns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<s
pan class="optional" jsdisplay="optional" jstcache="28">optional </span><span js
content="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" j
sdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="
$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descri
ption of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <
dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_pr
opertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 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 jsdispla
y="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Des
cription of this parameter from the json schema. </dd> </div> </dl> </dd> </div>
</dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl j
stcache="0"> <div jsselect="returns" jstcache="22"> <dt jstcache="0"> <!-- Note:
intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramNam
e</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramType</sp
an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> U
ndocumented. </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"> <d
l 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" jsdisplay="optional" j
stcache="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:$th
is.description" jstcache="24"> Description of this parameter from the json schem
a. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay=
"callbackParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p j
stcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it sho
uld specify a function that looks like this: </p> <!-- Note: intentionally longe
r 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature"
jstcache="26">Type param1, Type param2</span>) <span class="subdued" jstcache="0
">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstc
ache="27"> <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" jsdispla
y="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.d
escription" jsvalues=".innerHTML:$this.description" jstcache="24"> Description o
f this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdi
splay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyL
ist" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns
--> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span
class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscont
ent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdis
play="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$thi
s.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descriptio
n of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl>
</div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGro
up --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="
#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterate
s over all events --> <div jsselect="events" class="apiItem" jstcache="5"> <a js
values=".name:'event-' + name" jstcache="8"></a> <h3 jscontent="name" jstcache="
7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally l
onger 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span>
<span jscontent="name" jstcache="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="description" jstcache="0"> <p class="todo" jsdisplay="!des
cription" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".
innerHTML:description" jstcache="13"> 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="21"> <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 sch
ema. </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" jstcach
e="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="option
al" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">param
Type</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache
="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTM
L:$this.description" jstcache="24"> 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> <!-- /pageContent --> <div id="pageFooter" --="" jstcac
he="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automa
tically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </b
ody></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">Index</title> <link href="css/ApiR
efStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/
javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcach
e="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" j
stcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstca
che="0"></script> </head><!-- <body> content is completely generated. Do not edi
t, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstca
che="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeade
r" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="bre
adcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensio
ns</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a hr
ef="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="h1Heade
r" jstcache="2">Index</span> </div> <div id="searchbox" jstcache="0"> <form acti
on="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="
0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jst
cache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input typ
e="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="
Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://
www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstc
ache="0">google.load("elements", "1", {packages: "transliteration"});</script> <
script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-
search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascri
pt" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" j
stcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1
Header" jstcache="2">Index</h1> </div> </div> <!-- /pageHeader --> <div id="page
Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc
ache="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></li> <li js
tcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache=
"0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcach
e="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstcache="0">T
oolstrips</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" jstcac
he="0">Content scripts</a> </li><li jstcache="0"><a href="extension.html" jstcac
he="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 jstcache="0"
><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jstcache="0"><a hr
ef="packaging.html" jstcache="0">Packaging</a> </li><li jstcache="0"><a href="au
toupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li jstcache="0">Samp
les <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 h
ref="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li 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 jst
cache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jss
elect="functions" jstcache="4"> <a jscontent="name" jsvalues=".href:'#method-' +
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 js
select="events" jstcache="5"> <a jscontent="name" jsvalues=".href:'#event-' + na
me" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO
: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" js
tcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct
-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to a
ll h2s and h3s should go here -- would it be possible to link to overview h3s, a
s well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE
OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0
"><p jstcache="0"> If you want to customize Google Chrome, you've come to the ri
ght place. An <em jstcache="0">extension</em> is a bundle of web code
(HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of
user interface (usually both) to the browser. <a href="http://dev.chromium
.org/developers/design-documents/extensions/samples" jstcache="0">Examples of ex
tensions</a> include a mail checker, a newsfeed subscriber, and a status mo
nitor.<br jstcache="0"> </p> <p jstcache="0">[Maybe add some nice enticing pictu
res of toolstrips and moles (when we have them)]</p> <p jstcache="0">If you just
want to dive in, try <a href="getstarted.html" jstcache="0">Get Started</a>. Ot
herwise, if you'd prefer to start with the high level overview, try <a href="ove
rview.html" jstcache="0">Overview</a>. </p></div> <!-- API PAGE --> <div class="
apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- MET
HODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jst
cache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --
> <div class="apiItem" jsselect="functions" jstcache="4"> <a jsvalues=".name:'me
thod-' + name" jstcache="6"></a> <!-- method-anchor --> <h3 jscontent="name" jst
cache="7">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="re
turns" jscontent="returns.typeName" jstcache="9">void</span> <!-- Note: intentio
nally longer 80 columns --> <span jscontent="fullName" jstcache="10">chrome.modu
le.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'opt
ional' : ''" jstcache="11"><span jsdisplay="$index" jstcache="19">, </span><span
jscontent="typeName" jstcache="20"></span> <var jstcache="0"><span jscontent="n
ame" jstcache="7"></span></var></span>)</div> <div class="description" jstcache=
"0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p
jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13"> A desc
ription from the json schema def of the function goes here. </p> <!-- PARAMETERS
--> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameter
s" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns -
-> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span cl
ass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconten
t="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdispl
ay="!$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 jsd
isplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_property
List" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column
s --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span
class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscon
tent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdi
splay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$th
is.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descripti
on of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl>
<!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcach
e="0"> <div jsselect="returns" jstcache="22"> <dt jstcache="0"> <!-- Note: inten
tionally 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"> Undocum
ented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descri
ption" jstcache="24"> Description of this parameter from the json schema. </dd>
<!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstc
ache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- No
te: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">param
Name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcach
e="28">optional </span><span jscontent="typeName" jstcache="20">paramType</span>
)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undo
cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des
cription" jstcache="24"> Description of this parameter from the json schema. </d
d> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbac
kParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache=
"0"> If you specify the <em jstcache="0">callback</em> parameter, it should spec
ify a function that looks like this: </p> <!-- Note: intentionally longer 80 col
umns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache
="26">Type param1, 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 jsconte
nt="name" jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeNa
me" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$thi
s.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descripti
on" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this p
arameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_
propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jst
cache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va
r jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="o
ptional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typ
eName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$
this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descri
ption" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of thi
s parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <
/div> <!-- /description --> </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 a
ll events --> <div 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 --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span js
content="name" jstcache="7">onEvent</span><span class="subdued" jstcache="0">.ad
dListener</span>(function(<span jscontent="callSignature" jstcache="16">Type par
am1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div
> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description
" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTM
L:description" jstcache="13"> A description from the json schema def of the even
t goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstca
che="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</spa
n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23">Und
ocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des
cription" jstcache="24"> Description of this parameter from the json schema. </d
d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl j
stcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!--
Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa
ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc
ache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</sp
an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> U
ndocumented. </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> <!-- /decription --> </div> <!-- /a
piItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainC
olumn --> </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></ht
ml> |
Chromium Code Reviews
Issue 165323:
Add chrome.extension to extension_api.json and docs (Closed)
