Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(5)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/self.html

Issue 165323: Add chrome.extension to extension_api.json and docs (Closed)
Patch Set: precommit Created 11 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « chrome/common/extensions/docs/pageActions.html ('k') | chrome/common/extensions/docs/tabs.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">chrome.self API Reference</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 g enerated. 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"> <!-- BREADCRUMB --> <!-- TODO: Fix these hr efs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Go ogle Chrome Extensions</a> &gt; <a href="reference_index.html" jstcache="0">Refe rence</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <spa n jscontent="h1Header" jstcache="2">chrome.self</span> </div> <div id="searchbox " jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jst cache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403 910741006: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="tex t/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script t ype="text/javascript" jstcache="0">google.load("elements", "1", {packages: "tran sliteration"});</script> <script type="text/javascript" src="http://www.google.c om/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en" jstcache="0"></script> < script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse -search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstca che="0"> <h1 jscontent="h1Header" jstcache="2">chrome.self</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="pag eActions.html" jstcache="0">Page actions</a> </li><li jstcache="0"><a href="back ground_pages.html" jstcache="0">Background pages</a> </li><li jstcache="0"><a hr ef="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="window s.html" jstcache="0">Windows</a> </li><li jstcache="0"><a href="self.html" jstca che="0">Self</a> </li><li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI P lugins</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">[sa mple 1] </li><li jstcache="0">[sample 2] </li></ul> </li></ul> </div> <div id="m ainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiD efinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstc ache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <l i jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcach e="0"> <li jsselect="functions" jstcache="4" jsinstance="*0"> <a jscontent="name " jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="17">getVi ews</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Event s</a> <ol jstcache="0"> <li jsselect="events" jstcache="5" jsinstance="*0" style ="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href=" #event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0" >TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkT reeNode" 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 CONTENT S --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEG IN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overv iew Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div cla ss="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h 2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="api Item" jsselect="functions" jstcache="4" jsinstance="*0"> <a jsvalues=".name:'met hod-' + name" jstcache="6" name="method-getViews"></a> <!-- method-anchor --> <h 3 jscontent="name" jstcache="7">getViews</h3> <div class="summary" jstcache="0"> <span jsdisplay="returns" jscontent="returns.typeName" jstcache="9">array of obj ect</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullN ame" jstcache="10">chrome.self.getViews</span>(<span jsselect="parameters" jsval ues="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*0" style="disp lay: none; "><span jsdisplay="$index" jstcache="19">, </span><span jscontent="ty peName" jstcache="20"></span> <var jstcache="0"><span jscontent="name" jstcache= "7"></span></var></span>)</div> <div class="description" jstcache="0"> <p class= "todo" jsdisplay="!description" jstcache="12" style="display: none; ">Undocument ed.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="1 3">Returns an array of the global JavaScript objects for each of the views runni ng 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="21" jsinstance="*0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" j stcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="24"> Description of this parame ter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_prope rtyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache ="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsc ontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="option al" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName " jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this. description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description " jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this par ameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcache="0"> <div js select="returns" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longe r 80 columns --> <var jscontent="name" jstcache="7">&lt;!--framePath //&lt;!--fr ame0--&gt;--&gt;</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20 ">array of object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descript ion" jstcache="23" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$ this.description" jsvalues=".innerHTML:$this.description" jstcache="24">Array of HTMLWindow objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList " jstcache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_prope rtyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 col umns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<s pan class="optional" jsdisplay="optional" jstcache="28">optional </span><span js content="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" j sdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay=" $this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descri ption of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </ dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15" style ="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a fu nction that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="26">Ty pe param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27"> <dt j stcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name " jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstc ache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsva lues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_property List" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="2 9"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" j stcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="24"> Description of this parame ter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <! -- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVEN TS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcach e="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all event s --> <div jsselect="events" class="apiItem" jstcache="5" jsinstance="*0" style= "display: none; "> <a jsvalues=".name:'event-' + name" jstcache="8"></a> <h3 jsc ontent="name" jstcache="7">event name</h3> <div class="summary" jstcache="0"> <! -- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0"> chrome.bookmarks.</span><span jscontent="name" jstcache="7">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callS ignature" jstcache="16">Type param1, Type param2</span>) <span class="subdued" j stcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p clas s="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay=" description" jsvalues=".innerHTML:description" jstcache="13"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcac he="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21 "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconte nt="name" jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeNa me" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$thi s.description" jstcache="23">Undocumented.</dd> <dd jsdisplay="$this.description " jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this par ameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_pr opertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstca che="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="opt ional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeN ame" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$th is.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descript ion" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!- - /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id=" pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/ license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html> 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">chrome.self API Reference</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 g enerated. 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"> <!-- BREADCRUMB --> <!-- TODO: Fix these hr efs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Go ogle Chrome Extensions</a> &gt; <a href="reference_index.html" jstcache="0">Refe rence</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <spa n jscontent="h1Header" jstcache="2">chrome.self</span> </div> <div id="searchbox " jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jst cache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403 910741006: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="tex t/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script t ype="text/javascript" jstcache="0">google.load("elements", "1", {packages: "tran sliteration"});</script> <script type="text/javascript" src="http://www.google.c om/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en" jstcache="0"></script> < script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse -search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstca che="0"> <h1 jscontent="h1Header" jstcache="2">chrome.self</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="pag eActions.html" jstcache="0">Page actions</a> </li><li jstcache="0"><a href="back ground_pages.html" jstcache="0">Background pages</a> </li><li jstcache="0"><a hr ef="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 hr ef="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="mainCol umn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinit ion" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache=" 0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstca che="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstc ache="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" jsinstance="*0"> <a jscontent="name" jsva lues=".href:'#method-' + name" href="#method-getViews" jstcache="17">getViews</a > </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="5" jsinstance="*0" style="disp lay: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event -anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNod e" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s s hould go here -- would it be possible to link to overview h3s, as well? if so, h ow should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUT HORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Go es Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class= "apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div class="ap iGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstc ache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="4" jsinstance="*0"> <a jsvalues=".name:'method-' + name" jstcache="6" name="method-getViews"></a> <!-- method-anchor --> <h3 jsco ntent="name" jstcache="7">getViews</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="9">array of object</s pan> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" j stcache="10">chrome.self.getViews</span>(<span jsselect="parameters" jsvalues="c lass:optional ? 'optional' : ''" jstcache="11" jsinstance="*0" style="display: n one; "><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName " jstcache="20"></span> <var jstcache="0"><span jscontent="name" jstcache="7"></ span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12" style="display: none; ">Undocumented.</p > <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13">Ret urns an array of the global JavaScript objects for each of the views running ins ide the current extension. This includes toolstrips, background pages, and tabs. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21" jsinstance="*0" style="display: none; "> <d t jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="n ame" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdis play="optional" jstcache="28">optional </span><span jscontent="typeName" jstcach e="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descripti on" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalue s=".innerHTML:$this.description" jstcache="24"> Description of this parameter fr om the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyLis t" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent ="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" js display="optional" jstcache="28">optional </span><span jscontent="typeName" jstc ache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsva lues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h 4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcache="0"> <div jsselect ="returns" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longer 80 c olumns --> <var jscontent="name" jstcache="7">&lt;!--framePath //&lt;!--frame0-- &gt;--&gt;</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20">arra y of object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="23" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.d escription" jsvalues=".innerHTML:$this.description" jstcache="24">Array of HTMLW indow objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstc ache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyLis t" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns - -> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span cl ass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconten t="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdispl ay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this. description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <! -- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15" style="displa y: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you spec ify the <em jstcache="0">callback</em> parameter, it should specify a function t hat looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre js tcache="0">function(<span jscontent="callbackSignature" jstcache="26">Type param 1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> < dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20 ">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".i nnerHTML:$this.description" jstcache="24"> Description of this parameter from th e json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" js tcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam e" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdispl ay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache= "20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description " jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues= ".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /desc ription --> </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 --> <d iv jsselect="events" class="apiItem" jstcache="5" jsinstance="*0" style="display : none; "> <a jsvalues=".name:'event-' + name" jstcache="8"></a> <h3 jscontent=" name" jstcache="7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.b ookmarks.</span><span jscontent="name" jstcache="7">onEvent</span><span class="s ubdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature " jstcache="16">Type param1, Type param2</span>) <span class="subdued" jstcache= "0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="descript ion" jsvalues=".innerHTML:description" jstcache="13"> A description from the jso n schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">P arameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21"> <dt j stcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name " jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstc ache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="23">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalu es=".innerHTML:$this.description" jstcache="24"> Description of this parameter f rom the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyLi st" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29" > <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconten t="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" j sdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jst cache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descr iption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsv alues=".innerHTML:$this.description" jstcache="24"> Description of this paramete r from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decri ption --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPag e --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFoot er" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /c ontainer --> </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/pageActions.html ('k') | chrome/common/extensions/docs/tabs.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698