| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: 1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the templating mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated as an rendering step. If viewed in a browser, it will be re-generated from
the template, json schema and authored overview content. 4) The <body>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta is significant and loads the needed libraries and styles --><head jstcache="0
"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="
0"> <title jscontent="pageTitle" jstcache="1">chrome.extension API Reference</ti
tle> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache
="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemp
late_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js
/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" sr
c="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is complet
ely generated. Do not edit, as it will be and rewritten. --><body jstcache="0">
<div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEAD
ER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix the
se hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="
0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0"
>Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> >
<span jscontent="h1Header" jstcache="2">chrome.extension</span> </div> <div id=
"searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-searc
h-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="00
2967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" va
lue="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <i
nput type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script
type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script>
<script type="text/javascript" jstcache="0">google.load("elements", "1", {packa
ges: "transliteration"});</script> <script type="text/javascript" src="http://ww
w.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"><
/script> <script type="text/javascript" src="http://www.google.com/coop/cse/bran
d?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTi
tle" jstcache="0"> <h1 jscontent="h1Header" jstcache="2">chrome.extension</h1> <
/div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDEN
AV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a hr
ef="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted
.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.htm
l" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <
li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a> </li><li jstca
che="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a> </li><li jstcache="
0"><a href="pageActions.html" jstcache="0">Page actions</a> </li><li jstcache="0
"><a href="background_pages.html" jstcache="0">Background pages</a> </li><li jst
cache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a> </li><
li jstcache="0"><a href="extension.html" jstcache="0">Extension</a> </li><li jst
cache="0"><a href="tabs.html" jstcache="0">Tabs</a> </li><li jstcache="0"><a hre
f="windows.html" jstcache="0">Windows</a> </li><li jstcache="0"><a href="self.ht
ml" jstcache="0">Self</a> </li><li jstcache="0"><a href="npapi.html" jstcache="0
">NPAPI Plugins</a> </li><li jstcache="0"><a href="packaging.html" jstcache="0">
Packaging</a> </li><li jstcache="0"><a href="autoupdate.html" jstcache="0">Autou
pdate</a> </li></ul> </li><li jstcache="0">Samples <ul jstcache="0"> <li jstcach
e="0">[sample 1] </li><li jstcache="0">[sample 2] </li></ul> </li></ul> </div> <
div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jssel
ect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0">
<li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache
="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a
></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></
li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <o
l jstcache="0"> <li jsselect="functions" jstcache="4" jsinstance="*0"> <a jscont
ent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="1
7">connect</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0
">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="5" jsinstance="*0
"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onConnect"
jstcache="18">onConnect</a> </li> </ol> </li> <!-- TODO: What do we do about st
ructs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs
</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstca
che="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go
here -- would it be possible to link to overview h3s, as well? if so, how shoul
d we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STA
TIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE -
-> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS -->
<div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"
></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div cl
ass="apiItem" jsselect="functions" jstcache="4" jsinstance="*0"> <a jsvalues=".n
ame:'method-' + name" jstcache="6" name="method-connect"></a> <!-- method-anchor
--> <h3 jscontent="name" jstcache="7">connect</h3> <div class="summary" jstcach
e="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="9">object
</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName
" jstcache="10">chrome.extension.connect</span>(<span jsselect="parameters" jsva
lues="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*0" class="opt
ional"><span jsdisplay="$index" jstcache="19" style="display: none; ">, </span><
span jscontent="typeName" jstcache="20">string</span> <var jstcache="0"><span js
content="name" jstcache="7">name</span></var></span>)</div> <div class="descript
ion" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12" style=
"display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerH
TML:description" jstcache="13">Attempts to connect to other listeners within the
extension (listeners may be toolstrips or the extension's background page). Thi
s is primarily useful for content scripts connecting to their extension processe
s. Extensions may connect to content scripts embedded in tabs via <a href="broke
n" jstcache="0"><var jstcache="0">chrome.tabs.connectToTab</var></a>.</p> <!-- P
ARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="
parameters" jstcache="21" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentio
nally longer 80 columns --> <var jscontent="name" jstcache="7">name</var><em jst
cache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional <
/span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd cla
ss="todo" jsdisplay="!$this.description" jstcache="23" style="display: none; ">
Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this
.description" jstcache="24">Will be passed into onConnect for extension processe
s that are listening for the connection event.</dd> <!-- OBJECT PROPERTIES --> <
dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstcache
="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note:
intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName
</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="2
8">optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</e
m> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocume
nted. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descrip
tion" jstcache="24"> Description of this parameter from the json schema. </dd> <
/div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache
="14">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22"> <dt
jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam
e" jstcache="7"><!--framePath //<!--frame0-->--></var> <em jstcache=
"0">(<span jscontent="typeName" jstcache="20">object</span>)</em> </dt> <dd clas
s="todo" jsdisplay="!$this.description" jstcache="23" style="display: none; "> U
ndocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.
description" jstcache="24">Port through which messages can be sent and received
with the extension.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList
" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29" j
sinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns -->
<var jscontent="name" jstcache="7">name</var><em jstcache="0"> (<span class="opt
ional" jsdisplay="optional" jstcache="28" style="display: none; ">optional </spa
n><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd class="
todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdi
splay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"
style="display: none; "> Description of this parameter from the json schema. </d
d> </div><div jsselect="_propertyList" jstcache="29" jsinstance="1"> <dt jstcach
e="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstc
ache="7">onDisconnect</var><em jstcache="0"> (<span class="optional" jsdisplay="
optional" jstcache="28" style="display: none; ">optional </span><span jscontent=
"typeName" jstcache="20">object</span>)</em> </dt> <dd class="todo" jsdisplay="!
$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descr
iption" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: no
ne; "> Description of this parameter from the json schema. </dd> </div><div jsse
lect="_propertyList" jstcache="29" jsinstance="2"> <dt jstcache="0"> <!-- Note:
intentionally longer 80 columns --> <var jscontent="name" jstcache="7">onMessage
</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="2
8" style="display: none; ">optional </span><span jscontent="typeName" jstcache="
20">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" js
tcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".in
nerHTML:$this.description" jstcache="24" style="display: none; "> Description of
this parameter from the json schema. </dd> </div><div jsselect="_propertyList"
jstcache="29" jsinstance="*3"> <dt jstcache="0"> <!-- Note: intentionally longer
80 columns --> <var jscontent="name" jstcache="7">postMessage</var><em jstcache
="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="display:
none; ">optional </span><span jscontent="typeName" jstcache="20">function</span
>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Und
ocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.de
scription" jstcache="24" style="display: none; "> Description of this parameter
from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK -->
<div jsdisplay="callbackParameters" jstcache="15" style="display: none; "> <h4
jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstc
ache="0">callback</em> parameter, it should specify a function that looks like t
his: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">funct
ion(<span jscontent="callbackSignature" jstcache="26">Type param1, Type param2</
span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0">
<div jsselect="callbackParameters" jstcache="27"> <dt jstcache="0"> <!-- Note:
intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName
</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramType</spa
n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Un
documented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.d
escription" jstcache="24"> Description of this parameter from the json schema. <
/dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl
jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!
-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">
paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" js
tcache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</
span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23">
Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$thi
s.description" jstcache="24"> Description of this parameter from the json schema
. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </di
v> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGr
oup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="event
s" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="eve
nts" class="apiItem" jstcache="5" jsinstance="*0"> <a jsvalues=".name:'event-' +
name" jstcache="8" name="event-onConnect"></a> <h3 jscontent="name" jstcache="7
">onConnect</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally lon
ger 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><s
pan jscontent="name" jstcache="7">onConnect</span><span class="subdued" jstcache
="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="16">
object port</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <di
v class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jst
cache="12" style="display: none; ">Undocumented.</p> <p jsdisplay="description"
jsvalues=".innerHTML:description" jstcache="13">Fired when a connection is made
from either an extension process or a content script.</p> <!-- PARAMETERS --> <h
4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstc
ache="21" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80
columns --> <var jscontent="name" jstcache="7">port</var><em jstcache="0"> (<spa
n jscontent="typeName" jstcache="20">object</span>)</em> </dt> <dd class="todo"
jsdisplay="!$this.description" jstcache="23">Undocumented.</dd> <dd jsdisplay="$
this.description" jsvalues=".innerHTML:$this.description" jstcache="24" style="d
isplay: none; "> Description of this parameter from the json schema. </dd> <!--
OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache=
"0"> <div jsselect="_propertyList" jstcache="29" jsinstance="0"> <dt jstcache="0
"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache
="7">name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" js
tcache="28" style="display: none; ">optional </span><span jscontent="typeName" j
stcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri
ption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsva
lues=".innerHTML:$this.description" jstcache="24" style="display: none; "> Descr
iption of this parameter from the json schema. </dd> </div><div jsselect="_prope
rtyList" jstcache="29" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionall
y longer 80 columns --> <var jscontent="name" jstcache="7">onDisconnect</var><em
jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style=
"display: none; ">optional </span><span jscontent="typeName" jstcache="20">objec
t</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="2
3"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$
this.description" jstcache="24" style="display: none; "> Description of this par
ameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache=
"29" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column
s --> <var jscontent="name" jstcache="7">onMessage</var><em jstcache="0"> (<span
class="optional" jsdisplay="optional" jstcache="28" style="display: none; ">opt
ional </span><span jscontent="typeName" jstcache="20">object</span>)</em> </dt>
<dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </d
d> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jst
cache="24" style="display: none; "> Description of this parameter from the json
schema. </dd> </div><div jsselect="_propertyList" jstcache="29" jsinstance="*3">
<dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent
="name" jstcache="7">postMessage</var><em jstcache="0"> (<span class="optional"
jsdisplay="optional" jstcache="28" style="display: none; ">optional </span><span
jscontent="typeName" jstcache="20">function</span>)</em> </dt> <dd class="todo"
jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay
="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24" style
="display: none; "> Description of this parameter from the json schema. </dd> </
div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem -
-> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --
> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyrigh
t 2009 <br jstcache="0"> TBD: copyright/license should be automatically included
here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> |
Chromium Code Reviews
Issue 165323:
Add chrome.extension to extension_api.json and docs (Closed)
