| OLD | NEW |
| 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="getPageTitle()" jstcache="1">chrome.extension</title> <lin
k href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <sc
ript type="text/javascript" src="../../../third_party/jstemplate/jstemplate_comp
iled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page
_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/boo
tstrap.js" jstcache="0"></script> </head><!-- <body> content is completely gener
ated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="
container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <d
iv 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" jstcac
he="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="Sea
rch" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www
.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcach
e="0">google.load("elements", "1", {packages: "transliteration"});</script> <scr
ipt type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-sea
rch-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript"
src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstc
ache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPa
geTitle()" jstcache="1">chrome.extension</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">Getting Start
ed</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">De
veloper'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.htm
l" 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">Events</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">Themes</li> <l
i jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstc
ache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="
0">Autoupdate</li> </ul> </li> <li jstcache="0"><a href="tutorials.html" jstcach
e="0"><div jstcache="0">Tutorials</div></a> <ul jstcache="0"> <li jstcache="0"><
a href="tut_debugging.html" jstcache="0">Debugging</a></li> </ul> </li> <li jstc
ache="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">Match Patterns</li> <li jstcache="0">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> </l
i> </ul> </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/desi
gn-documents/extensions/samples" jstcache="0">Samples</a></li> </ul> </div> <div
id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdispla
y="showPageTOC()" jstcache="2"> <p jstcache="0">Contents</p> <ol jstcache="0"> <
li jsselect="getStaticTOC()" jstcache="9" jsinstance="*0" style="display: none;
"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Name</a> <ol
jstcache="0"> <li jsselect="$this.children" jstcache="22"> <a jscontent="name" j
svalues=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li> <div jssel
ect="apiDefinition" jstcache="3"> <li jstcache="0"> <a href="#apiReference" jsco
ntent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.e
xtension</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" jsinstance="*0"> <a jscontent="n
ame" jsvalues=".href:'#property-' + name" href="#property-lastError" jstcache="4
1">lastError</a> </li> </ol> </li> <li jsdisplay="functions && functions
.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol js
tcache="0"> <li jsselect="functions" jstcache="11" jsinstance="0"> <a jscontent=
"name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="42">c
onnect</a> </li><li jsselect="functions" jstcache="11" jsinstance="1"> <a jscont
ent="name" jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="
42">getViews</a> </li><li jsselect="functions" jstcache="11" jsinstance="2"> <a
jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getBackgroundP
age" jstcache="42">getBackgroundPage</a> </li><li jsselect="functions" jstcache=
"11" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href
="#method-getToolstrips" jstcache="42">getToolstrips</a> </li><li jsselect="func
tions" jstcache="11" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#meth
od-' + name" href="#method-getTabContentses" jstcache="42">getTabContentses</a>
</li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcach
e="7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect=
"events" jstcache="12" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#ev
ent-' + name" href="#event-onConnect" jstcache="43">onConnect</a> </li> </ol> </
li> <li jsdisplay="types && types.length > 0" jstcache="8"> <a href="
#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="
13" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#typ
e-Port" jstcache="44">Port</a> </li> </ol> </li> </ol> </li> </div> </ol> </div>
<!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static
" jstcache="0"></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefini
tion" jstcache="3"> <a name="apiReference" jstcache="0"></a> <h2 jscontent="'API
reference: ' + getModuleName()" jstcache="4">API reference: chrome.extension</h
2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="apiGroup" jstcac
he="5"> <a name="properties" jstcache="0"></a> <h3 id="properties" jstcache="0">
Properties</h3> <div jsselect="getPropertyListFromObject($this)" jstcache="10" j
sinstance="*0"> <a jsvalues=".name:'property-' + name" jstcache="15" name="prope
rty-lastError"></a> <h4 jscontent="name" jstcache="16">lastError</h4> <div class
="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span js
content="getModuleName() + '.'" jstcache="23">chrome.extension.</span><span jsco
ntent="$this.name" jstcache="24">lastError</span> </div> <div jstcache="0"> <dt
jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">l
astError</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstca
che="0"> ( <span class="optional" jsdisplay="optional" jstcache="46">optional</s
pan> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" j
stcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this)
+ '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Typ
e</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdispla
y="isArray($this)" jstcache="50" style="display: none; "> array of <span jsselec
t="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></s
pan> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" js
tcache="51">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo"
jsdisplay="!$this.description" jstcache="38" style="display: none; "> Undocument
ed. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descripti
on" jstcache="39">Set for the lifetime of a callback if an ansychronous extensio
n api has resulted in an error. If no error has occured lastError will be <var j
stcache="0">undefined</var>.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shou
ldExpandObject($this)" jstcache="40"> <dl jstcache="0"> <div jsselect="getProper
tyListFromObject($this)" jstcache="10" jsinstance="*0"> <div jstcache="0"> <dt j
stcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">me
ssage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache
="0"> ( <span class="optional" jsdisplay="optional" jstcache="46" style="display
: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay=
"getTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: g
etTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this
)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache
="48"> <span jsdisplay="isArray($this)" jstcache="50" style="display: none; "> a
rray of <span jsselect="items" jstcache="52"><span transclude="typeTemplate" jst
cache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="g
etTypeName($this)" jstcache="51">string</span> </span> </span> ) </div> </em> </
dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style="display
: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".inne
rHTML:$this.description" jstcache="39">Description of the error that has taken p
lace.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)"
jstcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPrope
rtyListFromObject($this)" jstcache="10"> <div transclude="valueTemplate" jstcach
e="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </div>
<!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions && functi
ons.length > 0" class="apiGroup" id="methods" jstcache="6"> <a name="methods"
jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- iterates over all function
s --> <div class="apiItem" jsselect="functions" jstcache="11" jsinstance="0"> <a
jsvalues=".name:'method-' + name" jstcache="18" name="method-connect"></a> <!--
method-anchor --> <h4 jscontent="name" jstcache="16">connect</h4> <div class="s
ummary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)"
jstcache="25">Port</span> <!-- Note: intentionally longer 80 columns --> <span j
scontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.c
onnect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional'
: ''" jstcache="27" jsinstance="*0" class="optional"><span jsdisplay="$index" js
tcache="33" style="display: none; ">, </span><span jscontent="getTypeName($this)
" jstcache="34">object</span> <var jstcache="0"><span jscontent="name" jstcache=
"16">connectInfo</span></var></span>)</div> <div class="description" jstcache="0
"> <p class="todo" jsdisplay="!description" jstcache="28" style="display: none;
">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description"
jstcache="29">Attempts to connect to other listeners within the extension (list
eners may be toolstrips or the extension's background page). This is primarily u
seful for content scripts connecting to their extension processes. Extensions ma
y connect to content scripts embedded in tabs via <a href="broken" jstcache="0">
<var jstcache="0">chrome.tabs.connectToTab</var></a>.</p> <!-- PARAMETERS --> <h
4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstc
ache="35" jsinstance="*0"> <!-- VALUE: This is a subtemplate that is used elsewh
ere via jsTemplate *transclude* --> <div id="valueTemplate" jstcache="0"> <dt js
tcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">con
nectInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstca
che="0"> ( <span class="optional" jsdisplay="optional" jstcache="46">optional</s
pan> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" j
stcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this)
+ '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Typ
e</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdispla
y="isArray($this)" jstcache="50" style="display: none; "> array of <span jsselec
t="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></s
pan> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" js
tcache="51">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo"
jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdisplay=
"$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style=
"display: none; "> Description of this parameter from the json schema. </dd> <!-
- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40">
<dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10
" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.na
me" jscontent="$this.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYPE
--> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay
="optional" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0">
<span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a js
values=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="
getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef(
$this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="dis
play: none; "> array of <span jsselect="items" jstcache="52"><span transclude="t
ypeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($thi
s)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> </span> )
</div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38
" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description" jstcache="39" style="">Will be passed i
nto onConnect for extension processes that are listening for the connection even
t.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jst
cache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getProperty
ListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemp
late" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div>
<!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="
30">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36"> <div j
stcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name
" jstcache="45" style="display: none; ">connectInfo</var> <em jstcache="0"> <!--
TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsd
isplay="optional" jstcache="46" style="display: none; ">optional</span> <span id
="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47"
style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($thi
s)" jscontent="getTypeRef($this)" jstcache="49" href="extension.html#type-Port">
Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48" style="displ
ay: none; "> <span jsdisplay="isArray($this)" jstcache="50" style="display: none
; "> array of <span jsselect="items" jstcache="52"><span transclude="typeTemplat
e" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscont
ent="getTypeName($this)" jstcache="51">object</span> </span> </span> ) </div> </
em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style="d
isplay: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=
".innerHTML:$this.description" jstcache="39" style="">Port through which message
s can be sent and received with the extension.</dd> <!-- OBJECT PROPERTIES --> <
dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display: none; ">
<dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"
jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.nam
e" jscontent="$this.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYPE -
-> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay=
"optional" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <
span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsv
alues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="g
etTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($
this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="disp
lay: none; "> array of <span jsselect="items" jstcache="52"><span transclude="ty
peTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this
)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> </span> )
</div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38"
style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description" jstcache="39" style="">Will be passed in
to onConnect for extension processes that are listening for the connection event
.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstc
ache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyL
istFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTempl
ate" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <
/div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcac
he="31" style="display: none; "> <div jsselect="getCallbackParameters(parameters
)" jstcache="37"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If yo
u specify the <em jstcache="0">callback</em> parameter, it should specify a func
tion that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <
pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstca
che="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{..
.}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <d
iv transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> <
/div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstc
ache="11" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="18" nam
e="method-getViews"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="1
6">getViews</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jsc
ontent="getTypeName(returns)" jstcache="25">array of object</span> <!-- Note: in
tentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName
($this)" jstcache="26">chrome.extension.getViews</span>(<span jsselect="paramete
rs" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" st
yle="display: none; "><span jsdisplay="$index" jstcache="33">, </span><span jsco
ntent="getTypeName($this)" jstcache="34"></span> <var jstcache="0"><span jsconte
nt="name" jstcache="16"></span></var></span>)</div> <div class="description" jst
cache="0"> <p class="todo" jsdisplay="!description" jstcache="28" style="display
: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:desc
ription" jstcache="29">Returns an array of the global JavaScript objects for eac
h of the views running inside the current extension. This includes toolstrips, b
ackground pages, and tabs.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</
h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsinstance="*0" s
tyle="display: none; "> <!-- VALUE: This is a subtemplate that is used elsewhere
via jsTemplate *transclude* --> <div id="valueTemplate" jstcache="0"> <dt jstca
che="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">paramN
ame</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="
0"> ( <span class="optional" jsdisplay="optional" jstcache="46">optional</span>
<span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcac
he="47"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this
)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay
="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="
50"> array of <span jsselect="items" jstcache="52"><span transclude="typeTemplat
e" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscont
ent="getTypeName($this)" jstcache="51">paramType</span> </span> </span> ) </div>
</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38"> Undo
cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des
cription" jstcache="39"> Description of this parameter from the json schema. </d
d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache
="40"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcac
he="10"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd
> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" j
stcache="30">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36
"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$
this.name" jstcache="45" style="display: none; ">connectInfo</var> <em jstcache=
"0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="opti
onal" jsdisplay="optional" jstcache="46" style="display: none; ">optional</span>
<span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstca
che="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#
type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a
> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="i
sArray($this)" jstcache="50" style=""> array of <span jsselect="items" jstcache=
"52"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style
="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTy
peRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <spa
n jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)"
jstcache="50" style="display: none; "> array of <span jsselect="items" jstcache
="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span
jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">object
</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jsconte
nt="getTypeName($this)" jstcache="51" style="display: none; ">object</span> </sp
an> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description"
jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this
.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="">Arr
ay of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpand
Object($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div jss
elect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div jst
cache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name"
jstcache="45">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inl
ine" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="46">o
ptional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef
($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPa
ge($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache
="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <spa
n jsdisplay="isArray($this)" jstcache="50" style="display: none; "> array of <sp
an jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53">
</span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName(
$this)" jstcache="51">string</span> </span> </span> ) </div> </em> </dt> <dd cla
ss="todo" jsdisplay="!$this.description" jstcache="38" style="display: none; ">
Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this
.description" jstcache="39" style="">Will be passed into onConnect for extension
processes that are listening for the connection event.</dd> <!-- OBJECT PROPERT
IES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display:
none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstc
ache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="17"> </div>
</div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK
--> <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display:
none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="37"> <h4 js
tcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcac
he="0">callback</em> parameter, it should specify a function that looks like thi
s: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">functio
n(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Ty
pe param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl js
tcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemp
late" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /description
--> </div><div class="apiItem" jsselect="functions" jstcache="11" jsinstance="2"
> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getBackgroundP
age"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">getBackgroun
dPage</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent
="getTypeName(returns)" jstcache="25">object</span> <!-- Note: intentionally lon
ger 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcac
he="26">chrome.extension.getBackgroundPage</span>(<span jsselect="parameters" js
values="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="d
isplay: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent=
"getTypeName($this)" jstcache="34"></span> <var jstcache="0"><span jscontent="na
me" jstcache="16"></span></var></span>)</div> <div class="description" jstcache=
"0"> <p class="todo" jsdisplay="!description" jstcache="28" style="display: none
; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:descriptio
n" jstcache="29">Returns the global JavaScript object for the background page ru
nning inside the current extension. Returns null if the extension has no backrou
nd page.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="
0"> <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: non
e; "> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate *t
ransclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var jsdi
splay="$this.name" jscontent="$this.name" jstcache="45">paramName</var> <em jstc
ache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class=
"optional" jsdisplay="optional" jstcache="46">optional</span> <span id="typeTemp
late" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47"> <a jsvalu
es=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getT
ypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($thi
s)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50"> array of <spa
n jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"><
/span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($
this)" jstcache="51">paramType</span> </span> </span> ) </div> </em> </dt> <dd c
lass="todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <d
d jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache
="39"> Description of this parameter from the json schema. </dd> <!-- OBJECT PRO
PERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"> <dl jstcach
e="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div tran
sclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /VAL
UE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30">Retur
ns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36"> <div jstcache="
0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcach
e="45" style="display: none; ">connectInfo</var> <em jstcache="0"> <!-- TYPE -->
<div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="o
ptional" jstcache="46" style="display: none; ">optional</span> <span id="typeTem
plate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="di
splay: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRe
f($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span js
display="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jst
cache="50" style="display: none; "> array of <span jsselect="items" jstcache="52
"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsd
isplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">object</sp
an> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.desc
ription" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" js
values=".innerHTML:$this.description" jstcache="39" style="display: none; "> Des
cription of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --
> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display: none;
"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="
10" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.
name" jscontent="$this.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYP
E --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdispl
ay="optional" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"
> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a
jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent
="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRe
f($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="d
isplay: none; "> array of <span jsselect="items" jstcache="52"><span transclude=
"typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($t
his)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> </span>
) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="
38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.descriptio
n" jsvalues=".innerHTML:$this.description" jstcache="39" style="">Will be passed
into onConnect for extension processes that are listening for the connection ev
ent.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" j
stcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getProper
tyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTe
mplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div
> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)
" jstcache="31" style="display: none; "> <div jsselect="getCallbackParameters(pa
rameters)" jstcache="37"> <h4 jstcache="0">Callback function</h4> <p jstcache="0
"> If you specify the <em jstcache="0">callback</em> parameter, it should specif
y a function that looks like this: </p> <!-- Note: intentionally longer 80 colum
ns --> <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"> </div> </div> </dl> </div>
</div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functio
ns" jstcache="11" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache=
"18" name="method-getToolstrips"></a> <!-- method-anchor --> <h4 jscontent="name
" jstcache="16">getToolstrips</h4> <div class="summary" jstcache="0"><span jsdis
play="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</s
pan> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQua
lifiedFunctionName($this)" jstcache="26">chrome.extension.getToolstrips</span>(<
span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache=
"27" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="33" sty
le="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="34"
>integer</span> <var jstcache="0"><span jscontent="name" jstcache="16">windowId<
/span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo
" jsdisplay="!description" jstcache="28" style="display: none; ">Undocumented.</
p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">Re
turns an array of the global JavaScript objects for each of the toolstrip views
running inside the current extension. If windowId is specified, returns only the
toolstrips attached to the specified window.</p> <!-- PARAMETERS --> <h4 jstcac
he="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35
" jsinstance="*0"> <!-- 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="45">windowId</v
ar> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> (
<span class="optional" jsdisplay="optional" jstcache="46">optional</span> <span
id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47
" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-'
+ getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </spa
n> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray(
$this)" jstcache="50" style="display: none; "> array of <span jsselect="items" j
stcache="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span
> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51"
>integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay=
"!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.des
cription" jsvalues=".innerHTML:$this.description" jstcache="39" style="display:
none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT P
ROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="dis
play: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)
" jstcache="10"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </
dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="re
turns" jstcache="30">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstc
ache="36"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jsco
ntent="$this.name" jstcache="45" style="display: none; ">connectInfo</var> <em j
stcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span cla
ss="optional" jsdisplay="optional" jstcache="46" style="display: none; ">optiona
l</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this
)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($th
is) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49">
Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdi
splay="isArray($this)" jstcache="50" style=""> array of <span jsselect="items" j
stcache="52"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="4
7" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-'
+ getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </sp
an> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray
($this)" jstcache="50" style="display: none; "> array of <span jsselect="items"
jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></span> </spa
n> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51
">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)"
jscontent="getTypeName($this)" jstcache="51" style="display: none; ">object</sp
an> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.desc
ription" jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsdispla
y="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" styl
e="">Array of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shou
ldExpandObject($this)" jstcache="40" style="display: none; "> <dl jstcache="0">
<div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0">
<div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$thi
s.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYPE --> <div style="dis
play:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcach
e="46">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="ge
tTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: getT
ypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)"
jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="4
8"> <span jsdisplay="isArray($this)" jstcache="50" style="display: none; "> arra
y of <span jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcac
he="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getT
ypeName($this)" jstcache="51">string</span> </span> </span> ) </div> </em> </dt>
<dd class="todo" jsdisplay="!$this.description" jstcache="38" style="display: n
one; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT
ML:$this.description" jstcache="39" style="">Will be passed into onConnect for e
xtension processes that are listening for the connection event.</dd> <!-- OBJECT
PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="d
isplay: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($thi
s)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="17"
> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> <!-- C
ALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="31" style="d
isplay: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="37"
> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <e
m jstcache="0">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 pa
ram1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre
> <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="v
alueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /desc
ription --> </div><div class="apiItem" jsselect="functions" jstcache="11" jsinst
ance="*4"> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getTa
bContentses"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">getT
abContentses</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" js
content="getTypeName(returns)" jstcache="25">array of object</span> <!-- Note: i
ntentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionNam
e($this)" jstcache="26">chrome.extension.getTabContentses</span>(<span jsselect=
"parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstanc
e="*0" class="optional"><span jsdisplay="$index" jstcache="33" style="display: n
one; ">, </span><span jscontent="getTypeName($this)" jstcache="34">integer</span
> <var jstcache="0"><span jscontent="name" jstcache="16">windowId</span></var></
span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!
description" jstcache="28" style="display: none; ">Undocumented.</p> <p jsdispla
y="description" jsvalues=".innerHTML:description" jstcache="29">Returns an array
of the global JavaScript objects for each of the tab contents views running ins
ide the current extension. If windowId is specified, returns only the tab conten
tses attached to the specified window.</p> <!-- PARAMETERS --> <h4 jstcache="0">
Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsins
tance="*0"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTempl
ate *transclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <va
r jsdisplay="$this.name" jscontent="$this.name" jstcache="45">windowId</var> <em
jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span c
lass="optional" jsdisplay="optional" jstcache="46">optional</span> <span id="typ
eTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style
="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTy
peRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <spa
n jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)"
jstcache="50" style="display: none; "> array of <span jsselect="items" jstcache
="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span
jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">intege
r</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this
.description" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.descriptio
n" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none; "
> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTI
ES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display: n
one; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </d
d> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns"
jstcache="30">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="3
6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="
$this.name" jstcache="45" style="display: none; ">connectInfo</var> <em jstcache
="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="opt
ional" jsdisplay="optional" jstcache="46" style="display: none; ">optional</span
> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstc
ache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '
#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</
a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="
isArray($this)" jstcache="50" style=""> array of <span jsselect="items" jstcache
="52"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" styl
e="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getT
ypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <sp
an jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)
" jstcache="50" style="display: none; "> array of <span jsselect="items" jstcach
e="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <spa
n jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">objec
t</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscont
ent="getTypeName($this)" jstcache="51" style="display: none; ">object</span> </s
pan> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description
" jstcache="38" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$thi
s.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="">Ar
ray of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpan
dObject($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div js
select="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div js
tcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name"
jstcache="45">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:in
line" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="46">
optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRe
f($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefP
age($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcach
e="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <sp
an jsdisplay="isArray($this)" jstcache="50" style="display: none; "> array of <s
pan jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"
></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName
($this)" jstcache="51">string</span> </span> </span> ) </div> </em> </dt> <dd cl
ass="todo" jsdisplay="!$this.description" jstcache="38" style="display: none; ">
Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$thi
s.description" jstcache="39" style="">Will be passed into onConnect for extensio
n processes that are listening for the connection event.</dd> <!-- OBJECT PROPER
TIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display:
none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jst
cache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="17"> </div
> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK
--> <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display:
none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="37"> <h4 js
tcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcac
he="0">callback</em> parameter, it should specify a function that looks like thi
s: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">functio
n(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Ty
pe param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl js
tcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemp
late" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /description
--> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdi
splay="events && events.length > 0" class="apiGroup" jstcache="7"> <a
name="events" jstcache="0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- i
terates over all events --> <div jsselect="events" class="apiItem" jstcache="12"
jsinstance="*0"> <a jsvalues=".name:'event-' + name" jstcache="19" name="event-
onConnect"></a> <h4 jscontent="name" jstcache="16">onConnect</h4> <div class="su
mmary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscont
ent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.extension.</spa
n><span jscontent="name" jstcache="16">onConnect</span><span class="subdued" jst
cache="0">.addListener</span>(function(<span jscontent="getSignatureString(param
eters)" jstcache="32">Port port</span>) <span class="subdued" jstcache="0">{...}
</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdispla
y="!description" jstcache="28" style="display: none; ">Undocumented.</p> <p jsdi
splay="description" jsvalues=".innerHTML:description" jstcache="29">Fired when a
connection is made from either an extension process or a content script.</p> <!
-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jssele
ct="parameters" jstcache="35" jsinstance="*0"> <div jstcache="0"> <dt jstcache="
0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">port</var>
<em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <spa
n class="optional" jsdisplay="optional" jstcache="46" style="display: none; ">op
tional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef(
$this)" jstcache="47" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#ty
pe-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49" href="exte
nsion.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstc
ache="48" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="50
" style="display: none; "> array of <span jsselect="items" jstcache="52"><span t
ransclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!
isArray($this)" jscontent="getTypeName($this)" jstcache="51">object</span> </spa
n> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description"
jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".
innerHTML:$this.description" jstcache="39" style="display: none; "> Description
of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsd
isplay="shouldExpandObject($this)" jstcache="40" style="display: none; "> <dl js
tcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsins
tance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jsc
ontent="$this.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYPE --> <di
v style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optio
nal" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <span j
sdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues=
".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getType
Ref($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)"
jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="display: n
one; "> array of <span jsselect="items" jstcache="52"><span transclude="typeTemp
late" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jsc
ontent="getTypeName($this)" jstcache="51">string</span> </span> </span> ) </div>
</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style
="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalu
es=".innerHTML:$this.description" jstcache="39" style="">Will be passed into onC
onnect for extension processes that are listening for the connection event.</dd>
<!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="
40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFro
mObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" j
stcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div>
</dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup
--> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class=
"apiGroup" jstcache="8"> <a name="types" jstcache="0"></a> <h3 id="types" jstcac
he="0">Types</h3> <!-- iterates over all types --> <div jsselect="types" class="
apiItem" jstcache="13" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcach
e="20" name="type-Port"></a> <h4 jscontent="id" jstcache="21">Port</h4> <div jst
cache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name"
jstcache="45" style="display: none; ">connectInfo</var> <em jstcache="0"> <!-- T
YPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdis
play="optional" jstcache="46" style="display: none; ">optional</span> <span id="
typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" st
yle="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + ge
tTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <
span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($thi
s)" jstcache="50" style="display: none; "> array of <span jsselect="items" jstca
che="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <s
pan jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">obj
ect</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$th
is.description" jstcache="38" style="display: none; "> Undocumented. </dd> <dd j
sdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="3
9" style="">An object which allows two way communication with other pages.</dd>
<!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="4
0"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache=
"10" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.
name" jscontent="$this.name" jstcache="45">name</var> <em jstcache="0"> <!-- TYP
E --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdispl
ay="optional" jstcache="46" style="display: none; ">optional</span> <span id="ty
peTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" styl
e="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getT
ypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <sp
an jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)
" jstcache="50" style="display: none; "> array of <span jsselect="items" jstcach
e="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <spa
n jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">strin
g</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this
.description" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.d
escription" jsvalues=".innerHTML:$this.description" jstcache="39" style="display
: none; ">Will be passed into onConnect for extension processes that are listeni
ng for the connection event.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shou
ldExpandObject($this)" jstcache="40" style="display: none; "> <dl jstcache="0">
<div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0">
<div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div>
</div><div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance=
"1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent=
"$this.name" jstcache="45">onDisconnect</var> <em jstcache="0"> <!-- TYPE --> <d
iv style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="opti
onal" jstcache="46" style="display: none; ">optional</span> <span id="typeTempla
te" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="displ
ay: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($
this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdis
play="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcac
he="50" style="display: none; "> array of <span jsselect="items" jstcache="52"><
span transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisp
lay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">object</span>
</span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.descrip
tion" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.descripti
on" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none;
">Will be passed into onConnect for extension processes that are listening for t
he connection event.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpand
Object($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div jss
elect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div tra
nsclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div><d
iv jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="2"> <di
v jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.n
ame" jstcache="45">onMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="d
isplay:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstca
che="46" style="display: none; ">optional</span> <span id="typeTemplate" jstcach
e="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "
> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jsco
ntent="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getT
ypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" sty
le="display: none; "> array of <span jsselect="items" jstcache="52"><span transc
lude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArr
ay($this)" jscontent="getTypeName($this)" jstcache="51">object</span> </span> </
span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstca
che="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalue
s=".innerHTML:$this.description" jstcache="39" style="display: none; ">Will be p
assed into onConnect for extension processes that are listening for the connecti
on event.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($thi
s)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getP
ropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="va
lueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div><div jsselect
="getPropertyListFromObject($this)" jstcache="10" jsinstance="*3"> <div jstcache
="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="45">postMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:i
nline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="46"
style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <
span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsv
alues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="g
etTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($
this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="disp
lay: none; "> array of <span jsselect="items" jstcache="52"><span transclude="ty
peTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this
)" jscontent="getTypeName($this)" jstcache="51">function</span> </span> </span>
) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="3
8" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".in
nerHTML:$this.description" jstcache="39" style="display: none; ">Will be passed
into onConnect for extension processes that are listening for the connection eve
nt.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" js
tcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropert
yListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTem
plate" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div>
</div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </d
iv> <!-- /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/license
s/by/3.0/" jstcache="0">Creative Commons Attribution 3.0 License</a>, and code s
amples are licensed under the <a rel="license" href="http://code.google.com/goog
le_bsd_license.html" jstcache="0">BSD License</a>. </p> <p jstcache="0"> ©2009 G
oogle </p> </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> | 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: |
| 2 1) The <head> information in this page is significant, should be uniform |
| 3 across api docs and should be edited only with knowledge of the |
| 4 templating mechanism. |
| 5 2) The <body> tag *must* retain id="body" |
| 6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
| 7 browser, it will be re-generated from the template, json schema and |
| 8 authored overview content. |
| 9 4) The <body>.innerHTML is also generated by an offline step so that this |
| 10 page may easily be indexed by search engines. |
| 11 |
| 12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single |
| 13 version of page template shell and the "instance" pages (bookmarks.html, |
| 14 etc...) can be generated with a build step. |
| 15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x
html" jstcache="0"><!-- <head> data is significant and loads the needed librarie
s and styles --><head jstcache="0"> |
| 16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=
"0"> |
| 17 <title jscontent="getPageTitle()" jstcache="1">chrome.extension</title> |
| 18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache=
"0"> |
| 19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js" jstcache="0"> |
| 20 </script> |
| 21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"><
/script> |
| 22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> |
| 23 </head><!-- <body> content is completely generated. Do not edit, as it will be |
| 24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> |
| 25 <a name="top" jstcache="0"> </a> |
| 26 <!-- API HEADER --> |
| 27 <div id="pageHeader" jstcache="0"> |
| 28 <div id="searchbox" jstcache="0"> |
| 29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0
"> |
| 30 <div jstcache="0"> |
| 31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq
tno" jstcache="0"> |
| 32 <input type="hidden" name="ie" value="UTF-8" jstcache="0"> |
| 33 <input type="text" name="q" size="31" jstcache="0"> |
| 34 <input type="submit" name="sa" value="Search" jstcache="0"> |
| 35 </div> |
| 36 </form> |
| 37 |
| 38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach
e="0"></script> |
| 39 <script type="text/javascript" jstcache="0">google.load("elements", "1",
{packages: "transliteration"});</script> |
| 40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?
form=cse-search-box&t13n_langs=en" jstcache="0"></script> |
| 41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand
?form=cse-search-box&lang=en" jstcache="0"></script> |
| 42 </div> |
| 43 <div id="pageTitle" jstcache="0"> |
| 44 <h1 jscontent="getPageTitle()" jstcache="1">chrome.extension</h1> |
| 45 </div> |
| 46 </div> <!-- /pageHeader --> |
| 47 |
| 48 <div id="pageContent" jstcache="0"> |
| 49 <!-- SIDENAV --> |
| 50 <div id="leftNav" jstcache="0"> |
| 51 <ul jstcache="0"> |
| 52 <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> |
| 53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start
ed</a></li> |
| 54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l
i> |
| 55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="
0">Developer's Guide</div></a> |
| 56 <ul jstcache="0"> |
| 57 <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips<
/a></li> |
| 58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti
ons</a></li> |
| 59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back
ground Pages</a></li> |
| 60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte
nt Scripts</a></li> |
| 61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li
> |
| 62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> |
| 63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></
li> |
| 64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</
a></li> |
| 65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li
> |
| 66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</
a></li> |
| 67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</
a></li> |
| 68 <li jstcache="0">Autoupdate</li> |
| 69 </ul> |
| 70 </li> |
| 71 <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="
0">Tutorials</div></a> |
| 72 <ul jstcache="0"> |
| 73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi
ng</a></li> |
| 74 </ul> |
| 75 </li> |
| 76 <li jstcache="0">Reference |
| 77 <ul jstcache="0"> |
| 78 <li jstcache="0"> Formats |
| 79 <ul jstcache="0"> |
| 80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest
Files</a></li> |
| 81 <li jstcache="0"><a href="match_patterns.html" jstcache="0">Ma
tch Patterns</a></li> |
| 82 <li jstcache="0">Packages (.crx)</li> |
| 83 </ul> |
| 84 </li> |
| 85 <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* A
PIs</a> </li> |
| 86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs
</a> </li> |
| 87 </ul> |
| 88 </li> |
| 89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc
uments/extensions/samples" jstcache="0">Samples</a></li> |
| 90 </ul> |
| 91 </div> |
| 92 |
| 93 <div id="mainColumn" jstcache="0"> |
| 94 <!-- TABLE OF CONTENTS --> |
| 95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2"> |
| 96 <p jstcache="0">Contents</p> |
| 97 <ol jstcache="0"> |
| 98 <li jsselect="getStaticTOC()" jstcache="9" jsinstance="*0" style="di
splay: none; "> |
| 99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Na
me</a> |
| 100 <ol jstcache="0"> |
| 101 <li jsselect="$this.children" jstcache="22"> |
| 102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 103 </li> |
| 104 </ol> |
| 105 </li> |
| 106 <div jsselect="apiDefinition" jstcache="3"> |
| 107 <li jstcache="0"> |
| 108 <a href="#apiReference" jscontent="'API reference: ' + getModule
Name()" jstcache="4">API reference: chrome.extension</a> |
| 109 <ol jstcache="0"> |
| 110 <li jsdisplay="$this.properties" jstcache="5"> |
| 111 <a href="#properties" jstcache="0">Properties</a> |
| 112 <ol jstcache="0"> |
| 113 <li jsselect="getPropertyListFromObject($this)" jstcache="
10" jsinstance="*0"> |
| 114 <a jscontent="name" jsvalues=".href:'#property-' + name"
href="#property-lastError" jstcache="42">lastError</a> |
| 115 </li> |
| 116 </ol> |
| 117 </li> |
| 118 <li jsdisplay="functions && functions.length > 0" j
stcache="6"> |
| 119 <a href="#methods" jstcache="0">Methods</a> |
| 120 <ol jstcache="0"> |
| 121 <li jsselect="functions.sort(sortByName)" jstcache="11" js
instance="0"> |
| 122 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-connect" jstcache="43">connect</a> |
| 123 </li><li jsselect="functions.sort(sortByName)" jstcache="1
1" jsinstance="1"> |
| 124 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-getBackgroundPage" jstcache="43">getBackgroundPage</a> |
| 125 </li><li jsselect="functions.sort(sortByName)" jstcache="1
1" jsinstance="2"> |
| 126 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-getTabContentses" jstcache="43">getTabContentses</a> |
| 127 </li><li jsselect="functions.sort(sortByName)" jstcache="1
1" jsinstance="3"> |
| 128 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-getToolstrips" jstcache="43">getToolstrips</a> |
| 129 </li><li jsselect="functions.sort(sortByName)" jstcache="1
1" jsinstance="*4"> |
| 130 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-getViews" jstcache="43">getViews</a> |
| 131 </li> |
| 132 </ol> |
| 133 </li> |
| 134 <li jsdisplay="events && events.length > 0" jstcach
e="7"> |
| 135 <a href="#events" jstcache="0">Events</a> |
| 136 <ol jstcache="0"> |
| 137 <li jsselect="events.sort(sortByName)" jstcache="12" jsins
tance="*0"> |
| 138 <a jscontent="name" jsvalues=".href:'#event-' + name" hr
ef="#event-onConnect" jstcache="44">onConnect</a> |
| 139 </li> |
| 140 </ol> |
| 141 </li> |
| 142 <li jsdisplay="types && types.length > 0" jstcache=
"8"> |
| 143 <a href="#types" jstcache="0">Types</a> |
| 144 <ol jstcache="0"> |
| 145 <li jsselect="types.sort(sortByName)" jstcache="38" jsinst
ance="*0"> |
| 146 <a jscontent="id" jsvalues=".href:'#type-' + id" href="#
type-Port" jstcache="45">Port</a> |
| 147 </li> |
| 148 </ol> |
| 149 </li> |
| 150 </ol> |
| 151 </li> |
| 152 </div> |
| 153 </ol> |
| 154 </div> |
| 155 <!-- /TABLE OF CONTENTS --> |
| 156 |
| 157 <!-- STATIC CONTENT PLACEHOLDER --> |
| 158 <div id="static" jstcache="0"></div> |
| 159 |
| 160 <!-- API PAGE --> |
| 161 <div class="apiPage" jsselect="apiDefinition" jstcache="3"> |
| 162 <a name="apiReference" jstcache="0"></a> |
| 163 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref
erence: chrome.extension</h2> |
| 164 |
| 165 <!-- PROPERTIES --> |
| 166 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> |
| 167 <a name="properties" jstcache="0"></a> |
| 168 <h3 id="properties" jstcache="0">Properties</h3> |
| 169 |
| 170 <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsins
tance="*0"> |
| 171 <a jsvalues=".name:'property-' + name" jstcache="15" name="propert
y-lastError"></a> |
| 172 <h4 jscontent="name" jstcache="16">lastError</h4> |
| 173 <div class="summary" jstcache="0"> |
| 174 <!-- Note: intentionally longer 80 columns --> |
| 175 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext
ension.</span><span jscontent="$this.name" jstcache="24">lastError</span> |
| 176 </div> |
| 177 <div jstcache="0"> |
| 178 <dt jstcache="0"> |
| 179 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">lastError</var> |
| 180 <em jstcache="0"> |
| 181 |
| 182 <!-- TYPE --> |
| 183 <div style="display:inline" jstcache="0"> |
| 184 ( |
| 185 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 186 <span id="typeTemplate" jstcache="0"> |
| 187 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 188 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 189 </span> |
| 190 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 191 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 192 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 193 </span> |
| 194 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 195 </span> |
| 196 </span> |
| 197 ) |
| 198 </div> |
| 199 |
| 200 </em> |
| 201 </dt> |
| 202 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 203 Undocumented. |
| 204 </dd> |
| 205 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40">Set for the lifetime of a callback if an ansychron
ous extension api has resulted in an error. If no error has occured lastError wi
ll be <var jstcache="0">undefined</var>.</dd> |
| 206 |
| 207 <!-- OBJECT PROPERTIES --> |
| 208 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 209 <dl jstcache="0"> |
| 210 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 211 <div jstcache="0"> |
| 212 <dt jstcache="0"> |
| 213 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">message</var> |
| 214 <em jstcache="0"> |
| 215 |
| 216 <!-- TYPE --> |
| 217 <div style="display:inline" jstcache="0"> |
| 218 ( |
| 219 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 220 <span id="typeTemplate" jstcache="0"> |
| 221 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 222 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 223 </span> |
| 224 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 225 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 226 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 227 </span> |
| 228 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 229 </span> |
| 230 </span> |
| 231 ) |
| 232 </div> |
| 233 |
| 234 </em> |
| 235 </dt> |
| 236 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 237 Undocumented. |
| 238 </dd> |
| 239 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40">Description of the error that has taken place.</dd
> |
| 240 |
| 241 <!-- OBJECT PROPERTIES --> |
| 242 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 243 <dl jstcache="0"> |
| 244 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 245 <div transclude="valueTemplate" jstcache="17"> |
| 246 </div> |
| 247 </div> |
| 248 </dl> |
| 249 </dd> |
| 250 </div> |
| 251 </div> |
| 252 </dl> |
| 253 </dd> |
| 254 </div> |
| 255 </div> |
| 256 |
| 257 </div> <!-- /apiGroup --> |
| 258 |
| 259 <!-- METHODS --> |
| 260 <div jsdisplay="functions && functions.length > 0" class="a
piGroup" id="methods" jstcache="6"> |
| 261 <a name="methods" jstcache="0"></a> |
| 262 <h3 jstcache="0">Methods</h3> |
| 263 |
| 264 <!-- iterates over all functions --> |
| 265 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache=
"11" jsinstance="0"> |
| 266 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-co
nnect"></a> <!-- method-anchor --> |
| 267 <h4 jscontent="name" jstcache="16">connect</h4> |
| 268 |
| 269 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">Port</span> |
| 270 <!-- Note: intentionally longer 80 columns --> |
| 271 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.extension.connect</span>(<span jsselect="parameters" jsvalues="cla
ss:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><s
pan jsdisplay="$index" jstcache="33" style="display: none; ">, </span><span jsco
ntent="getTypeName($this)" jstcache="34">object</span> |
| 272 <var jstcache="0"><span jscontent="name" jstcache="16">con
nectInfo</span></var></span>)</div> |
| 273 |
| 274 <div class="description" jstcache="0"> |
| 275 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 276 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Attempts to connect to other listeners within the extension (listener
s may be toolstrips or the extension's background page). This is primarily usefu
l for content scripts connecting to their extension processes. Extensions may co
nnect to content scripts embedded in tabs via <a href="broken" jstcache="0"><var
jstcache="0">chrome.tabs.connectToTab</var></a>.</p> |
| 277 |
| 278 <!-- PARAMETERS --> |
| 279 <h4 jstcache="0">Parameters</h4> |
| 280 <dl jstcache="0"> |
| 281 <div jsselect="parameters" jstcache="35" jsinstance="*0"> |
| 282 |
| 283 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 284 via jsTemplate *transclude* --> |
| 285 <div id="valueTemplate" jstcache="0"> |
| 286 <dt jstcache="0"> |
| 287 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">connectInfo</var> |
| 288 <em jstcache="0"> |
| 289 |
| 290 <!-- TYPE --> |
| 291 <div style="display:inline" jstcache="0"> |
| 292 ( |
| 293 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 294 <span id="typeTemplate" jstcache="0"> |
| 295 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 296 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 297 </span> |
| 298 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 299 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 300 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 301 </span> |
| 302 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 303 </span> |
| 304 </span> |
| 305 ) |
| 306 </div> |
| 307 |
| 308 </em> |
| 309 </dt> |
| 310 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 311 Undocumented. |
| 312 </dd> |
| 313 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 314 Description of this parameter from the json schema. |
| 315 </dd> |
| 316 |
| 317 <!-- OBJECT PROPERTIES --> |
| 318 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 319 <dl jstcache="0"> |
| 320 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 321 <div jstcache="0"> |
| 322 <dt jstcache="0"> |
| 323 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 324 <em jstcache="0"> |
| 325 |
| 326 <!-- TYPE --> |
| 327 <div style="display:inline" jstcache="0"> |
| 328 ( |
| 329 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 330 <span id="typeTemplate" jstcache="0"> |
| 331 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 332 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 333 </span> |
| 334 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 335 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 336 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 337 </span> |
| 338 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 339 </span> |
| 340 </span> |
| 341 ) |
| 342 </div> |
| 343 |
| 344 </em> |
| 345 </dt> |
| 346 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 347 Undocumented. |
| 348 </dd> |
| 349 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 350 |
| 351 <!-- OBJECT PROPERTIES --> |
| 352 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 353 <dl jstcache="0"> |
| 354 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 355 <div transclude="valueTemplate" jstcache="17"> |
| 356 </div> |
| 357 </div> |
| 358 </dl> |
| 359 </dd> |
| 360 </div> |
| 361 </div> |
| 362 </dl> |
| 363 </dd> |
| 364 </div> <!-- /VALUE --> |
| 365 |
| 366 </div> |
| 367 </dl> |
| 368 |
| 369 <!-- RETURNS --> |
| 370 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 371 <dl jstcache="0"> |
| 372 <div jsselect="returns" jstcache="36"> |
| 373 <div jstcache="0"> |
| 374 <dt jstcache="0"> |
| 375 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 376 <em jstcache="0"> |
| 377 |
| 378 <!-- TYPE --> |
| 379 <div style="display:inline" jstcache="0"> |
| 380 ( |
| 381 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 382 <span id="typeTemplate" jstcache="0"> |
| 383 <span jsdisplay="getTypeRef($this)" jstcache="
48" style=""> |
| 384 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50" href="
extension.html#type-Port">Port</a> |
| 385 </span> |
| 386 <span jsdisplay="!getTypeRef($this)" jstcache=
"49" style="display: none; "> |
| 387 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 388 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 389 </span> |
| 390 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 391 </span> |
| 392 </span> |
| 393 ) |
| 394 </div> |
| 395 |
| 396 </em> |
| 397 </dt> |
| 398 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 399 Undocumented. |
| 400 </dd> |
| 401 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Port through which messages can be sent a
nd received with the extension.</dd> |
| 402 |
| 403 <!-- OBJECT PROPERTIES --> |
| 404 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 405 <dl jstcache="0"> |
| 406 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 407 <div jstcache="0"> |
| 408 <dt jstcache="0"> |
| 409 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 410 <em jstcache="0"> |
| 411 |
| 412 <!-- TYPE --> |
| 413 <div style="display:inline" jstcache="0"> |
| 414 ( |
| 415 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 416 <span id="typeTemplate" jstcache="0"> |
| 417 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 418 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 419 </span> |
| 420 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 421 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 422 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 423 </span> |
| 424 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 425 </span> |
| 426 </span> |
| 427 ) |
| 428 </div> |
| 429 |
| 430 </em> |
| 431 </dt> |
| 432 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 433 Undocumented. |
| 434 </dd> |
| 435 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 436 |
| 437 <!-- OBJECT PROPERTIES --> |
| 438 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 439 <dl jstcache="0"> |
| 440 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 441 <div transclude="valueTemplate" jstcache="17"> |
| 442 </div> |
| 443 </div> |
| 444 </dl> |
| 445 </dd> |
| 446 </div> |
| 447 </div> |
| 448 </dl> |
| 449 </dd> |
| 450 </div> |
| 451 </div> |
| 452 </dl> |
| 453 |
| 454 <!-- CALLBACK --> |
| 455 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di
splay: none; "> |
| 456 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 457 <h4 jstcache="0">Callback function</h4> |
| 458 <p jstcache="0"> |
| 459 If you specify the <em jstcache="0">callback</em> parameter, |
| 460 it should specify a function that looks like this: |
| 461 </p> |
| 462 |
| 463 <!-- Note: intentionally longer 80 columns --> |
| 464 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 465 <dl jstcache="0"> |
| 466 <div jsselect="parameters" jstcache="35"> |
| 467 <div transclude="valueTemplate" jstcache="17"> |
| 468 </div> |
| 469 </div> |
| 470 </dl> |
| 471 </div> |
| 472 </div> |
| 473 |
| 474 </div> <!-- /description --> |
| 475 |
| 476 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst
cache="11" jsinstance="1"> |
| 477 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-ge
tBackgroundPage"></a> <!-- method-anchor --> |
| 478 <h4 jscontent="name" jstcache="16">getBackgroundPage</h4> |
| 479 |
| 480 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">object</span> |
| 481 <!-- Note: intentionally longer 80 columns --> |
| 482 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.extension.getBackgroundPage</span>(<span jsselect="parameters" jsv
alues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="di
splay: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="
getTypeName($this)" jstcache="34"></span> |
| 483 <var jstcache="0"><span jscontent="name" jstcache="16"></s
pan></var></span>)</div> |
| 484 |
| 485 <div class="description" jstcache="0"> |
| 486 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 487 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Returns the global JavaScript object for the background page running
inside the current extension. Returns null if the extension has no backround pag
e.</p> |
| 488 |
| 489 <!-- PARAMETERS --> |
| 490 <h4 jstcache="0">Parameters</h4> |
| 491 <dl jstcache="0"> |
| 492 <div jsselect="parameters" jstcache="35" jsinstance="*0" style
="display: none; "> |
| 493 |
| 494 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 495 via jsTemplate *transclude* --> |
| 496 <div id="valueTemplate" jstcache="0"> |
| 497 <dt jstcache="0"> |
| 498 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">paramName</var> |
| 499 <em jstcache="0"> |
| 500 |
| 501 <!-- TYPE --> |
| 502 <div style="display:inline" jstcache="0"> |
| 503 ( |
| 504 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 505 <span id="typeTemplate" jstcache="0"> |
| 506 <span jsdisplay="getTypeRef($this)" jstcache="
48"> |
| 507 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 508 </span> |
| 509 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 510 <span jsdisplay="isArray($this)" jstcache="5
1"> |
| 511 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 512 </span> |
| 513 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">paramType</span> |
| 514 </span> |
| 515 </span> |
| 516 ) |
| 517 </div> |
| 518 |
| 519 </em> |
| 520 </dt> |
| 521 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 522 Undocumented. |
| 523 </dd> |
| 524 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40"> |
| 525 Description of this parameter from the json schema. |
| 526 </dd> |
| 527 |
| 528 <!-- OBJECT PROPERTIES --> |
| 529 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 530 <dl jstcache="0"> |
| 531 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 532 <div transclude="valueTemplate" jstcache="17"> |
| 533 </div> |
| 534 </div> |
| 535 </dl> |
| 536 </dd> |
| 537 </div> <!-- /VALUE --> |
| 538 |
| 539 </div> |
| 540 </dl> |
| 541 |
| 542 <!-- RETURNS --> |
| 543 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 544 <dl jstcache="0"> |
| 545 <div jsselect="returns" jstcache="36"> |
| 546 <div jstcache="0"> |
| 547 <dt jstcache="0"> |
| 548 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 549 <em jstcache="0"> |
| 550 |
| 551 <!-- TYPE --> |
| 552 <div style="display:inline" jstcache="0"> |
| 553 ( |
| 554 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 555 <span id="typeTemplate" jstcache="0"> |
| 556 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 557 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 558 </span> |
| 559 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 560 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 561 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 562 </span> |
| 563 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 564 </span> |
| 565 </span> |
| 566 ) |
| 567 </div> |
| 568 |
| 569 </em> |
| 570 </dt> |
| 571 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 572 Undocumented. |
| 573 </dd> |
| 574 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 575 Description of this parameter from the json schema. |
| 576 </dd> |
| 577 |
| 578 <!-- OBJECT PROPERTIES --> |
| 579 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 580 <dl jstcache="0"> |
| 581 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 582 <div jstcache="0"> |
| 583 <dt jstcache="0"> |
| 584 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 585 <em jstcache="0"> |
| 586 |
| 587 <!-- TYPE --> |
| 588 <div style="display:inline" jstcache="0"> |
| 589 ( |
| 590 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 591 <span id="typeTemplate" jstcache="0"> |
| 592 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 593 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 594 </span> |
| 595 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 596 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 597 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 598 </span> |
| 599 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 600 </span> |
| 601 </span> |
| 602 ) |
| 603 </div> |
| 604 |
| 605 </em> |
| 606 </dt> |
| 607 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 608 Undocumented. |
| 609 </dd> |
| 610 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 611 |
| 612 <!-- OBJECT PROPERTIES --> |
| 613 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 614 <dl jstcache="0"> |
| 615 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 616 <div transclude="valueTemplate" jstcache="17"> |
| 617 </div> |
| 618 </div> |
| 619 </dl> |
| 620 </dd> |
| 621 </div> |
| 622 </div> |
| 623 </dl> |
| 624 </dd> |
| 625 </div> |
| 626 </div> |
| 627 </dl> |
| 628 |
| 629 <!-- CALLBACK --> |
| 630 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di
splay: none; "> |
| 631 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 632 <h4 jstcache="0">Callback function</h4> |
| 633 <p jstcache="0"> |
| 634 If you specify the <em jstcache="0">callback</em> parameter, |
| 635 it should specify a function that looks like this: |
| 636 </p> |
| 637 |
| 638 <!-- Note: intentionally longer 80 columns --> |
| 639 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 640 <dl jstcache="0"> |
| 641 <div jsselect="parameters" jstcache="35"> |
| 642 <div transclude="valueTemplate" jstcache="17"> |
| 643 </div> |
| 644 </div> |
| 645 </dl> |
| 646 </div> |
| 647 </div> |
| 648 |
| 649 </div> <!-- /description --> |
| 650 |
| 651 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst
cache="11" jsinstance="2"> |
| 652 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-ge
tTabContentses"></a> <!-- method-anchor --> |
| 653 <h4 jscontent="name" jstcache="16">getTabContentses</h4> |
| 654 |
| 655 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">array of object</span> |
| 656 <!-- Note: intentionally longer 80 columns --> |
| 657 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.extension.getTabContentses</span>(<span jsselect="parameters" jsva
lues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="opt
ional"><span jsdisplay="$index" jstcache="33" style="display: none; ">, </span><
span jscontent="getTypeName($this)" jstcache="34">integer</span> |
| 658 <var jstcache="0"><span jscontent="name" jstcache="16">win
dowId</span></var></span>)</div> |
| 659 |
| 660 <div class="description" jstcache="0"> |
| 661 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 662 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Returns an array of the global JavaScript objects for each of the tab
contents views running inside the current extension. If windowId is specified,
returns only the tab contentses attached to the specified window.</p> |
| 663 |
| 664 <!-- PARAMETERS --> |
| 665 <h4 jstcache="0">Parameters</h4> |
| 666 <dl jstcache="0"> |
| 667 <div jsselect="parameters" jstcache="35" jsinstance="*0"> |
| 668 |
| 669 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 670 via jsTemplate *transclude* --> |
| 671 <div id="valueTemplate" jstcache="0"> |
| 672 <dt jstcache="0"> |
| 673 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">windowId</var> |
| 674 <em jstcache="0"> |
| 675 |
| 676 <!-- TYPE --> |
| 677 <div style="display:inline" jstcache="0"> |
| 678 ( |
| 679 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 680 <span id="typeTemplate" jstcache="0"> |
| 681 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 682 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 683 </span> |
| 684 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 685 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 686 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 687 </span> |
| 688 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">integer</span> |
| 689 </span> |
| 690 </span> |
| 691 ) |
| 692 </div> |
| 693 |
| 694 </em> |
| 695 </dt> |
| 696 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 697 Undocumented. |
| 698 </dd> |
| 699 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 700 Description of this parameter from the json schema. |
| 701 </dd> |
| 702 |
| 703 <!-- OBJECT PROPERTIES --> |
| 704 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 705 <dl jstcache="0"> |
| 706 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 707 <div transclude="valueTemplate" jstcache="17"> |
| 708 </div> |
| 709 </div> |
| 710 </dl> |
| 711 </dd> |
| 712 </div> <!-- /VALUE --> |
| 713 |
| 714 </div> |
| 715 </dl> |
| 716 |
| 717 <!-- RETURNS --> |
| 718 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 719 <dl jstcache="0"> |
| 720 <div jsselect="returns" jstcache="36"> |
| 721 <div jstcache="0"> |
| 722 <dt jstcache="0"> |
| 723 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 724 <em jstcache="0"> |
| 725 |
| 726 <!-- TYPE --> |
| 727 <div style="display:inline" jstcache="0"> |
| 728 ( |
| 729 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 730 <span id="typeTemplate" jstcache="0"> |
| 731 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 732 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 733 </span> |
| 734 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 735 <span jsdisplay="isArray($this)" jstcache="5
1" style=""> |
| 736 array of <span jsselect="items" jstcache="
53"><span jstcache="0"> |
| 737 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 738 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 739 </span> |
| 740 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 741 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 742 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 743 </span> |
| 744 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 745 </span> |
| 746 </span></span> |
| 747 </span> |
| 748 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52" style="display: none; ">object</span> |
| 749 </span> |
| 750 </span> |
| 751 ) |
| 752 </div> |
| 753 |
| 754 </em> |
| 755 </dt> |
| 756 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 757 Undocumented. |
| 758 </dd> |
| 759 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Array of global objects</dd> |
| 760 |
| 761 <!-- OBJECT PROPERTIES --> |
| 762 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 763 <dl jstcache="0"> |
| 764 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 765 <div jstcache="0"> |
| 766 <dt jstcache="0"> |
| 767 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 768 <em jstcache="0"> |
| 769 |
| 770 <!-- TYPE --> |
| 771 <div style="display:inline" jstcache="0"> |
| 772 ( |
| 773 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 774 <span id="typeTemplate" jstcache="0"> |
| 775 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 776 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 777 </span> |
| 778 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 779 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 780 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 781 </span> |
| 782 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 783 </span> |
| 784 </span> |
| 785 ) |
| 786 </div> |
| 787 |
| 788 </em> |
| 789 </dt> |
| 790 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 791 Undocumented. |
| 792 </dd> |
| 793 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 794 |
| 795 <!-- OBJECT PROPERTIES --> |
| 796 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 797 <dl jstcache="0"> |
| 798 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 799 <div transclude="valueTemplate" jstcache="17"> |
| 800 </div> |
| 801 </div> |
| 802 </dl> |
| 803 </dd> |
| 804 </div> |
| 805 </div> |
| 806 </dl> |
| 807 </dd> |
| 808 </div> |
| 809 </div> |
| 810 </dl> |
| 811 |
| 812 <!-- CALLBACK --> |
| 813 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di
splay: none; "> |
| 814 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 815 <h4 jstcache="0">Callback function</h4> |
| 816 <p jstcache="0"> |
| 817 If you specify the <em jstcache="0">callback</em> parameter, |
| 818 it should specify a function that looks like this: |
| 819 </p> |
| 820 |
| 821 <!-- Note: intentionally longer 80 columns --> |
| 822 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 823 <dl jstcache="0"> |
| 824 <div jsselect="parameters" jstcache="35"> |
| 825 <div transclude="valueTemplate" jstcache="17"> |
| 826 </div> |
| 827 </div> |
| 828 </dl> |
| 829 </div> |
| 830 </div> |
| 831 |
| 832 </div> <!-- /description --> |
| 833 |
| 834 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst
cache="11" jsinstance="3"> |
| 835 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-ge
tToolstrips"></a> <!-- method-anchor --> |
| 836 <h4 jscontent="name" jstcache="16">getToolstrips</h4> |
| 837 |
| 838 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">array of object</span> |
| 839 <!-- Note: intentionally longer 80 columns --> |
| 840 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.extension.getToolstrips</span>(<span jsselect="parameters" jsvalue
s="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="option
al"><span jsdisplay="$index" jstcache="33" style="display: none; ">, </span><spa
n jscontent="getTypeName($this)" jstcache="34">integer</span> |
| 841 <var jstcache="0"><span jscontent="name" jstcache="16">win
dowId</span></var></span>)</div> |
| 842 |
| 843 <div class="description" jstcache="0"> |
| 844 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 845 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Returns an array of the global JavaScript objects for each of the too
lstrip views running inside the current extension. If windowId is specified, ret
urns only the toolstrips attached to the specified window.</p> |
| 846 |
| 847 <!-- PARAMETERS --> |
| 848 <h4 jstcache="0">Parameters</h4> |
| 849 <dl jstcache="0"> |
| 850 <div jsselect="parameters" jstcache="35" jsinstance="*0"> |
| 851 |
| 852 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 853 via jsTemplate *transclude* --> |
| 854 <div id="valueTemplate" jstcache="0"> |
| 855 <dt jstcache="0"> |
| 856 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">windowId</var> |
| 857 <em jstcache="0"> |
| 858 |
| 859 <!-- TYPE --> |
| 860 <div style="display:inline" jstcache="0"> |
| 861 ( |
| 862 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 863 <span id="typeTemplate" jstcache="0"> |
| 864 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 865 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 866 </span> |
| 867 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 868 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 869 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 870 </span> |
| 871 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">integer</span> |
| 872 </span> |
| 873 </span> |
| 874 ) |
| 875 </div> |
| 876 |
| 877 </em> |
| 878 </dt> |
| 879 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 880 Undocumented. |
| 881 </dd> |
| 882 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 883 Description of this parameter from the json schema. |
| 884 </dd> |
| 885 |
| 886 <!-- OBJECT PROPERTIES --> |
| 887 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 888 <dl jstcache="0"> |
| 889 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 890 <div transclude="valueTemplate" jstcache="17"> |
| 891 </div> |
| 892 </div> |
| 893 </dl> |
| 894 </dd> |
| 895 </div> <!-- /VALUE --> |
| 896 |
| 897 </div> |
| 898 </dl> |
| 899 |
| 900 <!-- RETURNS --> |
| 901 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 902 <dl jstcache="0"> |
| 903 <div jsselect="returns" jstcache="36"> |
| 904 <div jstcache="0"> |
| 905 <dt jstcache="0"> |
| 906 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 907 <em jstcache="0"> |
| 908 |
| 909 <!-- TYPE --> |
| 910 <div style="display:inline" jstcache="0"> |
| 911 ( |
| 912 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 913 <span id="typeTemplate" jstcache="0"> |
| 914 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 915 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 916 </span> |
| 917 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 918 <span jsdisplay="isArray($this)" jstcache="5
1" style=""> |
| 919 array of <span jsselect="items" jstcache="
53"><span jstcache="0"> |
| 920 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 921 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 922 </span> |
| 923 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 924 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 925 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 926 </span> |
| 927 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 928 </span> |
| 929 </span></span> |
| 930 </span> |
| 931 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52" style="display: none; ">object</span> |
| 932 </span> |
| 933 </span> |
| 934 ) |
| 935 </div> |
| 936 |
| 937 </em> |
| 938 </dt> |
| 939 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 940 Undocumented. |
| 941 </dd> |
| 942 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Array of global objects</dd> |
| 943 |
| 944 <!-- OBJECT PROPERTIES --> |
| 945 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 946 <dl jstcache="0"> |
| 947 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 948 <div jstcache="0"> |
| 949 <dt jstcache="0"> |
| 950 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 951 <em jstcache="0"> |
| 952 |
| 953 <!-- TYPE --> |
| 954 <div style="display:inline" jstcache="0"> |
| 955 ( |
| 956 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 957 <span id="typeTemplate" jstcache="0"> |
| 958 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 959 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 960 </span> |
| 961 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 962 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 963 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 964 </span> |
| 965 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 966 </span> |
| 967 </span> |
| 968 ) |
| 969 </div> |
| 970 |
| 971 </em> |
| 972 </dt> |
| 973 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 974 Undocumented. |
| 975 </dd> |
| 976 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 977 |
| 978 <!-- OBJECT PROPERTIES --> |
| 979 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 980 <dl jstcache="0"> |
| 981 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 982 <div transclude="valueTemplate" jstcache="17"> |
| 983 </div> |
| 984 </div> |
| 985 </dl> |
| 986 </dd> |
| 987 </div> |
| 988 </div> |
| 989 </dl> |
| 990 </dd> |
| 991 </div> |
| 992 </div> |
| 993 </dl> |
| 994 |
| 995 <!-- CALLBACK --> |
| 996 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di
splay: none; "> |
| 997 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 998 <h4 jstcache="0">Callback function</h4> |
| 999 <p jstcache="0"> |
| 1000 If you specify the <em jstcache="0">callback</em> parameter, |
| 1001 it should specify a function that looks like this: |
| 1002 </p> |
| 1003 |
| 1004 <!-- Note: intentionally longer 80 columns --> |
| 1005 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 1006 <dl jstcache="0"> |
| 1007 <div jsselect="parameters" jstcache="35"> |
| 1008 <div transclude="valueTemplate" jstcache="17"> |
| 1009 </div> |
| 1010 </div> |
| 1011 </dl> |
| 1012 </div> |
| 1013 </div> |
| 1014 |
| 1015 </div> <!-- /description --> |
| 1016 |
| 1017 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst
cache="11" jsinstance="*4"> |
| 1018 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-ge
tViews"></a> <!-- method-anchor --> |
| 1019 <h4 jscontent="name" jstcache="16">getViews</h4> |
| 1020 |
| 1021 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">array of object</span> |
| 1022 <!-- Note: intentionally longer 80 columns --> |
| 1023 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.extension.getViews</span>(<span jsselect="parameters" jsvalues="cl
ass:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="display: no
ne; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeNa
me($this)" jstcache="34"></span> |
| 1024 <var jstcache="0"><span jscontent="name" jstcache="16"></s
pan></var></span>)</div> |
| 1025 |
| 1026 <div class="description" jstcache="0"> |
| 1027 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 1028 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Returns an array of the global JavaScript objects for each of the vie
ws running inside the current extension. This includes toolstrips, background pa
ges, and tabs.</p> |
| 1029 |
| 1030 <!-- PARAMETERS --> |
| 1031 <h4 jstcache="0">Parameters</h4> |
| 1032 <dl jstcache="0"> |
| 1033 <div jsselect="parameters" jstcache="35" jsinstance="*0" style
="display: none; "> |
| 1034 |
| 1035 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 1036 via jsTemplate *transclude* --> |
| 1037 <div id="valueTemplate" jstcache="0"> |
| 1038 <dt jstcache="0"> |
| 1039 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">paramName</var> |
| 1040 <em jstcache="0"> |
| 1041 |
| 1042 <!-- TYPE --> |
| 1043 <div style="display:inline" jstcache="0"> |
| 1044 ( |
| 1045 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 1046 <span id="typeTemplate" jstcache="0"> |
| 1047 <span jsdisplay="getTypeRef($this)" jstcache="
48"> |
| 1048 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1049 </span> |
| 1050 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1051 <span jsdisplay="isArray($this)" jstcache="5
1"> |
| 1052 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1053 </span> |
| 1054 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">paramType</span> |
| 1055 </span> |
| 1056 </span> |
| 1057 ) |
| 1058 </div> |
| 1059 |
| 1060 </em> |
| 1061 </dt> |
| 1062 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 1063 Undocumented. |
| 1064 </dd> |
| 1065 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40"> |
| 1066 Description of this parameter from the json schema. |
| 1067 </dd> |
| 1068 |
| 1069 <!-- OBJECT PROPERTIES --> |
| 1070 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 1071 <dl jstcache="0"> |
| 1072 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 1073 <div transclude="valueTemplate" jstcache="17"> |
| 1074 </div> |
| 1075 </div> |
| 1076 </dl> |
| 1077 </dd> |
| 1078 </div> <!-- /VALUE --> |
| 1079 |
| 1080 </div> |
| 1081 </dl> |
| 1082 |
| 1083 <!-- RETURNS --> |
| 1084 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 1085 <dl jstcache="0"> |
| 1086 <div jsselect="returns" jstcache="36"> |
| 1087 <div jstcache="0"> |
| 1088 <dt jstcache="0"> |
| 1089 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 1090 <em jstcache="0"> |
| 1091 |
| 1092 <!-- TYPE --> |
| 1093 <div style="display:inline" jstcache="0"> |
| 1094 ( |
| 1095 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1096 <span id="typeTemplate" jstcache="0"> |
| 1097 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1098 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1099 </span> |
| 1100 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1101 <span jsdisplay="isArray($this)" jstcache="5
1" style=""> |
| 1102 array of <span jsselect="items" jstcache="
53"><span jstcache="0"> |
| 1103 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1104 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1105 </span> |
| 1106 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1107 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1108 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1109 </span> |
| 1110 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 1111 </span> |
| 1112 </span></span> |
| 1113 </span> |
| 1114 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52" style="display: none; ">object</span> |
| 1115 </span> |
| 1116 </span> |
| 1117 ) |
| 1118 </div> |
| 1119 |
| 1120 </em> |
| 1121 </dt> |
| 1122 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 1123 Undocumented. |
| 1124 </dd> |
| 1125 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Array of global objects</dd> |
| 1126 |
| 1127 <!-- OBJECT PROPERTIES --> |
| 1128 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1129 <dl jstcache="0"> |
| 1130 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1131 <div jstcache="0"> |
| 1132 <dt jstcache="0"> |
| 1133 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 1134 <em jstcache="0"> |
| 1135 |
| 1136 <!-- TYPE --> |
| 1137 <div style="display:inline" jstcache="0"> |
| 1138 ( |
| 1139 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 1140 <span id="typeTemplate" jstcache="0"> |
| 1141 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1142 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1143 </span> |
| 1144 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1145 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1146 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1147 </span> |
| 1148 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 1149 </span> |
| 1150 </span> |
| 1151 ) |
| 1152 </div> |
| 1153 |
| 1154 </em> |
| 1155 </dt> |
| 1156 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 1157 Undocumented. |
| 1158 </dd> |
| 1159 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 1160 |
| 1161 <!-- OBJECT PROPERTIES --> |
| 1162 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1163 <dl jstcache="0"> |
| 1164 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1165 <div transclude="valueTemplate" jstcache="17"> |
| 1166 </div> |
| 1167 </div> |
| 1168 </dl> |
| 1169 </dd> |
| 1170 </div> |
| 1171 </div> |
| 1172 </dl> |
| 1173 </dd> |
| 1174 </div> |
| 1175 </div> |
| 1176 </dl> |
| 1177 |
| 1178 <!-- CALLBACK --> |
| 1179 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di
splay: none; "> |
| 1180 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 1181 <h4 jstcache="0">Callback function</h4> |
| 1182 <p jstcache="0"> |
| 1183 If you specify the <em jstcache="0">callback</em> parameter, |
| 1184 it should specify a function that looks like this: |
| 1185 </p> |
| 1186 |
| 1187 <!-- Note: intentionally longer 80 columns --> |
| 1188 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 1189 <dl jstcache="0"> |
| 1190 <div jsselect="parameters" jstcache="35"> |
| 1191 <div transclude="valueTemplate" jstcache="17"> |
| 1192 </div> |
| 1193 </div> |
| 1194 </dl> |
| 1195 </div> |
| 1196 </div> |
| 1197 |
| 1198 </div> <!-- /description --> |
| 1199 |
| 1200 </div> <!-- /apiItem --> |
| 1201 |
| 1202 </div> <!-- /apiGroup --> |
| 1203 |
| 1204 <!-- EVENTS --> |
| 1205 <div jsdisplay="events && events.length > 0" class="apiGrou
p" jstcache="7"> |
| 1206 <a name="events" jstcache="0"></a> |
| 1207 <h3 id="events" jstcache="0">Events</h3> |
| 1208 |
| 1209 <!-- iterates over all events --> |
| 1210 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12
" jsinstance="*0"> |
| 1211 <a jsvalues=".name:'event-' + name" jstcache="19" name="event-onCo
nnect"></a> |
| 1212 <h4 jscontent="name" jstcache="16">onConnect</h4> |
| 1213 |
| 1214 <div class="summary" jstcache="0"> |
| 1215 <!-- Note: intentionally longer 80 columns --> |
| 1216 <span jscontent="getModuleName() + '.'" class="subdued" jstcache
="23">chrome.extension.</span><span jscontent="name" jstcache="16">onConnect</sp
an><span class="subdued" jstcache="0">.addListener</span>(function(<span jsconte
nt="getSignatureString(parameters)" jstcache="32">Port port</span>) <span class=
"subdued" jstcache="0">{...}</span>); |
| 1217 </div> |
| 1218 |
| 1219 <div class="description" jstcache="0"> |
| 1220 <p class="todo" jsdisplay="!description" jstcache="28" style="di
splay: none; ">Undocumented.</p> |
| 1221 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29">Fired when a connection is made from either an extension process or a
content script.</p> |
| 1222 |
| 1223 <!-- PARAMETERS --> |
| 1224 <h4 jstcache="0">Parameters</h4> |
| 1225 <dl jstcache="0"> |
| 1226 <div jsselect="parameters" jstcache="35" jsinstance="*0"> |
| 1227 <div jstcache="0"> |
| 1228 <dt jstcache="0"> |
| 1229 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">port</var> |
| 1230 <em jstcache="0"> |
| 1231 |
| 1232 <!-- TYPE --> |
| 1233 <div style="display:inline" jstcache="0"> |
| 1234 ( |
| 1235 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1236 <span id="typeTemplate" jstcache="0"> |
| 1237 <span jsdisplay="getTypeRef($this)" jstcache="
48" style=""> |
| 1238 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50" href="
extension.html#type-Port">Port</a> |
| 1239 </span> |
| 1240 <span jsdisplay="!getTypeRef($this)" jstcache=
"49" style="display: none; "> |
| 1241 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1242 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1243 </span> |
| 1244 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 1245 </span> |
| 1246 </span> |
| 1247 ) |
| 1248 </div> |
| 1249 |
| 1250 </em> |
| 1251 </dt> |
| 1252 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 1253 Undocumented. |
| 1254 </dd> |
| 1255 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; "> |
| 1256 Description of this parameter from the json schema. |
| 1257 </dd> |
| 1258 |
| 1259 <!-- OBJECT PROPERTIES --> |
| 1260 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1261 <dl jstcache="0"> |
| 1262 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1263 <div jstcache="0"> |
| 1264 <dt jstcache="0"> |
| 1265 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 1266 <em jstcache="0"> |
| 1267 |
| 1268 <!-- TYPE --> |
| 1269 <div style="display:inline" jstcache="0"> |
| 1270 ( |
| 1271 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 1272 <span id="typeTemplate" jstcache="0"> |
| 1273 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1274 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1275 </span> |
| 1276 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1277 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1278 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1279 </span> |
| 1280 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 1281 </span> |
| 1282 </span> |
| 1283 ) |
| 1284 </div> |
| 1285 |
| 1286 </em> |
| 1287 </dt> |
| 1288 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 1289 Undocumented. |
| 1290 </dd> |
| 1291 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">Will be passed into onConnect for extensi
on processes that are listening for the connection event.</dd> |
| 1292 |
| 1293 <!-- OBJECT PROPERTIES --> |
| 1294 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1295 <dl jstcache="0"> |
| 1296 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1297 <div transclude="valueTemplate" jstcache="17"> |
| 1298 </div> |
| 1299 </div> |
| 1300 </dl> |
| 1301 </dd> |
| 1302 </div> |
| 1303 </div> |
| 1304 </dl> |
| 1305 </dd> |
| 1306 </div> |
| 1307 </div> |
| 1308 </dl> |
| 1309 |
| 1310 </div> <!-- /decription --> |
| 1311 |
| 1312 </div> <!-- /apiItem --> |
| 1313 |
| 1314 </div> <!-- /apiGroup --> |
| 1315 |
| 1316 <!-- TYPES --> |
| 1317 <div jsdisplay="types && types.length > 0" class="apiGroup"
jstcache="8"> |
| 1318 <a name="types.sort(sortByName)" jstcache="0"></a> |
| 1319 <h3 id="types" jstcache="0">Types</h3> |
| 1320 |
| 1321 <!-- iterates over all types --> |
| 1322 <div jsselect="types" class="apiItem" jstcache="13" jsinstance="*0"> |
| 1323 <a jsvalues=".name:'type-' + id" jstcache="20" name="type-Port"></
a> |
| 1324 <h4 jscontent="id" jstcache="21">Port</h4> |
| 1325 |
| 1326 <div jstcache="0"> |
| 1327 <dt jstcache="0"> |
| 1328 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46" style="display: none; ">connectInfo</var> |
| 1329 <em jstcache="0"> |
| 1330 |
| 1331 <!-- TYPE --> |
| 1332 <div style="display:inline" jstcache="0"> |
| 1333 ( |
| 1334 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1335 <span id="typeTemplate" jstcache="0"> |
| 1336 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1337 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1338 </span> |
| 1339 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1340 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1341 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1342 </span> |
| 1343 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 1344 </span> |
| 1345 </span> |
| 1346 ) |
| 1347 </div> |
| 1348 |
| 1349 </em> |
| 1350 </dt> |
| 1351 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style="display: none; "> |
| 1352 Undocumented. |
| 1353 </dd> |
| 1354 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="">An object which allows two way communicat
ion with other pages.</dd> |
| 1355 |
| 1356 <!-- OBJECT PROPERTIES --> |
| 1357 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 1358 <dl jstcache="0"> |
| 1359 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="0"> |
| 1360 <div jstcache="0"> |
| 1361 <dt jstcache="0"> |
| 1362 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">name</var> |
| 1363 <em jstcache="0"> |
| 1364 |
| 1365 <!-- TYPE --> |
| 1366 <div style="display:inline" jstcache="0"> |
| 1367 ( |
| 1368 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1369 <span id="typeTemplate" jstcache="0"> |
| 1370 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1371 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1372 </span> |
| 1373 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1374 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1375 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1376 </span> |
| 1377 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">string</span> |
| 1378 </span> |
| 1379 </span> |
| 1380 ) |
| 1381 </div> |
| 1382 |
| 1383 </em> |
| 1384 </dt> |
| 1385 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style=""> |
| 1386 Undocumented. |
| 1387 </dd> |
| 1388 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; ">Will be passed into onConn
ect for extension processes that are listening for the connection event.</dd> |
| 1389 |
| 1390 <!-- OBJECT PROPERTIES --> |
| 1391 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1392 <dl jstcache="0"> |
| 1393 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1394 <div transclude="valueTemplate" jstcache="17"> |
| 1395 </div> |
| 1396 </div> |
| 1397 </dl> |
| 1398 </dd> |
| 1399 </div> |
| 1400 </div><div jsselect="getPropertyListFromObject($this)"
jstcache="10" jsinstance="1"> |
| 1401 <div jstcache="0"> |
| 1402 <dt jstcache="0"> |
| 1403 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">onDisconnect</var> |
| 1404 <em jstcache="0"> |
| 1405 |
| 1406 <!-- TYPE --> |
| 1407 <div style="display:inline" jstcache="0"> |
| 1408 ( |
| 1409 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1410 <span id="typeTemplate" jstcache="0"> |
| 1411 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1412 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1413 </span> |
| 1414 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1415 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1416 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1417 </span> |
| 1418 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 1419 </span> |
| 1420 </span> |
| 1421 ) |
| 1422 </div> |
| 1423 |
| 1424 </em> |
| 1425 </dt> |
| 1426 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style=""> |
| 1427 Undocumented. |
| 1428 </dd> |
| 1429 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; ">Will be passed into onConn
ect for extension processes that are listening for the connection event.</dd> |
| 1430 |
| 1431 <!-- OBJECT PROPERTIES --> |
| 1432 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1433 <dl jstcache="0"> |
| 1434 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1435 <div transclude="valueTemplate" jstcache="17"> |
| 1436 </div> |
| 1437 </div> |
| 1438 </dl> |
| 1439 </dd> |
| 1440 </div> |
| 1441 </div><div jsselect="getPropertyListFromObject($this)"
jstcache="10" jsinstance="2"> |
| 1442 <div jstcache="0"> |
| 1443 <dt jstcache="0"> |
| 1444 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">onMessage</var> |
| 1445 <em jstcache="0"> |
| 1446 |
| 1447 <!-- TYPE --> |
| 1448 <div style="display:inline" jstcache="0"> |
| 1449 ( |
| 1450 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1451 <span id="typeTemplate" jstcache="0"> |
| 1452 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1453 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1454 </span> |
| 1455 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1456 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1457 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1458 </span> |
| 1459 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">object</span> |
| 1460 </span> |
| 1461 </span> |
| 1462 ) |
| 1463 </div> |
| 1464 |
| 1465 </em> |
| 1466 </dt> |
| 1467 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style=""> |
| 1468 Undocumented. |
| 1469 </dd> |
| 1470 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; ">Will be passed into onConn
ect for extension processes that are listening for the connection event.</dd> |
| 1471 |
| 1472 <!-- OBJECT PROPERTIES --> |
| 1473 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1474 <dl jstcache="0"> |
| 1475 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1476 <div transclude="valueTemplate" jstcache="17"> |
| 1477 </div> |
| 1478 </div> |
| 1479 </dl> |
| 1480 </dd> |
| 1481 </div> |
| 1482 </div><div jsselect="getPropertyListFromObject($this)"
jstcache="10" jsinstance="*3"> |
| 1483 <div jstcache="0"> |
| 1484 <dt jstcache="0"> |
| 1485 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">postMessage</var> |
| 1486 <em jstcache="0"> |
| 1487 |
| 1488 <!-- TYPE --> |
| 1489 <div style="display:inline" jstcache="0"> |
| 1490 ( |
| 1491 <span class="optional" jsdisplay="optional" jstc
ache="47" style="display: none; ">optional</span> |
| 1492 <span id="typeTemplate" jstcache="0"> |
| 1493 <span jsdisplay="getTypeRef($this)" jstcache="
48" style="display: none; "> |
| 1494 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 1495 </span> |
| 1496 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 1497 <span jsdisplay="isArray($this)" jstcache="5
1" style="display: none; "> |
| 1498 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 1499 </span> |
| 1500 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">function</span> |
| 1501 </span> |
| 1502 </span> |
| 1503 ) |
| 1504 </div> |
| 1505 |
| 1506 </em> |
| 1507 </dt> |
| 1508 <dd class="todo" jsdisplay="!$this.description" jstcache="
39" style=""> |
| 1509 Undocumented. |
| 1510 </dd> |
| 1511 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40" style="display: none; ">Will be passed into onConn
ect for extension processes that are listening for the connection event.</dd> |
| 1512 |
| 1513 <!-- OBJECT PROPERTIES --> |
| 1514 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st
yle="display: none; "> |
| 1515 <dl jstcache="0"> |
| 1516 <div jsselect="getPropertyListFromObject($this)" jstca
che="10" jsinstance="*0"> |
| 1517 <div transclude="valueTemplate" jstcache="17"> |
| 1518 </div> |
| 1519 </div> |
| 1520 </dl> |
| 1521 </dd> |
| 1522 </div> |
| 1523 </div> |
| 1524 </dl> |
| 1525 </dd> |
| 1526 </div> |
| 1527 |
| 1528 </div> <!-- /apiItem --> |
| 1529 |
| 1530 </div> <!-- /apiGroup --> |
| 1531 |
| 1532 </div> <!-- /apiPage --> |
| 1533 </div> <!-- /mainColumn --> |
| 1534 </div> <!-- /pageContent --> |
| 1535 <div id="pageFooter" --="" jstcache="0"> |
| 1536 <p jstcache="0"> |
| 1537 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
" jstcache="0">noted</a>, |
| 1538 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons |
| 1539 Attribution 3.0 License</a>, and code samples are licensed under the |
| 1540 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach
e="0">BSD License</a>. |
| 1541 </p> |
| 1542 <p jstcache="0"> |
| 1543 ©2009 Google |
| 1544 </p> |
| 1545 </div> <!-- /pageFooter --> |
| 1546 </div> <!-- /container --> |
| 1547 </body></html> |
| 1548 #EOF |
| OLD | NEW |