diff options
| author | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-09-02 00:15:27 +0000 |
|---|---|---|
| committer | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-09-02 00:15:27 +0000 |
| commit | 469f7c12ebcda341b297d28e595f03ebdb113c6e (patch) | |
| tree | 53e69159fe485e79450c502cc664256202786123 /chrome/common/extensions/docs/extension.html | |
| parent | 4aaad381035049318843163bdb0e2e888678fea4 (diff) | |
| download | chromium_src-469f7c12ebcda341b297d28e595f03ebdb113c6e.zip chromium_src-469f7c12ebcda341b297d28e595f03ebdb113c6e.tar.gz chromium_src-469f7c12ebcda341b297d28e595f03ebdb113c6e.tar.bz2 | |
Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc
Tabs, Windows, Bookmarks, Themes doc content changes. Fix internal anchor problem (not hiding/showing for rendered docs). Only render dynamically for file: scheme. Fix <pre> issues in rendered docs (now no longer all one line). Alphabetize methods, events & types. Use h* ids for anchor names if found.
BUG=20803
TBR=aa
Review URL: http://codereview.chromium.org/179068
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@25127 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/extension.html')
| -rwxr-xr-x | chrome/common/extensions/docs/extension.html | 1549 |
1 files changed, 1548 insertions, 1 deletions
diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html index c831c54..4fc003a 100755 --- a/chrome/common/extensions/docs/extension.html +++ b/chrome/common/extensions/docs/extension.html @@ -1 +1,1548 @@ -<!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 mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="getPageTitle()" jstcache="1">chrome.extension</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageTitle()" 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 Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Actions</a></li> <li jstcache="0"><a href="background_pages.html" jstcache="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content Scripts</a></li> <li jstcache="0">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> <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">Autoupdate</li> </ul> </li> <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorials</div></a> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">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> </li> </ul> </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="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" jsvalues=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li> <div jsselect="apiDefinition" jstcache="3"> <li jstcache="0"> <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.extension</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="name" jsvalues=".href:'#property-' + name" href="#property-lastError" jstcache="41">lastError</a> </li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="11" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="42">connect</a> </li><li jsselect="functions" jstcache="11" jsinstance="1"> <a jscontent="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-getBackgroundPage" 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="functions" jstcache="11" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTabContentses" jstcache="42">getTabContentses</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="12" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#event-' + 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="#type-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="apiDefinition" jstcache="3"> <a name="apiReference" jstcache="0"></a> <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.extension</h2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> <a name="properties" jstcache="0"></a> <h3 id="properties" jstcache="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <a jsvalues=".name:'property-' + name" jstcache="15" name="property-lastError"></a> <h4 jscontent="name" jstcache="16">lastError</h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension.</span><span jscontent="$this.name" jstcache="24">lastError</span> </div> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">lastError</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 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="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> ) </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">Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var jstcache="0">undefined</var>.</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.name" jscontent="$this.name" jstcache="45">message</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: 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="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">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">Description of the error that has taken place.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="6"> <a name="methods" jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- iterates over all functions --> <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="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">Port</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="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 (listeners may be toolstrips or the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via <a href="broken" jstcache="0"><var jstcache="0">chrome.tabs.connectToTab</var></a>.</p> <!-- PARAMETERS --> <h4 jstcache="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">connectInfo</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 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="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> ) </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.name" 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 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="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">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 into onConnect 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="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" 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 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="optional" jsdisplay="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($this)" jscontent="getTypeRef($this)" jstcache="49" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48" style="display: none; "> <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> ) </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="">Port through which messages 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.name" 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 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="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">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 into onConnect 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="getPropertyListFromObject($this)" jstcache="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 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em 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 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="functions" jstcache="11" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getViews"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">getViews</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getViews</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div> <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">Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: none; "> <!-- 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">paramName</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"> <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="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">paramType</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"> 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"> <div transclude="valueTemplate" jstcache="17"> </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 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="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: 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" 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="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)" jscontent="getTypeName($this)" jstcache="51" style="display: none; ">object</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="">Array of global objects</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"> <!-- 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> </span> <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> </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 into onConnect 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="getPropertyListFromObject($this)" jstcache="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 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em 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 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="functions" jstcache="11" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getBackgroundPage"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">getBackgroundPage</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getBackgroundPage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div> <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">Returns the global JavaScript object for the background page running inside the current extension. Returns null if the extension has no backround page.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: none; "> <!-- 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">paramName</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"> <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="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">paramType</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"> 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"> <div transclude="valueTemplate" jstcache="17"> </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 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="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: 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="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> ) </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" 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"> <!-- 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> </span> <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> </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 into onConnect 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="getPropertyListFromObject($this)" jstcache="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 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em 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 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="functions" 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 jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($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" style="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">Returns 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 jstcache="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</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 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="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">integer</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" style="display: 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="returns" jstcache="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="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: 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" 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="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)" jscontent="getTypeName($this)" jstcache="51" style="display: none; ">object</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="">Array of global objects</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"> <!-- 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> </span> <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> </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 into onConnect 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="getPropertyListFromObject($this)" jstcache="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 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em 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 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="functions" jstcache="11" jsinstance="*4"> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getTabContentses"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">getTabContentses</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getTabContentses</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="33" style="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">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> <!-- PARAMETERS --> <h4 jstcache="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</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 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="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">integer</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" style="display: 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="returns" jstcache="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="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: 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" 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="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)" jscontent="getTypeName($this)" jstcache="51" style="display: none; ">object</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="">Array of global objects</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"> <!-- 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> </span> <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> </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 into onConnect 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="getPropertyListFromObject($this)" jstcache="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 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em 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 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> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="7"> <a name="events" jstcache="0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- iterates 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="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.extension.</span><span jscontent="name" jstcache="16">onConnect</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="32">Port port</span>) <span class="subdued" jstcache="0">{...}</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">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 jsselect="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"> ( <span class="optional" jsdisplay="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($this)" jscontent="getTypeRef($this)" jstcache="49" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48" style="display: none; "> <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> ) </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" 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"> <!-- 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> </span> <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> </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 into onConnect 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="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="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" jstcache="0">Types</h3> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="13" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="20" name="type-Port"></a> <h4 jscontent="id" jstcache="21">Port</h4> <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="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: 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="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> ) </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="">An object which allows two way communication with other pages.</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.name" jscontent="$this.name" jstcache="45">name</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: 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="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">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none; ">Will be passed into onConnect 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="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 --> <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: 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="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> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none; ">Will be passed into onConnect 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="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">onMessage</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: 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="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> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none; ">Will be passed into onConnect 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="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" 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" jstcache="45">postMessage</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: 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="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">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39" style="display: none; ">Will be passed into onConnect 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="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> <p jstcache="0"> Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache="0">noted</a>, the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons Attribution 3.0 License</a>, and code samples are licensed under the <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD License</a>. </p> <p jstcache="0"> ©2009 Google </p> </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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 mechanism. + 2) The <body> tag *must* retain id="body" + 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a + browser, it will be re-generated from the template, json schema and + authored overview content. + 4) The <body>.innerHTML is also generated by an offline step so that this + page may easily be indexed by search engines. + + TODO(rafaelw): Abstract this into a "pageshell" that becomes the single + version of page template shell and the "instance" pages (bookmarks.html, + etc...) can be generated with a build step. +--><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> + <title jscontent="getPageTitle()" jstcache="1">chrome.extension</title> + <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> + <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> + </script> + <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> + <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> + </head><!-- <body> content is completely generated. Do not edit, as it will be + and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> + <a name="top" jstcache="0"> </a> + <!-- API HEADER --> + <div id="pageHeader" jstcache="0"> + <div id="searchbox" jstcache="0"> + <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> + <div jstcache="0"> + <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> + <input type="hidden" name="ie" value="UTF-8" jstcache="0"> + <input type="text" name="q" size="31" jstcache="0"> + <input type="submit" name="sa" value="Search" jstcache="0"> + </div> + </form> + + <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> + <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> + <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> + <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> + </div> + <div id="pageTitle" jstcache="0"> + <h1 jscontent="getPageTitle()" 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 Started</a></li> + <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> + <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a> + <ul jstcache="0"> + <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li> + <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Actions</a></li> + <li jstcache="0"><a href="background_pages.html" jstcache="0">Background Pages</a></li> + <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content Scripts</a></li> + <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li> + <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> + <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> + <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</a></li> + <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li> + <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> + <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> + <li jstcache="0">Autoupdate</li> + </ul> + </li> + <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorials</div></a> + <ul jstcache="0"> + <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debugging</a></li> + </ul> + </li> + <li jstcache="0">Reference + <ul jstcache="0"> + <li jstcache="0"> Formats + <ul jstcache="0"> + <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li> + <li jstcache="0"><a href="match_patterns.html" jstcache="0">Match Patterns</a></li> + <li jstcache="0">Packages (.crx)</li> + </ul> + </li> + <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* APIs</a> </li> + <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs</a> </li> + </ul> + </li> + <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Samples</a></li> + </ul> + </div> + + <div id="mainColumn" jstcache="0"> + <!-- TABLE OF CONTENTS --> + <div id="toc" jsdisplay="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" jsvalues=".href:'#' + href" jstcache="14">h3Name</a> + </li> + </ol> + </li> + <div jsselect="apiDefinition" jstcache="3"> + <li jstcache="0"> + <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.extension</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="name" jsvalues=".href:'#property-' + name" href="#property-lastError" jstcache="42">lastError</a> + </li> + </ol> + </li> + <li jsdisplay="functions && functions.length > 0" jstcache="6"> + <a href="#methods" jstcache="0">Methods</a> + <ol jstcache="0"> + <li jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="0"> + <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="43">connect</a> + </li><li jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="1"> + <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getBackgroundPage" jstcache="43">getBackgroundPage</a> + </li><li jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="2"> + <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTabContentses" jstcache="43">getTabContentses</a> + </li><li jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="3"> + <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getToolstrips" jstcache="43">getToolstrips</a> + </li><li jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="*4"> + <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="43">getViews</a> + </li> + </ol> + </li> + <li jsdisplay="events && events.length > 0" jstcache="7"> + <a href="#events" jstcache="0">Events</a> + <ol jstcache="0"> + <li jsselect="events.sort(sortByName)" jstcache="12" jsinstance="*0"> + <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onConnect" jstcache="44">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.sort(sortByName)" jstcache="38" jsinstance="*0"> + <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Port" jstcache="45">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="apiDefinition" jstcache="3"> + <a name="apiReference" jstcache="0"></a> + <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.extension</h2> + + <!-- PROPERTIES --> + <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> + <a name="properties" jstcache="0"></a> + <h3 id="properties" jstcache="0">Properties</h3> + + <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> + <a jsvalues=".name:'property-' + name" jstcache="15" name="property-lastError"></a> + <h4 jscontent="name" jstcache="16">lastError</h4> + <div class="summary" jstcache="0"> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension.</span><span jscontent="$this.name" jstcache="24">lastError</span> + </div> + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">lastError</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40">Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var jstcache="0">undefined</var>.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> + <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="46">message</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40">Description of the error that has taken place.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" style="display: none; "> + <dl jstcache="0"> + <div jsselect="getPropertyListFromObject($this)" jstcache="10"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + </dd> + </div> + </div> + + </div> <!-- /apiGroup --> + + <!-- METHODS --> + <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="6"> + <a name="methods" jstcache="0"></a> + <h3 jstcache="0">Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem" jsselect="functions.sort(sortByName)" 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="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">Port</span> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="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 (listeners may be toolstrips or the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via <a href="broken" jstcache="0"><var jstcache="0">chrome.tabs.connectToTab</var></a>.</p> + + <!-- PARAMETERS --> + <h4 jstcache="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="46">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> + <dl jstcache="0"> + <div jsselect="getPropertyListFromObject($this)" jstcache="10" jsinstance="*0"> + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> + </dl> + + <!-- RETURNS --> + <h4 jsdisplay="returns" jstcache="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="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style=""> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50" href="extension.html#type-Port">Port</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49" style="display: none; "> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Port through which messages can be sent and received with the extension.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> + <div jsselect="getCallbackParameters(parameters)" jstcache="37"> + <h4 jstcache="0">Callback function</h4> + <p jstcache="0"> + If you specify the <em jstcache="0">callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="1"> + <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getBackgroundPage"></a> <!-- method-anchor --> + <h4 jscontent="name" jstcache="16">getBackgroundPage</h4> + + <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">object</span> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getBackgroundPage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> + <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div> + + <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">Returns the global JavaScript object for the background page running inside the current extension. Returns null if the extension has no backround page.</p> + + <!-- PARAMETERS --> + <h4 jstcache="0">Parameters</h4> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: none; "> + + <!-- VALUE: This is a subtemplate that is used elsewhere + via jsTemplate *transclude* --> + <div id="valueTemplate" jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">paramName</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48"> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51"> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">paramType</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40"> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> + <dl jstcache="0"> + <div jsselect="getPropertyListFromObject($this)" jstcache="10"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> + </dl> + + <!-- RETURNS --> + <h4 jsdisplay="returns" jstcache="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="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> + <div jsselect="getCallbackParameters(parameters)" jstcache="37"> + <h4 jstcache="0">Callback function</h4> + <p jstcache="0"> + If you specify the <em jstcache="0">callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="2"> + <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getTabContentses"></a> <!-- method-anchor --> + <h4 jscontent="name" jstcache="16">getTabContentses</h4> + + <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getTabContentses</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="33" style="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">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> + + <!-- PARAMETERS --> + <h4 jstcache="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="46">windowId</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" style="display: 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="returns" jstcache="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="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style=""> + array of <span jsselect="items" jstcache="53"><span jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52" style="display: none; ">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Array of global objects</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> + <div jsselect="getCallbackParameters(parameters)" jstcache="37"> + <h4 jstcache="0">Callback function</h4> + <p jstcache="0"> + If you specify the <em jstcache="0">callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsselect="functions.sort(sortByName)" 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 jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getFullyQualifiedFunctionName($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" style="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">Returns 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 jstcache="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="46">windowId</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" style="display: 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="returns" jstcache="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="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style=""> + array of <span jsselect="items" jstcache="53"><span jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52" style="display: none; ">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Array of global objects</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> + <div jsselect="getCallbackParameters(parameters)" jstcache="37"> + <h4 jstcache="0">Callback function</h4> + <p jstcache="0"> + If you specify the <em jstcache="0">callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11" jsinstance="*4"> + <a jsvalues=".name:'method-' + name" jstcache="18" name="method-getViews"></a> <!-- method-anchor --> + <h4 jscontent="name" jstcache="16">getViews</h4> + + <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">array of object</span> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.extension.getViews</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> + <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div> + + <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">Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.</p> + + <!-- PARAMETERS --> + <h4 jstcache="0">Parameters</h4> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35" jsinstance="*0" style="display: none; "> + + <!-- VALUE: This is a subtemplate that is used elsewhere + via jsTemplate *transclude* --> + <div id="valueTemplate" jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">paramName</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48"> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51"> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">paramType</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40"> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> + <dl jstcache="0"> + <div jsselect="getPropertyListFromObject($this)" jstcache="10"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> + </dl> + + <!-- RETURNS --> + <h4 jsdisplay="returns" jstcache="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="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style=""> + array of <span jsselect="items" jstcache="53"><span jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52" style="display: none; ">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Array of global objects</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> + <div jsselect="getCallbackParameters(parameters)" jstcache="37"> + <h4 jstcache="0">Callback function</h4> + <p jstcache="0"> + If you specify the <em jstcache="0">callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> + <dl jstcache="0"> + <div jsselect="parameters" jstcache="35"> + <div transclude="valueTemplate" jstcache="17"> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="7"> + <a name="events" jstcache="0"></a> + <h3 id="events" jstcache="0">Events</h3> + + <!-- iterates over all events --> + <div jsselect="events.sort(sortByName)" 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="summary" jstcache="0"> + <!-- Note: intentionally longer 80 columns --> + <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.extension.</span><span jscontent="name" jstcache="16">onConnect</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="32">Port port</span>) <span class="subdued" jstcache="0">{...}</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">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 jsselect="parameters" jstcache="35" jsinstance="*0"> + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">port</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style=""> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50" href="extension.html#type-Port">Port</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49" style="display: none; "> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39"> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </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.sort(sortByName)" jstcache="0"></a> + <h3 id="types" jstcache="0">Types</h3> + + <!-- iterates over all types --> + <div jsselect="types" class="apiItem" jstcache="13" jsinstance="*0"> + <a jsvalues=".name:'type-' + id" jstcache="20" name="type-Port"></a> + <h4 jscontent="id" jstcache="21">Port</h4> + + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46" style="display: none; ">connectInfo</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style="display: none; "> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="">An object which allows two way communication with other pages.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> + <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="46">name</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style=""> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; ">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="46">onDisconnect</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style=""> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; ">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="2"> + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">onMessage</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style=""> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; ">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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="*3"> + <div jstcache="0"> + <dt jstcache="0"> + <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">postMessage</var> + <em jstcache="0"> + + <!-- TYPE --> + <div style="display:inline" jstcache="0"> + ( + <span class="optional" jsdisplay="optional" jstcache="47" style="display: none; ">optional</span> + <span id="typeTemplate" jstcache="0"> + <span jsdisplay="getTypeRef($this)" jstcache="48" style="display: none; "> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> + </span> + <span jsdisplay="!getTypeRef($this)" jstcache="49"> + <span jsdisplay="isArray($this)" jstcache="51" style="display: none; "> + array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span> + </span> + <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" jsdisplay="!$this.description" jstcache="39" style=""> + Undocumented. + </dd> + <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40" style="display: none; ">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> + + <!-- OBJECT PROPERTIES --> + <dd jsdisplay="shouldExpandObject($this)" jstcache="41" 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> + </dl> + </dd> + </div> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + </div> <!-- /apiPage --> + </div> <!-- /mainColumn --> + </div> <!-- /pageContent --> + <div id="pageFooter" --="" jstcache="0"> + <p jstcache="0"> + Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache="0">noted</a>, + the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons + Attribution 3.0 License</a>, and code samples are licensed under the + <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD License</a>. + </p> + <p jstcache="0"> + ©2009 Google + </p> + </div> <!-- /pageFooter --> + </div> <!-- /container --> +</body></html> +#EOF |