diff options
| author | aa@chromium.org <aa@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-14 08:08:40 +0000 |
|---|---|---|
| committer | aa@chromium.org <aa@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-14 08:08:40 +0000 |
| commit | 4eddcddf2737503c440bbdef106f5a6436d71670 (patch) | |
| tree | 69862cb9a694a678125d82b74f35d6c974fe13ba /chrome | |
| parent | d80a432e2201c81d60508d8399129063baa63982 (diff) | |
| download | chromium_src-4eddcddf2737503c440bbdef106f5a6436d71670.zip chromium_src-4eddcddf2737503c440bbdef106f5a6436d71670.tar.gz chromium_src-4eddcddf2737503c440bbdef106f5a6436d71670.tar.bz2 | |
Update chrome.extension docs. Also, remove old no longer needed
chrome.self page and replace missing bookmarks entries in left
nav.
TBR=rafaelw@chromium.org
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@23428 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome')
19 files changed, 17 insertions, 24 deletions
diff --git a/chrome/common/extensions/docs/api_index.html b/chrome/common/extensions/docs/api_index.html index 4b7d3b2..1ed69b4 100755 --- a/chrome/common/extensions/docs/api_index.html +++ b/chrome/common/extensions/docs/api_index.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Api_index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> [PENDING: links to reference doc — for example, <a href="chrome-api-index.html" jstcache="0">chrome.* APIs</a> — go here.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Api_index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> [PENDING: links to reference doc — for example, <a href="chrome-api-index.html" jstcache="0">chrome.* APIs</a> — go here.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/background_pages.html b/chrome/common/extensions/docs/background_pages.html index 0171b93..50d7f94 100755 --- a/chrome/common/extensions/docs/background_pages.html +++ b/chrome/common/extensions/docs/background_pages.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Background Pages</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Background Pages</div> <p jstcache="0">A common need for extensions is to have a single long-running script to manage some task or state. Toolstrips don't quite fit this need, because there can be multiple toolstrips active at any one time (one per browser window). Background pages to the rescue.</p> <p jstcache="0">The background page is similar to a toolstrip, in that it is an HTML page that runs in the extension process. The difference is that the background page exists for the lifetime of your extension, and there is only one instance of it active at a time.</p> <h3 jstcache="0">Status</h3> <p jstcache="0">Implemented.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register your background page in the extension manifest, like this:</p> <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "background_page": "background.html", "toolstrips": ["toolstrip.html"] }</pre> <p jstcache="0">Your toolstrip will likely contain only the necessary code to display the toolstrip UI, with all your extension logic contained in the background page. You can communicate between your various pages using direct script calls, similar to how frames can communicate. The chrome.self.getViews() function returns a list of window objects for every active page belonging to your extension.</p> <h3 jstcache="0">Example</h3> <pre jstcache="0">background_page.html (snippet): function updateUI(checked) { var views = chrome.self.getViews(); for (var i in views) { if (views[i].enableCheckbox) views[i].enableCheckbox(checked); } } toolstrip.html (snippet): function enableCheckbox(checked) { var elm = document.getElementById('checkbox'); elm.checked = checked; }</pre> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Background Pages</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Background Pages</div> <p jstcache="0">A common need for extensions is to have a single long-running script to manage some task or state. Toolstrips don't quite fit this need, because there can be multiple toolstrips active at any one time (one per browser window). Background pages to the rescue.</p> <p jstcache="0">The background page is similar to a toolstrip, in that it is an HTML page that runs in the extension process. The difference is that the background page exists for the lifetime of your extension, and there is only one instance of it active at a time.</p> <h3 jstcache="0">Status</h3> <p jstcache="0">Implemented.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register your background page in the extension manifest, like this:</p> <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "background_page": "background.html", "toolstrips": ["toolstrip.html"] }</pre> <p jstcache="0">Your toolstrip will likely contain only the necessary code to display the toolstrip UI, with all your extension logic contained in the background page. You can communicate between your various pages using direct script calls, similar to how frames can communicate. The chrome.self.getViews() function returns a list of window objects for every active page belonging to your extension.</p> <h3 jstcache="0">Example</h3> <pre jstcache="0">background_page.html (snippet): function updateUI(checked) { var views = chrome.self.getViews(); for (var i in views) { if (views[i].enableCheckbox) views[i].enableCheckbox(checked); } } toolstrip.html (snippet): function enableCheckbox(checked) { var elm = document.getElementById('checkbox'); elm.checked = checked; }</pre> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html index b807f81..6e72b57 100755 --- a/chrome/common/extensions/docs/bookmarks.html +++ b/chrome/common/extensions/docs/bookmarks.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.bookmarks API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getChildren" jstcache="24">getChildren</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTree" jstcache="24">getTree</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-search" jstcache="24">search</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="24">move</a> </li><li jsselect="functions" jstcache="7" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li><li jsselect="functions" jstcache="7" jsinstance="*8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-removeTree" jstcache="24">removeTree</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAdded" jstcache="25">onAdded</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li><li jsselect="events" jstcache="8" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChanged" jstcache="25">onChanged</a> </li><li jsselect="events" jstcache="8" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="25">onMoved</a> </li><li jsselect="events" jstcache="8" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChildrenReordered" jstcache="25">onChildrenReordered</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-BookmarkTreeNode" jstcache="26">BookmarkTreeNode</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p id="classSummary" jstcache="0"> Use the <code jstcache="0">chrome.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks. </p> <h2 id="description" jstcache="0">Description</h2> <p jstcache="0"> [PENDING: intro goes here...] </p> <p jstcache="0"> <em jstcache="0">Bookmark objects</em> are an important part of the <code jstcache="0">chrome.bookmarks</code> API. Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure. </p> <img alt="2 kinds of bookmark objects" width="415" height="123" src="images/bookmarks.png" jstcache="0"> <h3 id="overview-properties" jstcache="0">Properties</h3> <p jstcache="0">Objects that represent bookmarks can have the following properties: </p> <dl jstcache="0"> <dt jstcache="0"> <code jstcache="0">id</code> </dt> <dd jstcache="0"> An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; the ID for a particular bookmark might change the next time the browser is started. </dd> <dt jstcache="0"> <code jstcache="0">title</code> </dt> <dd jstcache="0"> The name of the bookmark. This is the user-visible string that describes the URL or group. </dd> <dt jstcache="0"> <code jstcache="0">parentId </code> <em jstcache="0">(omitted for the root group)</em> </dt> <dd jstcache="0"> The ID of the group that this bookmark is in. </dd> <dt jstcache="0"> <code jstcache="0">index</code> <em jstcache="0">(optional; omitted for the root group)</em> </dt> <dd jstcache="0"> The 0-based integer position of the bookmark within its group. </dd> <dt jstcache="0"> <code jstcache="0">url</code> <em jstcache="0">(omitted for groups)</em> </dt> <dd jstcache="0"> The URL of the page that the bookmark points to. </dd> </dl> <h3 id="overview-examples" jstcache="0">Examples</h3> <p jstcache="0"> The following code creates a bookmark group with the title "Chromium bookmarks". The last argument defines a function to be executed after the folder is created. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': bookmarkBar.id, 'title': 'Chromium bookmarks'}, function(newFolder) {...}); </pre> <p jstcache="0"> The next snippet creates a bookmark pointing to the Chromium developer doc. Since nothing too bad will happen if creating the bookmark fails, this snippet doesn't bother to define a callback function. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': chromiumBookmarks.id, 'title': 'dev doc', 'url': 'http://dev.chromium.org'}); </pre> <p jstcache="0"> Say you have bookmark hierarchy that looks like this:</p> <ul jstcache="0"> <li jstcache="0">Bookmarks</li> <ul jstcache="0"> <li jstcache="0">Google</li> <ul jstcache="0"> <li jstcache="0">Apps</li> <ul jstcache="0"> <li jstcache="0">...</li> <li jstcache="0">...</li> <li jstcache="0">...</li> </ul> <li jstcache="0">Google homepage</li> </ul> <li jstcache="0">Example</li> </ul> </ul> <p jstcache="0"> Here's how those bookmarks might be represented with bookmark objects:</p> <img alt="a hierarchy of bookmarks" width="522" height="594" src="images/bookmark-hierarchy.png" jstcache="0"> <p jstcache="0"> Here's some code you could use to create that hierarchy:</p> <pre class="example" jstcache="0">...code goes here... </pre> <div class="exampleLink" jstcache="0"> <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Full source code</a> | <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Install extension</a> </div> <!-- END exampleLink --> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string or array of string</span> <var jstcache="0"><span jscontent="name" jstcache="11">idOrIdList</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the specified BookmarkTreeNode(s).</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">idOrIdList</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getChildren"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getChildren</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.getChildren</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the children of the specified BookmarkTreeNode id.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.getTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the entire Bookmarks hierarchy.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-search"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">search</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.search</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">query</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Seaches for BookmarkTreeNodes matching the given query.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">query</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">bookmark</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">bookmark</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">BookmarkTreeNode result</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">result</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">destination</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Moves the specified BookmarkTreeNode to the provided location.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">destination</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">changes</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">changes</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">BookmarkTreeNode result</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">result</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*8"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-removeTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">removeTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.removeTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onAdded"></a> <h3 jscontent="name" jstcache="11">onAdded</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onAdded</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, BookmarkTreeNode bookmark</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">bookmark</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object removeInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">removeInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onChanged"></a> <h3 jscontent="name" jstcache="11">onChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object changeInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">changeInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onMoved"></a> <h3 jscontent="name" jstcache="11">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object moveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">moveInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldParentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*4"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onChildrenReordered"></a> <h3 jscontent="name" jstcache="11">onChildrenReordered</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onChildrenReordered</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, arary childIds</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">childIds</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">arary</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-BookmarkTreeNode"></a> <h3 jscontent="id" jstcache="14">BookmarkTreeNode</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">idOrIdList</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">favIconUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.bookmarks API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getChildren" jstcache="24">getChildren</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTree" jstcache="24">getTree</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-search" jstcache="24">search</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="24">move</a> </li><li jsselect="functions" jstcache="7" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li><li jsselect="functions" jstcache="7" jsinstance="*8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-removeTree" jstcache="24">removeTree</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAdded" jstcache="25">onAdded</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li><li jsselect="events" jstcache="8" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChanged" jstcache="25">onChanged</a> </li><li jsselect="events" jstcache="8" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="25">onMoved</a> </li><li jsselect="events" jstcache="8" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChildrenReordered" jstcache="25">onChildrenReordered</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-BookmarkTreeNode" jstcache="26">BookmarkTreeNode</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p id="classSummary" jstcache="0"> Use the <code jstcache="0">chrome.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks. </p> <h2 id="description" jstcache="0">Description</h2> <p jstcache="0"> [PENDING: intro goes here...] </p> <p jstcache="0"> <em jstcache="0">Bookmark objects</em> are an important part of the <code jstcache="0">chrome.bookmarks</code> API. Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure. </p> <img alt="2 kinds of bookmark objects" width="415" height="123" src="images/bookmarks.png" jstcache="0"> <h3 id="overview-properties" jstcache="0">Properties</h3> <p jstcache="0">Objects that represent bookmarks can have the following properties: </p> <dl jstcache="0"> <dt jstcache="0"> <code jstcache="0">id</code> </dt> <dd jstcache="0"> An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; the ID for a particular bookmark might change the next time the browser is started. </dd> <dt jstcache="0"> <code jstcache="0">title</code> </dt> <dd jstcache="0"> The name of the bookmark. This is the user-visible string that describes the URL or group. </dd> <dt jstcache="0"> <code jstcache="0">parentId </code> <em jstcache="0">(omitted for the root group)</em> </dt> <dd jstcache="0"> The ID of the group that this bookmark is in. </dd> <dt jstcache="0"> <code jstcache="0">index</code> <em jstcache="0">(optional; omitted for the root group)</em> </dt> <dd jstcache="0"> The 0-based integer position of the bookmark within its group. </dd> <dt jstcache="0"> <code jstcache="0">url</code> <em jstcache="0">(omitted for groups)</em> </dt> <dd jstcache="0"> The URL of the page that the bookmark points to. </dd> </dl> <h3 id="overview-examples" jstcache="0">Examples</h3> <p jstcache="0"> The following code creates a bookmark group with the title "Chromium bookmarks". The last argument defines a function to be executed after the folder is created. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': bookmarkBar.id, 'title': 'Chromium bookmarks'}, function(newFolder) {...}); </pre> <p jstcache="0"> The next snippet creates a bookmark pointing to the Chromium developer doc. Since nothing too bad will happen if creating the bookmark fails, this snippet doesn't bother to define a callback function. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': chromiumBookmarks.id, 'title': 'dev doc', 'url': 'http://dev.chromium.org'}); </pre> <p jstcache="0"> Say you have bookmark hierarchy that looks like this:</p> <ul jstcache="0"> <li jstcache="0">Bookmarks</li> <ul jstcache="0"> <li jstcache="0">Google</li> <ul jstcache="0"> <li jstcache="0">Apps</li> <ul jstcache="0"> <li jstcache="0">...</li> <li jstcache="0">...</li> <li jstcache="0">...</li> </ul> <li jstcache="0">Google homepage</li> </ul> <li jstcache="0">Example</li> </ul> </ul> <p jstcache="0"> Here's how those bookmarks might be represented with bookmark objects:</p> <img alt="a hierarchy of bookmarks" width="522" height="594" src="images/bookmark-hierarchy.png" jstcache="0"> <p jstcache="0"> Here's some code you could use to create that hierarchy:</p> <pre class="example" jstcache="0">...code goes here... </pre> <div class="exampleLink" jstcache="0"> <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Full source code</a> | <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Install extension</a> </div> <!-- END exampleLink --> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string or array of string</span> <var jstcache="0"><span jscontent="name" jstcache="11">idOrIdList</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the specified BookmarkTreeNode(s).</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">idOrIdList</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getChildren"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getChildren</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.getChildren</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the children of the specified BookmarkTreeNode id.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.getTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Retrieves the entire Bookmarks hierarchy.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-search"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">search</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.search</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">query</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Seaches for BookmarkTreeNodes matching the given query.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">query</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of BookmarkTreeNode results</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">results</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">bookmark</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">bookmark</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">BookmarkTreeNode result</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">result</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">destination</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Moves the specified BookmarkTreeNode to the provided location.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">destination</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">changes</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">changes</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">BookmarkTreeNode result</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">result</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*8"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-removeTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">removeTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.bookmarks.removeTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onAdded"></a> <h3 jscontent="name" jstcache="11">onAdded</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onAdded</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, BookmarkTreeNode bookmark</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">bookmark</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string or array of string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object removeInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">removeInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onChanged"></a> <h3 jscontent="name" jstcache="11">onChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object changeInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">changeInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onMoved"></a> <h3 jscontent="name" jstcache="11">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, object moveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">moveInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">parentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldParentId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*4"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onChildrenReordered"></a> <h3 jscontent="name" jstcache="11">onChildrenReordered</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onChildrenReordered</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">string id, arary childIds</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">childIds</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">arary</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-BookmarkTreeNode"></a> <h3 jscontent="id" jstcache="14">BookmarkTreeNode</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">idOrIdList</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">favIconUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; ">A single string-valued id, or an array of string-valued ids</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/content_scripts.html b/chrome/common/extensions/docs/content_scripts.html index 2ac70c6..668929e 100755 --- a/chrome/common/extensions/docs/content_scripts.html +++ b/chrome/common/extensions/docs/content_scripts.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Content Scripts</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Content Scripts</div> <p jstcache="0">Content Scripts are JavaScript files that run in the context of web pages. By using the standard <a href="http://www.w3.org/TR/DOM-Level-2-HTML/" jstcache="0">Document Object Model</a> (DOM), they can read details of the web pages the browser visits, or make changes to them. </p><p jstcache="0">Some examples of things that content scripts can do include: </p><ul jstcache="0"> <li jstcache="0">Find unlinked URLs in web pages and convert them into hyperlinks </li><li jstcache="0">Increase the font size to make text more legible </li><li jstcache="0">Find and process <a href="http://microformats.org/" jstcache="0">microformat</a> data in the DOM </li></ul> <h3 id="registration" jstcache="0">Registration</h3> <p jstcache="0">Content scripts are registered in an extension's <a href="manifest.html" jstcache="0">manifest.json</a> file, like so: </p><pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", <span style="background:yellow; font-weight:bold;" jstcache="0"> "content_scripts": [ { "matches": ["http://www.google.com/*"], "css": ["mystyles.css"], "js": ["jquery.js", "myscript.js"] } ]</span> }</pre> <p jstcache="0">An extension can contain any number of content scripts, and a content script can consist of any number of JavaScript or CSS files. The value of the <code jstcache="0">matches</code> property controls when the content script will run. </p><p jstcache="0">Each content script registered in the manifest can specify the following properties:</p> <table jstcache="0"> <tbody jstcache="0"><tr jstcache="0"> <th jstcache="0">Name</th> <th jstcache="0">Type</th> <th jstcache="0">Description</th> </tr> <tr jstcache="0"> <td jstcache="0">matches</td> <td jstcache="0">array of strings</td> <td jstcache="0">Required. Controls the pages this content script will be injected into. See <a href="#match_patterns" jstcache="0">Match Patterns</a> for more details on the syntax of these strins.</td> </tr> <tr jstcache="0"> <td jstcache="0">js</td> <td jstcache="0"><nobr jstcache="0">array of strings</nobr></td> <td jstcache="0">Optional. The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.</td> </tr> <tr jstcache="0"> <td jstcache="0">css</td> <td jstcache="0">array of strings</td> <td jstcache="0">Optional. The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.</td> </tr> <tr jstcache="0"> <td jstcache="0">run_at</td> <td jstcache="0">string</td> <td jstcache="0">Optional. Controls when the files in <code jstcache="0">js</code> are injected. Can be <code jstcache="0">"document_start"</code> or <code jstcache="0">"document_end"</code>. Defaults to <code jstcache="0">"document_end"</code>. In the case of <code jstcache="0">"document_start"</code>, the files are injected after any files from <code jstcache="0">"css"</code>, but before any other DOM is constructed or any other script is run. In the case of <code jstcache="0">"document_end"</code>, the files are injected after the DOM is complete, but before subresources like images and frames have necessarily loaded.</td> </tr> </tbody></table> <h3 id="match_patterns" jstcache="0">Match Patterns</h3> <p jstcache="0">TODO</p> <h3 id="execution_environment" jstcache="0">Execution Environment</h3> <p jstcache="0">Content scripts execute in a special environment called an <em jstcache="0">isolated world</em>. They have access to the DOM of the page they are injected into, but not to any JavaScript variables or functions created by the page. It looks to each content script as if there is no other JavaScript executing on the page it is running on. The same is true in reverse: JavaScript running on the page cannot call any functions or access any variables defined by content scripts. </p><p jstcache="0">For example, consider this simple page: </p><pre jstcache="0">hello.html =========== <html> <button id="button">click me</button> <script> var greeting = "hello!"; function sayGreeting() { alert(greeting); } document.getElementById("button").onclick = sayGreeting; </script> </html></pre> <p jstcache="0">Now, suppose this content script was injected into hello.html: </p><pre jstcache="0">contentscript.js ================== console.log(greeting); // undefined console.log(sayGreeting); // undefined console.log(document.getElementById("button").onclick); // still undefined document.getElementById("button").onclick = function() { alert("hola!"); }</pre> <p jstcache="0">Now, if the button is pressed, you will see both greetings. </p><p jstcache="0">Isolated worlds allow each content script to make changes to its JavaScript environment without worrying about conflicting with the page or with other contnet scripts. For example, a content script could include JQuery v1 and the page could include JQuery v2, and they wouldn't conflict with each other. </p><p jstcache="0">Another important benefit of isolated worlds is that they completely separate the JavaScript on the page from the JavaScript in extensions. This allows us to offer extra functionality to content scripts that should not be accessible from web pages without worrying about web pages accessing it. </p><h3 id="messaging" jstcache="0">Messaging</h3> <p jstcache="0">Content scripts can communicate with their parent extension using message passing. The content script opens a channel to the extension using the <a href="extension.html#connect" jstcache="0">chrome.extension.connect()</a> method and then sends messages back and forth to it. The messages can contain any valid JSON object (null, boolean, number, string, array, or object). </p><p jstcache="0">The parent extension can also open a channel to a content script in a given tab by calling <a href="tabs.html#connect" jstcache="0">chrome.tabs.connect(tabId)</a>. </p><p jstcache="0">When a channel is opened from a content script to an extension, the <a href="extension.html#onConnect" jstcache="0">onConnect</a> event is fired in all views in the extension. Any view can receive the event. The event contains a <a href="extension.html#port" jstcache="0">Port</a> object, which can be used by the extension view to communicate back to the content script. </p><p jstcache="0">[TODO: Complete this] </p><h3 id="hostPageCommuncation" jstcache="0">Communication with the embedding page</h3> <p jstcache="0">Although the execution environments of content scripts and the pages that host them are isolated from each other, they share access to the page's DOM. If the page wishes to communicate with the content script (or with the extension via the content script), it must do so through the shared DOM.</p> <p jstcache="0">An example can be accomplished using custom DOM events and storing data in a known location. Consider: </p> <pre jstcache="0">http://foo.com/example.html ================================ var customEvent = document.createEvent('Event'); customEvent.initEvent('myCustomEvent', true, true); function fireCustomEvent(data) { hidenDiv = document.getElementById('myCustomEventDiv'); hidenDiv.innerHTML = data hidenDiv.dispatchEvent(customEvent); }</pre> <pre jstcache="0">contentscript.js ===================== var port = chrome.extension.connect(); document.getElementById('myCustomEventDiv').addEventListener('myCustomEvent', function() { var eventData = document.getElementById('myCustomEventDiv').innerHTML; port.postMessage({message: "myCustomEvent", values: eventData}); });</pre> <p jstcache="0">In the above example, example.html (which is not a part of the extension) creates a custom event and then can decide to fire the event by setting the event data to a known location in the DOM and then dispatching the custom event. The content script listens for the name of the custom event on the known element and handles the event by inspecting the data of the element, and turning around to post the message to the extension process. In this way the page establishes a line of communication to the extension. The reverse is possible through similar means.</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Content Scripts</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Content Scripts</div> <p jstcache="0">Content Scripts are JavaScript files that run in the context of web pages. By using the standard <a href="http://www.w3.org/TR/DOM-Level-2-HTML/" jstcache="0">Document Object Model</a> (DOM), they can read details of the web pages the browser visits, or make changes to them. </p><p jstcache="0">Some examples of things that content scripts can do include: </p><ul jstcache="0"> <li jstcache="0">Find unlinked URLs in web pages and convert them into hyperlinks </li><li jstcache="0">Increase the font size to make text more legible </li><li jstcache="0">Find and process <a href="http://microformats.org/" jstcache="0">microformat</a> data in the DOM </li></ul> <h3 id="registration" jstcache="0">Registration</h3> <p jstcache="0">Content scripts are registered in an extension's <a href="manifest.html" jstcache="0">manifest.json</a> file, like so: </p><pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", <span style="background:yellow; font-weight:bold;" jstcache="0"> "content_scripts": [ { "matches": ["http://www.google.com/*"], "css": ["mystyles.css"], "js": ["jquery.js", "myscript.js"] } ]</span> }</pre> <p jstcache="0">An extension can contain any number of content scripts, and a content script can consist of any number of JavaScript or CSS files. The value of the <code jstcache="0">matches</code> property controls when the content script will run. </p><p jstcache="0">Each content script registered in the manifest can specify the following properties:</p> <table jstcache="0"> <tbody jstcache="0"><tr jstcache="0"> <th jstcache="0">Name</th> <th jstcache="0">Type</th> <th jstcache="0">Description</th> </tr> <tr jstcache="0"> <td jstcache="0">matches</td> <td jstcache="0">array of strings</td> <td jstcache="0">Required. Controls the pages this content script will be injected into. See <a href="#match_patterns" jstcache="0">Match Patterns</a> for more details on the syntax of these strins.</td> </tr> <tr jstcache="0"> <td jstcache="0">js</td> <td jstcache="0"><nobr jstcache="0">array of strings</nobr></td> <td jstcache="0">Optional. The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.</td> </tr> <tr jstcache="0"> <td jstcache="0">css</td> <td jstcache="0">array of strings</td> <td jstcache="0">Optional. The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.</td> </tr> <tr jstcache="0"> <td jstcache="0">run_at</td> <td jstcache="0">string</td> <td jstcache="0">Optional. Controls when the files in <code jstcache="0">js</code> are injected. Can be <code jstcache="0">"document_start"</code> or <code jstcache="0">"document_end"</code>. Defaults to <code jstcache="0">"document_end"</code>. In the case of <code jstcache="0">"document_start"</code>, the files are injected after any files from <code jstcache="0">"css"</code>, but before any other DOM is constructed or any other script is run. In the case of <code jstcache="0">"document_end"</code>, the files are injected after the DOM is complete, but before subresources like images and frames have necessarily loaded.</td> </tr> </tbody></table> <h3 id="match_patterns" jstcache="0">Match Patterns</h3> <p jstcache="0">TODO</p> <h3 id="execution_environment" jstcache="0">Execution Environment</h3> <p jstcache="0">Content scripts execute in a special environment called an <em jstcache="0">isolated world</em>. They have access to the DOM of the page they are injected into, but not to any JavaScript variables or functions created by the page. It looks to each content script as if there is no other JavaScript executing on the page it is running on. The same is true in reverse: JavaScript running on the page cannot call any functions or access any variables defined by content scripts. </p><p jstcache="0">For example, consider this simple page: </p><pre jstcache="0">hello.html =========== <html> <button id="button">click me</button> <script> var greeting = "hello!"; function sayGreeting() { alert(greeting); } document.getElementById("button").onclick = sayGreeting; </script> </html></pre> <p jstcache="0">Now, suppose this content script was injected into hello.html: </p><pre jstcache="0">contentscript.js ================== console.log(greeting); // undefined console.log(sayGreeting); // undefined console.log(document.getElementById("button").onclick); // still undefined document.getElementById("button").onclick = function() { alert("hola!"); }</pre> <p jstcache="0">Now, if the button is pressed, you will see both greetings. </p><p jstcache="0">Isolated worlds allow each content script to make changes to its JavaScript environment without worrying about conflicting with the page or with other contnet scripts. For example, a content script could include JQuery v1 and the page could include JQuery v2, and they wouldn't conflict with each other. </p><p jstcache="0">Another important benefit of isolated worlds is that they completely separate the JavaScript on the page from the JavaScript in extensions. This allows us to offer extra functionality to content scripts that should not be accessible from web pages without worrying about web pages accessing it. </p><h3 id="messaging" jstcache="0">Messaging</h3> <p jstcache="0">Content scripts can communicate with their parent extension using message passing. The content script opens a channel to the extension using the <a href="extension.html#connect" jstcache="0">chrome.extension.connect()</a> method and then sends messages back and forth to it. The messages can contain any valid JSON object (null, boolean, number, string, array, or object). </p><p jstcache="0">The parent extension can also open a channel to a content script in a given tab by calling <a href="tabs.html#connect" jstcache="0">chrome.tabs.connect(tabId)</a>. </p><p jstcache="0">When a channel is opened from a content script to an extension, the <a href="extension.html#onConnect" jstcache="0">onConnect</a> event is fired in all views in the extension. Any view can receive the event. The event contains a <a href="extension.html#port" jstcache="0">Port</a> object, which can be used by the extension view to communicate back to the content script. </p><p jstcache="0">[TODO: Complete this] </p><h3 id="hostPageCommuncation" jstcache="0">Communication with the embedding page</h3> <p jstcache="0">Although the execution environments of content scripts and the pages that host them are isolated from each other, they share access to the page's DOM. If the page wishes to communicate with the content script (or with the extension via the content script), it must do so through the shared DOM.</p> <p jstcache="0">An example can be accomplished using custom DOM events and storing data in a known location. Consider: </p> <pre jstcache="0">http://foo.com/example.html ================================ var customEvent = document.createEvent('Event'); customEvent.initEvent('myCustomEvent', true, true); function fireCustomEvent(data) { hidenDiv = document.getElementById('myCustomEventDiv'); hidenDiv.innerHTML = data hidenDiv.dispatchEvent(customEvent); }</pre> <pre jstcache="0">contentscript.js ===================== var port = chrome.extension.connect(); document.getElementById('myCustomEventDiv').addEventListener('myCustomEvent', function() { var eventData = document.getElementById('myCustomEventDiv').innerHTML; port.postMessage({message: "myCustomEvent", values: eventData}); });</pre> <p jstcache="0">In the above example, example.html (which is not a part of the extension) creates a custom event and then can decide to fire the event by setting the event data to a known location in the DOM and then dispatching the custom event. The content script listens for the name of the custom event on the known element and handles the event by inspecting the data of the element, and turning around to post the message to the extension process. In this way the page establishes a line of communication to the extension. The reverse is possible through similar means.</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html index 50e9b8a..3673801 100755 --- a/chrome/common/extensions/docs/devguide.html +++ b/chrome/common/extensions/docs/devguide.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Developer Guide</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Developer Guide</div> <p jstcache="0"> [PENDING: intro to the guide goes here. say where to go. lots o' links.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Developer Guide</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Developer Guide</div> <p jstcache="0"> [PENDING: intro to the guide goes here. say where to go. lots o' links.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html index 74ae659..0cf4fad 100755 --- a/chrome/common/extensions/docs/extension.html +++ b/chrome/common/extensions/docs/extension.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.extension API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="24">connect</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onConnect" jstcache="25">onConnect</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Port" jstcache="26">Port</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-connect"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">connect</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">Port</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">name</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Port through which messages can be sent and received with the extension.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="*0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onConnect"></a> <h3 jscontent="name" jstcache="11">onConnect</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onConnect</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Port port</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">port</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Port"></a> <h3 jscontent="id" jstcache="14">Port</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">An object which allows two way communication with other pages.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">onDisconnect</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">onMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">postMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.extension API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="24">connect</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="24">getViews</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getBackgroundPage" jstcache="24">getBackgroundPage</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getToolstrips" jstcache="24">getToolstrips</a> </li><li jsselect="functions" jstcache="7" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTabContentses" jstcache="24">getTabContentses</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onConnect" jstcache="25">onConnect</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Port" jstcache="26">Port</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-connect"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">connect</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">Port</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">name</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Will be passed into onConnect for extension processes that are listening for the connection event.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Port through which messages can be sent and received with the extension.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getViews"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getViews</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.getViews</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Array of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getBackgroundPage"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getBackgroundPage</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.getBackgroundPage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getToolstrips"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getToolstrips</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.getToolstrips</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Array of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getTabContentses"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getTabContentses</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.extension.getTabContentses</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Array of global objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="*0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onConnect"></a> <h3 jscontent="name" jstcache="11">onConnect</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onConnect</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Port port</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">port</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Port"></a> <h3 jscontent="id" jstcache="14">Port</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">An object which allows two way communication with other pages.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">onDisconnect</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">onMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">postMessage</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style=""> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" 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="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/getstarted.html b/chrome/common/extensions/docs/getstarted.html index 02417b6..ea327bc 100755 --- a/chrome/common/extensions/docs/getstarted.html +++ b/chrome/common/extensions/docs/getstarted.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Getting Started</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Getting Started</div> <p jstcache="0"> This tutorial walks you through creating a simple extension. To complete this tutorial, you must have Windows; Linux and Mac don't yet support extensions. </p> <h2 id="browser" jstcache="0">Get your browser ready</h2> <p jstcache="0"> To develop extensions for Google Chrome, you need to set up your browser: </p> <ol jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/getting-involved/dev-channel" jstcache="0">Subscribe to the Dev channel</a> of Google Chrome for Windows. </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Create a separate profile</a> for testing <em jstcache="0">(optional but highly recommended)</em>. Having a testing profile means that you can use Google Chrome (with your default profile) for everyday browsing, even if your extension has horrible bugs.</li> </ol> <h2 id="load" jstcache="0">Create and load an extension</h2> <p jstcache="0"> In this section, you'll write a <em jstcache="0">toolstrip</em> — an extension that puts a bit of UI into the <em jstcache="0">toolbar</em> at the bottom of the Google Chrome window. </p> <ol jstcache="0"> <li jstcache="0"> Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at <strong jstcache="0"><code jstcache="0">c:\myext</code></strong>, but it can be anywhere. </li> <li jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">manifest.json</code></strong>, and put this in it: <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }</pre> </li> <li jstcache="0"> In the same folder, create a text file called <strong jstcache="0"><code jstcache="0">my_toolstrip.html</code></strong>, and put this in it: <pre jstcache="0"><div class="toolstrip-button"> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Load the extension: <ol type="a" jstcache="0"> <li jstcache="0"> Change the shortcut that you use to start the browser (or create a new one) so that it has the <code jstcache="0">--enable-extensions</code> and <code jstcache="0">--load-extension</code> flags. For example, if your extension is at <code jstcache="0">c:\myext</code>, your shortcut might look something like this: <pre jstcache="0">chrome.exe <span class="newCode" jstcache="0">--enable-extensions --load-extension="c:\myext"</span></pre> </li> <li jstcache="0">Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile. </li> <li jstcache="0">Double-click the shortcut to start the browser.</li> </ol> <p jstcache="0"> <b jstcache="0">Note:</b> For details on changing shortcut properties, see <a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Creating and Using Profiles</a>.</p> </li> </ol> <p jstcache="0"> You should see the UI for your extension at the bottom left of the browser, looking something like this: </p> <table jstcache="0"> <tbody jstcache="0"> <tr jstcache="0"> <td align="center" width="33%" jstcache="0"><img src="images/hw-1.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-2.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-3.gif" alt="" jstcache="0"></td> </tr> <tr jstcache="0"> <th align="center" width="33%" jstcache="0"> default appearance</th> <th align="center" width="33%" jstcache="0"> initial onhover appearance</th> <th align="center" width="33%" jstcache="0"> final onhover appearance</th> </tr> </tbody> </table> <p jstcache="0"> Your extension's button is automatically styled to look like it belongs in the browser. If you put the cursor over the button, the button gets a nice, rounded edge, just like the buttons in the bookmark bar. After a while, a tooltip comes up, identifying the extension. </p> <p jstcache="0"> [PENDING: troubleshooting info should go here. what are symptoms of common typos, including misnamed files? what are the symptoms if you don't have the dev channel?] </p> <h2 id="code" jstcache="0">Add code to the extension</h2> <p jstcache="0"> In this step, you'll make your extension <em jstcache="0">do</em> something besides just look good. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">hello_world.html</code></strong>, and add the following code to it:</p> <blockquote jstcache="0"> <a href="samples/hello_world.txt" jstcache="0">CSS and JavaScript code for hello_world</a></blockquote> </li> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><div class="toolstrip-button"<span class="newCode" jstcache="0"> onclick="window.open('hello_world.html')"</span>> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Restart the browser to load the new version of the extension.</li> <li jstcache="0">Click the button. A window should come up that displays <code jstcache="0">hello_world.html</code>. </li> </ol> <p jstcache="0"> It should look something like this:</p> <img src="images/hello_world-page.gif" alt="a window with a grid of images related to HELLO WORLD" jstcache="0"> <p jstcache="0"> If you don't see that page, try the instructions again, following them exactly. Don't try loading an HTML file that isn't in the extension's folder — it won't work! </p> <h2 id="debug" jstcache="0">Debug the extension</h2> <p jstcache="0"> You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><span class="newCode" jstcache="0"><script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script></span> <div class="toolstrip-button" onclick="<span class="newCode" jstcache="0">helloWorld();</span>"> <span>Hello, World!</span> </div></pre> <p jstcache="0"> The relocated code still has the same effect, but now it has some debugging output, thanks to the call to <code jstcache="0">console.log()</code>.</p> </li> <li jstcache="0"> Restart the browser, so that it loads your new version of the extension. <!-- This might be confusing. Maybe we should instead cover location.reload() later, after we've shown the console. <div class="note"> <b>Tip:</b> If you don't want to restart your browser, you can get an updated version of the extension by opening a new window. The new window will contain the updated extension; old windows will contain the old version. </div> --> </li> <li jstcache="0"> Right-click the <strong jstcache="0">Hello, World!</strong> button (at the bottom left) to bring up the Developer Tools window for this instance of your toolstrip. The window should look something like this: <p jstcache="0"> <img src="images/devtools-1.gif" alt="" jstcache="0"> </p> <!-- Possibly we should recommend starting the Dev Tools using chrome://extensions, rather than right-click. However, that adds some stuff (such as id) that might be confusing. --> </li> <li jstcache="0"> Click the <strong jstcache="0">Scripts</strong> button. If necessary, choose <strong jstcache="0">my_toolstrip.html</strong> from the list of scripts. The result should be something like this: <p jstcache="0"> <img src="images/devtools-2.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Set a debugging breakpoint at the <code jstcache="0">window.open()</code> statement by clicking <strong jstcache="0">5</strong> in the left column: <p jstcache="0"> <img src="images/devtools-3.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the Console button (second from left, at the bottom of the Developer Tools window) so that you can see both the code and the console. <p jstcache="0"> <img src="images/devtools-4.gif" alt="" jstcache="0"></p> </li> <li jstcache="0"> Back in the main browser window, click the <strong jstcache="0">Hello, World!</strong> button, so that the extension begins executing. You should see the output of <code jstcache="0">console.log()</code> along with the line number, and execution should stop just before the call to <code jstcache="0">window.open()</code>. <p jstcache="0"> <img src="images/devtools-5.gif" alt="" jstcache="0"> </p> <p jstcache="0"> The Call Stack area at the right of the tools window shows that the <code jstcache="0">helloWorld()</code> method was called by an anonymous function that was called by <code jstcache="0">onclick</code>. Anywhere in the Call Stack or console that you see a file and line number (for example, "my_toolstrip.html:4"), you can click that text to see the relevant line of code. </p> </li> <li jstcache="0"> In the upper right part of the tools window, scroll down (if necessary) until you can see the local scope variables. This section shows the current values of all variables in the current scope. For example, you can see that <code jstcache="0">hwFile</code> is a local variable that has the value "hello_world.html". <p jstcache="0"> <img src="images/devtools-6.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to <code jstcache="0">window.open()</code> returns, the main browser window should open a new tab that displays the contents of <code jstcache="0">hello_world.html</code>.</li> </ol> <p jstcache="0"> You now know how to load and debug an extension!</p> <h2 id="summary" jstcache="0">Summary</h2> <p jstcache="0"> [PENDING: Summarize what we did, what it means, what else we would've done if this were a real extension (e.g. package it), and where to find more information. Suggest where to go next.]</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Getting Started</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Getting Started</div> <p jstcache="0"> This tutorial walks you through creating a simple extension. To complete this tutorial, you must have Windows; Linux and Mac don't yet support extensions. </p> <h2 id="browser" jstcache="0">Get your browser ready</h2> <p jstcache="0"> To develop extensions for Google Chrome, you need to set up your browser: </p> <ol jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/getting-involved/dev-channel" jstcache="0">Subscribe to the Dev channel</a> of Google Chrome for Windows. </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Create a separate profile</a> for testing <em jstcache="0">(optional but highly recommended)</em>. Having a testing profile means that you can use Google Chrome (with your default profile) for everyday browsing, even if your extension has horrible bugs.</li> </ol> <h2 id="load" jstcache="0">Create and load an extension</h2> <p jstcache="0"> In this section, you'll write a <em jstcache="0">toolstrip</em> — an extension that puts a bit of UI into the <em jstcache="0">toolbar</em> at the bottom of the Google Chrome window. </p> <ol jstcache="0"> <li jstcache="0"> Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at <strong jstcache="0"><code jstcache="0">c:\myext</code></strong>, but it can be anywhere. </li> <li jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">manifest.json</code></strong>, and put this in it: <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }</pre> </li> <li jstcache="0"> In the same folder, create a text file called <strong jstcache="0"><code jstcache="0">my_toolstrip.html</code></strong>, and put this in it: <pre jstcache="0"><div class="toolstrip-button"> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Load the extension: <ol type="a" jstcache="0"> <li jstcache="0"> Change the shortcut that you use to start the browser (or create a new one) so that it has the <code jstcache="0">--enable-extensions</code> and <code jstcache="0">--load-extension</code> flags. For example, if your extension is at <code jstcache="0">c:\myext</code>, your shortcut might look something like this: <pre jstcache="0">chrome.exe <span class="newCode" jstcache="0">--enable-extensions --load-extension="c:\myext"</span></pre> </li> <li jstcache="0">Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile. </li> <li jstcache="0">Double-click the shortcut to start the browser.</li> </ol> <p jstcache="0"> <b jstcache="0">Note:</b> For details on changing shortcut properties, see <a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Creating and Using Profiles</a>.</p> </li> </ol> <p jstcache="0"> You should see the UI for your extension at the bottom left of the browser, looking something like this: </p> <table jstcache="0"> <tbody jstcache="0"> <tr jstcache="0"> <td align="center" width="33%" jstcache="0"><img src="images/hw-1.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-2.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-3.gif" alt="" jstcache="0"></td> </tr> <tr jstcache="0"> <th align="center" width="33%" jstcache="0"> default appearance</th> <th align="center" width="33%" jstcache="0"> initial onhover appearance</th> <th align="center" width="33%" jstcache="0"> final onhover appearance</th> </tr> </tbody> </table> <p jstcache="0"> Your extension's button is automatically styled to look like it belongs in the browser. If you put the cursor over the button, the button gets a nice, rounded edge, just like the buttons in the bookmark bar. After a while, a tooltip comes up, identifying the extension. </p> <p jstcache="0"> [PENDING: troubleshooting info should go here. what are symptoms of common typos, including misnamed files? what are the symptoms if you don't have the dev channel?] </p> <h2 id="code" jstcache="0">Add code to the extension</h2> <p jstcache="0"> In this step, you'll make your extension <em jstcache="0">do</em> something besides just look good. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">hello_world.html</code></strong>, and add the following code to it:</p> <blockquote jstcache="0"> <a href="samples/hello_world.txt" jstcache="0">CSS and JavaScript code for hello_world</a></blockquote> </li> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><div class="toolstrip-button"<span class="newCode" jstcache="0"> onclick="window.open('hello_world.html')"</span>> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Restart the browser to load the new version of the extension.</li> <li jstcache="0">Click the button. A window should come up that displays <code jstcache="0">hello_world.html</code>. </li> </ol> <p jstcache="0"> It should look something like this:</p> <img src="images/hello_world-page.gif" alt="a window with a grid of images related to HELLO WORLD" jstcache="0"> <p jstcache="0"> If you don't see that page, try the instructions again, following them exactly. Don't try loading an HTML file that isn't in the extension's folder — it won't work! </p> <h2 id="debug" jstcache="0">Debug the extension</h2> <p jstcache="0"> You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><span class="newCode" jstcache="0"><script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script></span> <div class="toolstrip-button" onclick="<span class="newCode" jstcache="0">helloWorld();</span>"> <span>Hello, World!</span> </div></pre> <p jstcache="0"> The relocated code still has the same effect, but now it has some debugging output, thanks to the call to <code jstcache="0">console.log()</code>.</p> </li> <li jstcache="0"> Restart the browser, so that it loads your new version of the extension. <!-- This might be confusing. Maybe we should instead cover location.reload() later, after we've shown the console. <div class="note"> <b>Tip:</b> If you don't want to restart your browser, you can get an updated version of the extension by opening a new window. The new window will contain the updated extension; old windows will contain the old version. </div> --> </li> <li jstcache="0"> Right-click the <strong jstcache="0">Hello, World!</strong> button (at the bottom left) to bring up the Developer Tools window for this instance of your toolstrip. The window should look something like this: <p jstcache="0"> <img src="images/devtools-1.gif" alt="" jstcache="0"> </p> <!-- Possibly we should recommend starting the Dev Tools using chrome://extensions, rather than right-click. However, that adds some stuff (such as id) that might be confusing. --> </li> <li jstcache="0"> Click the <strong jstcache="0">Scripts</strong> button. If necessary, choose <strong jstcache="0">my_toolstrip.html</strong> from the list of scripts. The result should be something like this: <p jstcache="0"> <img src="images/devtools-2.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Set a debugging breakpoint at the <code jstcache="0">window.open()</code> statement by clicking <strong jstcache="0">5</strong> in the left column: <p jstcache="0"> <img src="images/devtools-3.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the Console button (second from left, at the bottom of the Developer Tools window) so that you can see both the code and the console. <p jstcache="0"> <img src="images/devtools-4.gif" alt="" jstcache="0"></p> </li> <li jstcache="0"> Back in the main browser window, click the <strong jstcache="0">Hello, World!</strong> button, so that the extension begins executing. You should see the output of <code jstcache="0">console.log()</code> along with the line number, and execution should stop just before the call to <code jstcache="0">window.open()</code>. <p jstcache="0"> <img src="images/devtools-5.gif" alt="" jstcache="0"> </p> <p jstcache="0"> The Call Stack area at the right of the tools window shows that the <code jstcache="0">helloWorld()</code> method was called by an anonymous function that was called by <code jstcache="0">onclick</code>. Anywhere in the Call Stack or console that you see a file and line number (for example, "my_toolstrip.html:4"), you can click that text to see the relevant line of code. </p> </li> <li jstcache="0"> In the upper right part of the tools window, scroll down (if necessary) until you can see the local scope variables. This section shows the current values of all variables in the current scope. For example, you can see that <code jstcache="0">hwFile</code> is a local variable that has the value "hello_world.html". <p jstcache="0"> <img src="images/devtools-6.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to <code jstcache="0">window.open()</code> returns, the main browser window should open a new tab that displays the contents of <code jstcache="0">hello_world.html</code>.</li> </ol> <p jstcache="0"> You now know how to load and debug an extension!</p> <h2 id="summary" jstcache="0">Summary</h2> <p jstcache="0"> [PENDING: Summarize what we did, what it means, what else we would've done if this were a real extension (e.g. package it), and where to find more information. Suggest where to go next.]</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html index 863d46d..e489689 100755 --- a/chrome/common/extensions/docs/index.html +++ b/chrome/common/extensions/docs/index.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Chrome Extensions Developer Documentation</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Chrome Extensions Developer Documentation</div> <p jstcache="0"> If you want to customize Google Chrome, you've come to the right place. An <em jstcache="0">extension</em> is a bundle of web code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. <a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Examples of extensions</a> include a mail checker, a newsfeed subscriber, and a status monitor.<br jstcache="0"> </p> <p jstcache="0">[Maybe add some nice enticing pictures of toolstrips and moles (when we have them)]</p> <p jstcache="0">If you just want to dive in, try <a href="getstarted.html" jstcache="0">Get Started</a>. Otherwise, if you'd prefer to start with the high level overview, try <a href="overview.html" jstcache="0">Overview</a>. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Chrome Extensions Developer Documentation</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Chrome Extensions Developer Documentation</div> <p jstcache="0"> If you want to customize Google Chrome, you've come to the right place. An <em jstcache="0">extension</em> is a bundle of web code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. <a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Examples of extensions</a> include a mail checker, a newsfeed subscriber, and a status monitor.<br jstcache="0"> </p> <p jstcache="0">[Maybe add some nice enticing pictures of toolstrips and moles (when we have them)]</p> <p jstcache="0">If you just want to dive in, try <a href="getstarted.html" jstcache="0">Get Started</a>. Otherwise, if you'd prefer to start with the high level overview, try <a href="overview.html" jstcache="0">Overview</a>. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html index 75fa0ec..a93bd0d 100755 --- a/chrome/common/extensions/docs/manifest.html +++ b/chrome/common/extensions/docs/manifest.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Manifest</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0">This page should go into detail about all the parts of the manifest. In cases where there's not too much to say about something (icons, cross-origin XHR), we can just document it inline. Otherwise (content scripts), we can link off to a separate page. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Manifest</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0">This page should go into detail about all the parts of the manifest. In cases where there's not too much to say about something (icons, cross-origin XHR), we can just document it inline. Otherwise (content scripts), we can link off to a separate page. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html index cabdadb..548a48c 100755 --- a/chrome/common/extensions/docs/overview.html +++ b/chrome/common/extensions/docs/overview.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Overview</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> This page should perhaps be renamed from "overview" to "concepts". In any case, what I'd like to cover here is the conceptual underpinning of extensions, such as: </p><ul jstcache="0"> <li jstcache="0">Zip file of web pages </li><li jstcache="0">All resources accessible with a URL scheme </li><li jstcache="0">How IDs are generated </li><li jstcache="0">The manifest </li><li jstcache="0">The background page, how extensions are typically structured </li><li jstcache="0">Process model </li><li jstcache="0">Content scripts (lightweight, link off to other page for details) </li><li jstcache="0">Asynchronous APIs </li><li jstcache="0">Extension IDs, how they are generated </li><li jstcache="0">How packaging works at a high level (lightweight, link off to other page for details) </li></ul></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Overview</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> This page should perhaps be renamed from "overview" to "concepts". In any case, what I'd like to cover here is the conceptual underpinning of extensions, such as: </p><ul jstcache="0"> <li jstcache="0">Zip file of web pages </li><li jstcache="0">All resources accessible with a URL scheme </li><li jstcache="0">How IDs are generated </li><li jstcache="0">The manifest </li><li jstcache="0">The background page, how extensions are typically structured </li><li jstcache="0">Process model </li><li jstcache="0">Content scripts (lightweight, link off to other page for details) </li><li jstcache="0">Asynchronous APIs </li><li jstcache="0">Extension IDs, how they are generated </li><li jstcache="0">How packaging works at a high level (lightweight, link off to other page for details) </li></ul></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/packaging.html b/chrome/common/extensions/docs/packaging.html index c2e4c9d..80cc36a 100755 --- a/chrome/common/extensions/docs/packaging.html +++ b/chrome/common/extensions/docs/packaging.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Packaging</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0">Extensions are packaged as signed zip files with the file extension "crx" (eg myextension.crx). Each extension has its own unique key pair. The public key is used as the unique identifier for the extension and the private key is kept private and used to sign each version of the extension.</p> <h3 jstcache="0">Packaging an Extension</h3> <p jstcache="0">To package an extension:</p> <ol jstcache="0"> <li jstcache="0">Close all your Chrome windows</li> <li jstcache="0">Open a command line and type: <pre jstcache="0"><path-to-chrome>\chrome.exe --pack-extension=<path\to\extension\folder> </pre></li></ol> <img src="images/create-package.png" jstcache="0"> <h4 jstcache="0">Note</h4> <ul jstcache="0"> <li jstcache="0">In Windows XP, you can find <path-to-chrome jstcache="0"> by right-clicking on your Google Chrome shortcut and selecting Properties -> Shortcut and then pressing Find Target.</path-to-chrome></li> <li jstcache="0">In Vista, you can do the same by right-clicking your Google Chrome shortcut and selecting Open File Location.</li> </ul> <p jstcache="0">The packager creates two files: a crx file (myextension.crx), which is the actual extension that can be installed, and a private key (myextension.pem). You should keep the private key secret and in a safe place.</p> <h4 jstcache="0">IMPORTANT: Do not lose the private key. You will need it later for two things</h4> <ol jstcache="0"> <li jstcache="0">If you want to create a new version of the extension, you'll need the original private key (see below).</li><li jstcache="0"> </li><li jstcache="0">In the future, Google will implement a gallery service for extensions. You'll need your private key if you want to import an existing extension into that gallery.</li> </ol> <h3 jstcache="0">Updating an Extension</h3> <p jstcache="0">To create an updated version of your extension:</p> <ol jstcache="0"> <li jstcache="0">Increase the version number in manifest.json</li> <li jstcache="0">Close all your Chrome windows</li> <li jstcache="0">Run <path-to-chrome jstcache="0">\chrome.exe --pack-extension=<path\to\extension\folder jstcache="0"> --pack-extension-key=<path\to\extension-key jstcache="0">, specifying the private key file you created earlier for the second parameter.</path\to\extension-key></path\to\extension\folder></path-to-chrome></li> </ol> <p jstcache="0">If the updated extension is successfully packaged, you'll see a dialog like this</p> <img src="images/package-success.png" jstcache="0"> <h3 jstcache="0">Tips and Tricks</h3> <ul jstcache="0"> <li jstcache="0">In build 3.0.195 and later, you can use the --no-message-box command line flag to suppress the dialog. This is useful if you're packing extensions in non-interactive scripts.</li> </ul></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">Packaging</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="24">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0">Extensions are packaged as signed zip files with the file extension "crx" (eg myextension.crx). Each extension has its own unique key pair. The public key is used as the unique identifier for the extension and the private key is kept private and used to sign each version of the extension.</p> <h3 jstcache="0">Packaging an Extension</h3> <p jstcache="0">To package an extension:</p> <ol jstcache="0"> <li jstcache="0">Close all your Chrome windows</li> <li jstcache="0">Open a command line and type: <pre jstcache="0"><path-to-chrome>\chrome.exe --pack-extension=<path\to\extension\folder> </pre></li></ol> <img src="images/create-package.png" jstcache="0"> <h4 jstcache="0">Note</h4> <ul jstcache="0"> <li jstcache="0">In Windows XP, you can find <path-to-chrome jstcache="0"> by right-clicking on your Google Chrome shortcut and selecting Properties -> Shortcut and then pressing Find Target.</path-to-chrome></li> <li jstcache="0">In Vista, you can do the same by right-clicking your Google Chrome shortcut and selecting Open File Location.</li> </ul> <p jstcache="0">The packager creates two files: a crx file (myextension.crx), which is the actual extension that can be installed, and a private key (myextension.pem). You should keep the private key secret and in a safe place.</p> <h4 jstcache="0">IMPORTANT: Do not lose the private key. You will need it later for two things</h4> <ol jstcache="0"> <li jstcache="0">If you want to create a new version of the extension, you'll need the original private key (see below).</li><li jstcache="0"> </li><li jstcache="0">In the future, Google will implement a gallery service for extensions. You'll need your private key if you want to import an existing extension into that gallery.</li> </ol> <h3 jstcache="0">Updating an Extension</h3> <p jstcache="0">To create an updated version of your extension:</p> <ol jstcache="0"> <li jstcache="0">Increase the version number in manifest.json</li> <li jstcache="0">Close all your Chrome windows</li> <li jstcache="0">Run <path-to-chrome jstcache="0">\chrome.exe --pack-extension=<path\to\extension\folder jstcache="0"> --pack-extension-key=<path\to\extension-key jstcache="0">, specifying the private key file you created earlier for the second parameter.</path\to\extension-key></path\to\extension\folder></path-to-chrome></li> </ol> <p jstcache="0">If the updated extension is successfully packaged, you'll see a dialog like this</p> <img src="images/package-success.png" jstcache="0"> <h3 jstcache="0">Tips and Tricks</h3> <ul jstcache="0"> <li jstcache="0">In build 3.0.195 and later, you can use the --no-message-box command line flag to suppress the dialog. This is useful if you're packing extensions in non-interactive scripts.</li> </ul></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7"> <a jsvalues=".name:'method-' + name" jstcache="10"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <!-- 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/pageActions.html b/chrome/common/extensions/docs/pageActions.html index 1b5225a..cf9caaf 100755 --- a/chrome/common/extensions/docs/pageActions.html +++ b/chrome/common/extensions/docs/pageActions.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.pageActions API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-enableForTab" jstcache="24">enableForTab</a> </li><li jsselect="functions" jstcache="7" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-disableForTab" jstcache="24">disableForTab</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5" style="display: none; "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Page actions are a simple way to represent actions that can be taken on a page ("Email this page", "Share with Facebook", etc).</p> <h3 jstcache="0">Status</h3> <p jstcache="0">First version implemented.</p> <h3 jstcache="0">User interface</h3> <p jstcache="0">Page actions are displayed in the right side of the Omnibox. New actions get added to the left of the star:</p> <img src="images/pageaction-omnibar-icons.png" jstcache="0"> <p jstcache="0">A maximum of 8 (?) actions can appear at the top level, any additional ones overflow into a drop-down menu:</p> <h3 jstcache="0">Manifest</h3> <p jstcache="0">Developers can include page actions in the manifest using the following syntax:</p> <pre jstcache="0">"page_actions": [ { "id": "myaction", // chosen by developer, and should be unique within their extension "name": "Do action", "icons": ["favicon.png", "favicon2.png"] } ]</pre> <p jstcache="0">Supported icon image formats include for example png, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit.</p> <p jstcache="0"></p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-enableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">enableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.pageActions.enableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">pageActionId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">action</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">iconId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">disableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.pageActions.disableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">pageActionId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">action</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5" style="display: none; "> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6" style="display: none; "> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.pageActions API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-enableForTab" jstcache="24">enableForTab</a> </li><li jsselect="functions" jstcache="7" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-disableForTab" jstcache="24">disableForTab</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5" style="display: none; "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Page actions are a simple way to represent actions that can be taken on a page ("Email this page", "Share with Facebook", etc).</p> <h3 jstcache="0">Status</h3> <p jstcache="0">First version implemented.</p> <h3 jstcache="0">User interface</h3> <p jstcache="0">Page actions are displayed in the right side of the Omnibox. New actions get added to the left of the star:</p> <img src="images/pageaction-omnibar-icons.png" jstcache="0"> <p jstcache="0">A maximum of 8 (?) actions can appear at the top level, any additional ones overflow into a drop-down menu:</p> <h3 jstcache="0">Manifest</h3> <p jstcache="0">Developers can include page actions in the manifest using the following syntax:</p> <pre jstcache="0">"page_actions": [ { "id": "myaction", // chosen by developer, and should be unique within their extension "name": "Do action", "icons": ["favicon.png", "favicon2.png"] } ]</pre> <p jstcache="0">Supported icon image formats include for example png, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit.</p> <p jstcache="0"></p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-enableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">enableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.pageActions.enableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">pageActionId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">action</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">iconId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">disableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.pageActions.disableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">pageActionId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">action</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5" style="display: none; "> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6" style="display: none; "> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/self.html b/chrome/common/extensions/docs/self.html deleted file mode 100755 index e963728..0000000 --- a/chrome/common/extensions/docs/self.html +++ /dev/null @@ -1 +0,0 @@ -<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.self API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="24">getViews</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5" style="display: none; "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getViews"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getViews</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.self.getViews</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28"></span> <var jstcache="0"><span jscontent="name" jstcache="11"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">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="29" 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="35">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41"> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">paramType</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">Array of HTMLWindow objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5" style="display: none; "> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6" style="display: none; "> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/static/self.html b/chrome/common/extensions/docs/static/self.html deleted file mode 100755 index 997b579..0000000 --- a/chrome/common/extensions/docs/static/self.html +++ /dev/null @@ -1,5 +0,0 @@ -<!-- BEGIN AUTHORED CONTENT --> -<p class="todo"> -[PENDING: API Module Overview Goes Here] -</p> -<!-- END AUTHORED CONTENT --> diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index f609c4b..4e52aff 100755 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.tabs API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="24">connect</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getSelected" jstcache="24">getSelected</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAllInWindow" jstcache="24">getAllInWindow</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="24">move</a> </li><li jsselect="functions" jstcache="7" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li><li jsselect="functions" jstcache="7" jsinstance="8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-detectLanguage" jstcache="24">detectLanguage</a> </li><li jsselect="functions" jstcache="7" jsinstance="*9"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-captureVisibleTab" jstcache="24">captureVisibleTab</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="25">onCreated</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onUpdated" jstcache="25">onUpdated</a> </li><li jsselect="events" jstcache="8" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="25">onMoved</a> </li><li jsselect="events" jstcache="8" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onSelectionChanged" jstcache="25">onSelectionChanged</a> </li><li jsselect="events" jstcache="8" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAttached" jstcache="25">onAttached</a> </li><li jsselect="events" jstcache="8" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onDetached" jstcache="25">onDetached</a> </li><li jsselect="events" jstcache="8" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Tab" jstcache="26">Tab</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-connect"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">connect</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">Port</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">name</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getSelected"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getSelected</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.getSelected</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getAllInWindow"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getAllInWindow</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.getAllInWindow</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of Tab tabs</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabs</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">createProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">createProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">updateProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">updateProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">moveProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">moveProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="8"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-detectLanguage"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">detectLanguage</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.detectLanguage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">detect language of tab.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">string language</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">language</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*9"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-captureVisibleTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">captureVisibleTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.captureVisibleTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Captures the visible area of the visible tab in the given window.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">The target window. If <var jstcache="0">null</var> or <var jstcache="0">undefined</var>, the 'current' window will be assumed.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">string dataUrl</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">dataUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="">a data url encoding of the captured tab.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onCreated"></a> <h3 jscontent="name" jstcache="11">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onUpdated"></a> <h3 jscontent="name" jstcache="11">onUpdated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onUpdated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object changedProps</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">changedProps</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">status</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onMoved"></a> <h3 jscontent="name" jstcache="11">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object MoveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">MoveInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">fromIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">toIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onSelectionChanged"></a> <h3 jscontent="name" jstcache="11">onSelectionChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onSelectionChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object SelectInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">SelectInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="4"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onAttached"></a> <h3 jscontent="name" jstcache="11">onAttached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onAttached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object AttachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">AttachInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">newWindowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">newPosition</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="5"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onDetached"></a> <h3 jscontent="name" jstcache="11">onDetached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onDetached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object DetachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">DetachInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldWindowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldPosition</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*6"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Tab"></a> <h3 jscontent="id" jstcache="14">Tab</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">favIconUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.tabs API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="24">connect</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getSelected" jstcache="24">getSelected</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAllInWindow" jstcache="24">getAllInWindow</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="24">move</a> </li><li jsselect="functions" jstcache="7" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li><li jsselect="functions" jstcache="7" jsinstance="8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-detectLanguage" jstcache="24">detectLanguage</a> </li><li jsselect="functions" jstcache="7" jsinstance="*9"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-captureVisibleTab" jstcache="24">captureVisibleTab</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="25">onCreated</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onUpdated" jstcache="25">onUpdated</a> </li><li jsselect="events" jstcache="8" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="25">onMoved</a> </li><li jsselect="events" jstcache="8" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onSelectionChanged" jstcache="25">onSelectionChanged</a> </li><li jsselect="events" jstcache="8" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAttached" jstcache="25">onAttached</a> </li><li jsselect="events" jstcache="8" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onDetached" jstcache="25">onDetached</a> </li><li jsselect="events" jstcache="8" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Tab" jstcache="26">Tab</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-connect"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">connect</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16">Port</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">name</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">name</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="extension.html#type-Port">Port</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getSelected"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getSelected</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.getSelected</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getAllInWindow"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getAllInWindow</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.getAllInWindow</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of Tab tabs</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabs</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">createProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">createProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">updateProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">updateProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">moveProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">moveProperties</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="8"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-detectLanguage"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">detectLanguage</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.detectLanguage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">detect language of tab.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">string language</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">language</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*9"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-captureVisibleTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">captureVisibleTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.tabs.captureVisibleTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Captures the visible area of the visible tab in the given window.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33">The target window. If <var jstcache="0">null</var> or <var jstcache="0">undefined</var>, the 'current' window will be assumed.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">string dataUrl</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">dataUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="">a data url encoding of the captured tab.</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onCreated"></a> <h3 jscontent="name" jstcache="11">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Tab tab</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tab</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onUpdated"></a> <h3 jscontent="name" jstcache="11">onUpdated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onUpdated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object changedProps</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">changedProps</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">status</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onMoved"></a> <h3 jscontent="name" jstcache="11">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object MoveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">MoveInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">fromIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">toIndex</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onSelectionChanged"></a> <h3 jscontent="name" jstcache="11">onSelectionChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onSelectionChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object SelectInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">SelectInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="4"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onAttached"></a> <h3 jscontent="name" jstcache="11">onAttached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onAttached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object AttachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">AttachInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">newWindowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">newPosition</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="5"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onDetached"></a> <h3 jscontent="name" jstcache="11">onDetached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onDetached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId, object DetachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">DetachInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldWindowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">oldPosition</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*6"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer tabId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Tab"></a> <h3 jscontent="id" jstcache="14">Tab</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">tabId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">index</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">selected</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">title</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">favIconUrl</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index f48b0fe6..a85fe22 100755 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -36,10 +36,10 @@ <li><a href="pageActions.html">Page actions</a></li> <li><a href="background_pages.html">Background pages</a></li> <li><a href="content_scripts.html">Content scripts</a></li> - <li><a href="extension.html">Extension</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> - <li><a href="self.html">Self</a></li> + <li><a href="bookmarks.html">Bookmarks</a></li> + <li><a href="extension.html">Extension</a></li> <li><a href="npapi.html">NPAPI Plugins</a></li> <li><a href="packaging.html">Packaging</a></li> <li><a href="autoupdate.html">Autoupdate</a></li> diff --git a/chrome/common/extensions/docs/tool_strips.html b/chrome/common/extensions/docs/tool_strips.html deleted file mode 100755 index 027c67b..0000000 --- a/chrome/common/extensions/docs/tool_strips.html +++ /dev/null @@ -1 +0,0 @@ -<!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="pageTitle" jstcache="1">Tool_strips</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><style type="text/css" jstcache="0">body { display:none; }</style> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="hidden" jstcache="0" style="display: block; "> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="h1Header" jstcache="2">Tool_strips</span> </div> <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="h1Header" jstcache="2">Tool_strips</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">manifest.json</a> </li><li jstcache="0"><a href="tool_strips.html" jstcache="0">Toolstrips</a> </li><li jstcache="0"><a href="background_pages.html" jstcache="0">Background pages</a> </li><li jstcache="0"><a href="page_actions.html" jstcache="0">Page actions</a> </li><li jstcache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="6" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="10" href="self.html">Self</a> </li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a> </li><li jstcache="0"><a href="xhr.html" jstcache="0">Getting Data With XMLHttpRequest</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1] </li><li jstcache="0">[sample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="5"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pages, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips.</p><p jstcache="0"> </p><h3 jstcache="0">Status</h3> <p jstcache="0">Implementation in progress.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register your toolstrips in the extension manifest, like this:</p> <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }</pre> <p jstcache="0">You can create buttons that look like the bookmark bar buttons using this template:</p> <pre jstcache="0"><div class="toolstrip-button"> <!-- Image is optional and should be a 16x16 icon. --> <img src="path/to/some_icon.png"> <span>My Button</span> </div></pre> <h3 jstcache="0">Debugging Tips</h3> <ul jstcache="0"> <li jstcache="0">You can right click on a toolstrip to get a web inspector.</li> <li jstcache="0">alert(), prompt(), and confirm() don't work yet. Sorry about that.</li> <li jstcache="0">You can run toolstrips in the main content area by loading their URL, which would be something like chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html</li> </ul> <h3 jstcache="0">Design Tips</h3> <ul jstcache="0"> <li jstcache="0">Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.</li> <li jstcache="0">The toolbar automatically detects how much space a toolstrip needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.</li> <li jstcache="0">If you need to do more extensive UI, use the tab contents area or a pop up window.</li> <li jstcache="0">Remember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running application logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="4"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="11">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="12">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="13"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="14">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="15"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="30">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="27"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="31"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="30">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="16">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="27"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="31"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="30">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="17"> <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="callbackSignature" jstcache="28">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="27"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="31"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="30">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="5"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="18">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="14">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="15"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="27"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="31"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="30">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="25"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="26"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/toolstrip.html b/chrome/common/extensions/docs/toolstrip.html index 21f4e3b..848ff73 100755 --- a/chrome/common/extensions/docs/toolstrip.html +++ b/chrome/common/extensions/docs/toolstrip.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.toolstrip API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="24">expand</a> </li><li jsselect="functions" jstcache="7" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstcache="24">collapse</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5" style="display: none; "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pages, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips.</p><p jstcache="0"> </p><h3 jstcache="0">Status</h3> <p jstcache="0">Implementation in progress.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register your toolstrips in the extension manifest, like this:</p> <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }</pre> <p jstcache="0">You can create buttons that look like the bookmark bar buttons using this template:</p> <pre jstcache="0"><div class="toolstrip-button"> <!-- Image is optional and should be a 16x16 icon. --> <img src="path/to/some_icon.png"> <span>My Button</span> </div></pre> <h3 jstcache="0">Debugging Tips</h3> <ul jstcache="0"> <li jstcache="0">You can right click on a toolstrip to get a web inspector.</li> <li jstcache="0">alert(), prompt(), and confirm() don't work yet. Sorry about that.</li> <li jstcache="0">You can run toolstrips in the main content area by loading their URL, which would be something like chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html</li> </ul> <h3 jstcache="0">Design Tips</h3> <ul jstcache="0"> <li jstcache="0">Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.</li> <li jstcache="0">The toolbar automatically detects how much space a toolstrip needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.</li> <li jstcache="0">If you need to do more extensive UI, use the tab contents area or a pop up window.</li> <li jstcache="0">Remember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running application logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-expand"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">expand</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.toolstrip.expand</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">height</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.toolstrip.collapse</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5" style="display: none; "> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6" style="display: none; "> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.toolstrip API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="24">expand</a> </li><li jsselect="functions" jstcache="7" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstcache="24">collapse</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5" style="display: none; "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="25">eventName</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="26">id</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pages, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips.</p><p jstcache="0"> </p><h3 jstcache="0">Status</h3> <p jstcache="0">Implementation in progress.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register your toolstrips in the extension manifest, like this:</p> <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }</pre> <p jstcache="0">You can create buttons that look like the bookmark bar buttons using this template:</p> <pre jstcache="0"><div class="toolstrip-button"> <!-- Image is optional and should be a 16x16 icon. --> <img src="path/to/some_icon.png"> <span>My Button</span> </div></pre> <h3 jstcache="0">Debugging Tips</h3> <ul jstcache="0"> <li jstcache="0">You can right click on a toolstrip to get a web inspector.</li> <li jstcache="0">alert(), prompt(), and confirm() don't work yet. Sorry about that.</li> <li jstcache="0">You can run toolstrips in the main content area by loading their URL, which would be something like chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html</li> </ul> <h3 jstcache="0">Design Tips</h3> <ul jstcache="0"> <li jstcache="0">Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.</li> <li jstcache="0">The toolbar automatically detects how much space a toolstrip needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.</li> <li jstcache="0">If you need to do more extensive UI, use the tab contents area or a pop up window.</li> <li jstcache="0">Remember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running application logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-expand"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">expand</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.toolstrip.expand</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">height</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.toolstrip.collapse</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">string</span> <var jstcache="0"><span jscontent="name" jstcache="11">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5" style="display: none; "> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8"> <a jsvalues=".name:'event-' + name" jstcache="12"></a> <h3 jscontent="name" jstcache="11">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6" style="display: none; "> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9"> <a jsvalues=".name:'type-' + id" jstcache="13"></a> <h3 jscontent="id" jstcache="14">type name</h3> <div transclude="valueTemplate" jstcache="15"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> diff --git a/chrome/common/extensions/docs/windows.html b/chrome/common/extensions/docs/windows.html index db1daf0f4..4ddd91e 100755 --- a/chrome/common/extensions/docs/windows.html +++ b/chrome/common/extensions/docs/windows.html @@ -1 +1 @@ -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating 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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.windows API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getCurrent" jstcache="24">getCurrent</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getLastFocused" jstcache="24">getLastFocused</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAll" jstcache="24">getAll</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="25">onCreated</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li><li jsselect="events" jstcache="8" jsinstance="*2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onFocusChanged" jstcache="25">onFocusChanged</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Window" jstcache="26">Window</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get window with given id.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getCurrent"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getCurrent</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getCurrent</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get the window that is the container for the caller. i.e. the window containing the ToolStrip that makes the call.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getLastFocused"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getLastFocused</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getLastFocused</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get the window that was most recenly focused -- typically the window 'on top'.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getAll"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getAll</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getAll</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">boolean</span> <var jstcache="0"><span jscontent="name" jstcache="11">populate</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get all windows. If <var jstcache="0">populate</var> is true, each window object will have a <var jstcache="0">tabs</var> property that contains a list of the Tab objects for that window.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">populate</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of object windows</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windows</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">createData</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Create (open) a new browser with any optional sizing, position or default url provided.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">createData</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">width</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">updateInfo</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">updateInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">width</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onCreated"></a> <h3 jscontent="name" jstcache="11">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onFocusChanged"></a> <h3 jscontent="name" jstcache="11">onFocusChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onFocusChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Window"></a> <h3 jscontent="id" jstcache="14">Window</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">focused</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">bottom</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">right</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabs</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> +<!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="pageTitle" jstcache="1">[object HTMLDivElement]</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="2">chrome.windows API Reference</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" 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="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="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="4"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="7" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="24">get</a> </li><li jsselect="functions" jstcache="7" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getCurrent" jstcache="24">getCurrent</a> </li><li jsselect="functions" jstcache="7" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getLastFocused" jstcache="24">getLastFocused</a> </li><li jsselect="functions" jstcache="7" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAll" jstcache="24">getAll</a> </li><li jsselect="functions" jstcache="7" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="24">create</a> </li><li jsselect="functions" jstcache="7" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="24">update</a> </li><li jsselect="functions" jstcache="7" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="24">remove</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="5"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="8" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="25">onCreated</a> </li><li jsselect="events" jstcache="8" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="25">onRemoved</a> </li><li jsselect="events" jstcache="8" jsinstance="*2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onFocusChanged" jstcache="25">onFocusChanged</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" jstcache="6"> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="9" jsinstance="*0"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#type-Window" jstcache="26">Window</a> </li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="4"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="7" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get window with given id.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getCurrent"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getCurrent</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getCurrent</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get the window that is the container for the caller. i.e. the window containing the toolstrip that makes the call.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getLastFocused"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getLastFocused</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getLastFocused</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get the window that was most recenly focused -- typically the window 'on top'.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-getAll"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">getAll</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.getAll</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">boolean</span> <var jstcache="0"><span jscontent="name" jstcache="11">populate</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Get all windows. If <var jstcache="0">populate</var> is true, each window object will have a <var jstcache="0">tabs</var> property that contains a list of the Tab objects for that window.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">populate</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">array of object windows</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windows</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">createData</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20">Create (open) a new browser with any optional sizing, position or default url provided.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">createData</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">url</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">width</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">object</span> <var jstcache="0"><span jscontent="name" jstcache="11">updateInfo</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="1"> <!-- 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="35">updateInfo</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">width</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">height</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*2"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23">Window window</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">window</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="windows.html#type-Window">Window</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="7" jsinstance="*6"> <a jsvalues=".name:'method-' + name" jstcache="10" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="11">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="16" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="17">chrome.windows.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="27" style="display: none; ">, </span><span jscontent="getTypeName($this)" jstcache="28">integer</span> <var jstcache="0"><span jscontent="name" jstcache="11">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="18" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="27">, </span><span jscontent="getTypeName($this)" jstcache="28">function</span> <var jstcache="0"><span jscontent="name" jstcache="11">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" 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="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div><div jsselect="parameters" jstcache="29" jsinstance="*1"> <!-- 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="35">callback</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">function</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="21" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="30" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="22"> <div jsselect="getCallbackParameters(parameters)" jstcache="31"> <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="23"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0" style="display: none; "> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="5"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="8" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onCreated"></a> <h3 jscontent="name" jstcache="11">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="11">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="8" jsinstance="*2"> <a jsvalues=".name:'event-' + name" jstcache="12" name="event-onFocusChanged"></a> <h3 jscontent="name" jstcache="11">onFocusChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="11">onFocusChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="23">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="19">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="20" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="29" jsinstance="*0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="6"> <a name="#types" jstcache="0"></a> <h2 id="types" jstcache="0">Types</h2> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="9" jsinstance="*0"> <a jsvalues=".name:'type-' + id" jstcache="13" name="type-Window"></a> <h3 jscontent="id" jstcache="14">Window</h3> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35" style="display: none; ">windowId</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">object</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style=""> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="0"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">id</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="1"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">focused</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">boolean</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="2"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">left</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="3"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">top</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="4"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">bottom</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="5"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">right</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="display: none; ">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div><div jsselect="getPropertyListFromObject($this)" jstcache="36" jsinstance="*6"> <div jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="35">tabs</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="37" style="">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39"> <span jsdisplay="isArray($this)" jstcache="41" style=""> array of <span jsselect="items" jstcache="43"><span jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="38" style=""> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="40" href="tabs.html#type-Tab">Tab</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="39" style="display: none; "> <span jsdisplay="isArray($this)" jstcache="41" style="display: none; "> array of <span jsselect="items" jstcache="43"><span transclude="typeTemplate" jstcache="44"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42">integer</span> </span> </span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="42" style="display: none; ">integer</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="32"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="33" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="34" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="36"> <div transclude="valueTemplate" jstcache="15"> </div> </div> </dl> </dd> </div> </div> </dl> </dd> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> |