chrome/common/extensions/docs/api_index.html - Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc

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

Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)

Patch Set: touch grd. rendered docs Created 11 years, 3 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:

OLD	NEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag must retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="getPageTitle()" jstcache="1">chrome.* APIs</title> <link h ref="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <scrip t type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compile d.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_ge nerator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootst rap.js" jstcache="0"></script> </head><!-- <body> content is completely generate d. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="con tainer" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="ht tp://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <i nput type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache= "0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="tex t" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search " jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.go ogle.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" sr c="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcach e="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageT itle()" jstcache="1">chrome.* APIs</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></ li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a> </li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> < li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Develope r's Guide</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jst cache="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_script s.html" jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li j stcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a h ref="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookm arks.html" jstcache="0">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstc ache="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">Aut oupdate</li> </ul> </li> <li jstcache="0"><a href="tutorials.html" jstcache="0"> <div jstcache="0">Tutorials</div></a> <ul jstcache="0"> <li jstcache="0"><a href ="tut_debugging.html" jstcache="0">Debugging</a></li> </ul> </li> <li jstcache=" 0">Reference <ul jstcache="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li j stcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li> <li jst cache="0">Match Patterns</li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0" class="leftNavSelected">chrome.* APIs </li> <li jstcache="0"> < a href="api_other.html" jstcache="0">Other APIs</a> </li> </ul> </li> <li jstcac he="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/s amples" jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache ="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcach e="2" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <l i jsselect="getStaticTOC()" jstcache="9"> <a jscontent="name" jsvalues=".href:'# ' + href" jstcache="14">h2Name</a> <ol jstcache="0"> <li jsselect="$this.childre n" jstcache="22"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14"> h3Name</a> </li> </ol> </li> <div jsselect="apiDefinition" jstcache="3"> <li jst cache="0"> <a href="#apiReference" jscontent="'API reference: ' + getModuleName( )" jstcache="4">API reference</a> <ol jstcache="0"> <li jsdisplay="$this.propert ies" jstcache="5"> <a href="#properties" jstcache="0">Properties</a> <ol jstcach e="0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jsconte nt="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache= "41">propertyName</a> </li> </ol> </li> <li jsdisplay="functions && func tions.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> < ol jstcache="0"> <li jsselect="functions" jstcache="11"> <a jscontent="name" jsv alues=".href:'#method-' + name" href="#method-anchor" jstcache="42">methodName</ a> </li> </ol> </li> <li jsdisplay="events && events.length > 0" jstc ache="7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jssele ct="events" jstcache="12"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="43">eventName</a> </li> </ol> </li> <li jsdispla y="types && types.length > 0" jstcache="8"> <a href="#types" jstcache ="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jsconten t="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </l i> </ol> </li> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-t itle" class="pageData" jstcache="0">chrome.* APIs</div> <p jstcache="0"> Google Chrome provides APIs such as <code jstcache="0">chrome.bookmarks</code> and <cod e jstcache="0">chrome.tab</code> so that extensions can interact with the browse r. Here are the supported chrome.* APIs: </p> <ul jstcache="0"> <li jstcache="0" ><a href="bookmarks.html" jstcache="0">bookmarks</a></li> <li jstcache="0"><a hr ef="extension.html" jstcache="0">extension</a></li> <li jstcache="0"><a href="pa geActions.html" jstcache="0">pageActions</a></li> <li jstcache="0">self</li> <li jstcache="0"><a href="tabs.html" jstcache="0">tabs</a></li> <li jstcache="0"><a href="toolstrip.html" jstcache="0">toolstrip</a></li> <li jstcache="0"><a href= "windows.html" jstcache="0">windows</a></li> </ul> <p jstcache="0"> Unless the d oc says otherwise, methods in the chrome.* APIs are asynchronous: they return im mediately, without waiting for the operation to finish. If you need to know the outcome of an operation, then you pass a callback function into the method. <spa n class="comment" jstcache="0">[PENDING: update/elaborate on that]</span> </p> < /div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache=" 3" style="display: none; "> <a name="apiReference" jstcache="0"></a> <h2 jsconte nt="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.apin ame </h2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> <a name="properties" jstcache="0"></a> <h3 id="properties" jstcac he="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)" jstcache ="10"> <a jsvalues=".name:'property-' + name" jstcache="15"></a> <h4 jscontent=" name" jstcache="16">getLastError</h4> <div class="summary" jstcache="0"> <!-- No te: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstcache="24"> lastError</span> </div> <div transclude="valueTemplate" jstcache="17"> </div> </ div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions && amp; functions.length > 0" class="apiGroup" id="methods" jstcache="6"> <a nam e="methods" jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- iterates over a ll functions --> <div class="apiItem" jsselect="functions" jstcache="11"> <a jsv alues=".name:'method-' + name" jstcache="18"></a> <!-- method-anchor --> <h4 jsc ontent="name" jstcache="16">method name</h4> <div class="summary" jstcache="0">< span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">void</sp an> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQual ifiedFunctionName($this)" jstcache="26">chrome.module.methodName</span>(<span js select="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27"><s pan jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this )" jstcache="34"></span> <var jstcache="0"><span jscontent="name" jstcache="16"> </span></var></span>)</div> <div class="description" jstcache="0"> <p class="tod o" jsdisplay="!description" jstcache="28">Undocumented.</p> <p jsdisplay="descri ption" jsvalues=".innerHTML:description" jstcache="29"> A description from the j son schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache= "0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate transcl ude --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var jsdisplay= "$this.name" jscontent="$this.name" jstcache="45">paramName</var> <em jstcache=" 0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="optio nal" jsdisplay="optional" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47"> <a jsvalues=".h ref: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef ($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" js tcache="48"> <span jsdisplay="isArray($this)" jstcache="50"> array of <span jsse lect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span> </span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">paramType</span> </span> </span> ) </div> </em> </dt> <dd class=" todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdi splay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="39"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIE S --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div transclude ="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30">Returns</h4 > <dl jstcache="0"> <div jsselect="returns" jstcache="36"> <div transclude="valu eTemplate" jstcache="17"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay= "hasCallback(parameters)" jstcache="31"> <div jsselect="getCallbackParameters(pa rameters)" jstcache="37"> <h4 jstcache="0">Callback function</h4> <p jstcache="0 "> If you specify the <em jstcache="0">callback</em> parameter, it should specif y a function that looks like this: </p> <!-- Note: intentionally longer 80 colum ns --> <pre jstcache="0">function(<span jscontent="getSignatureString(parameters )" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache ="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" jstcache= "35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGro up --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" c lass="apiGroup" jstcache="7"> <a name="events" jstcache="0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- iterates over all events --> <div jsselect="event s" class="apiItem" jstcache="12"> <a jsvalues=".name:'event-' + name" jstcache=" 19"></a> <h4 jscontent="name" jstcache="16">event name</h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="g etModuleName() + '.'" class="subdued" jstcache="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><span class="subdued" jstcache="0" >.addListener</span>(function(<span jscontent="getSignatureString(parameters)" j stcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0" >{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" js display="!description" jstcache="28">Undocumented.</p> <p jsdisplay="description " jsvalues=".innerHTML:description" jstcache="29"> A description from the json s chema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Para meters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <div tra nsclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> <!-- /decripti on --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div js display="types && types.length > 0" class="apiGroup" jstcache="8"> <a name="types" jstcache="0"></a> <h3 id="types" jstcache="0">Types</h3> <!-- iter ates over all types --> <div jsselect="types" class="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" jstcache="20"></a> <h4 jscontent="id" jstcache="21 ">type name</h4> <div transclude="valueTemplate" jstcache="17"> </div> </div> <! -- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- / mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache= "0"> <p jstcache="0"> Except as otherwise <a href="http://code.google.com/polici es.html#restrictions" jstcache="0">noted</a>, the content of this page is licens ed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons Attribution 3.0 License</a>, and code samples are licensed under the <a rel="license" href="http://code.google.com/google_bsd_lic ense.html" jstcache="0">BSD License</a>. </p> <p jstcache="0"> ©2009 Google </p> </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>	1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

	2 1) The <head> information in this page is significant, should be uniform

	3 across api docs and should be edited only with knowledge of the

	4 templating mechanism.

	5 2) The <body> tag must retain id="body"

	6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

	7 browser, it will be re-generated from the template, json schema and

	8 authored overview content.

	9 4) The <body>.innerHTML is also generated by an offline step so that this

	10 page may easily be indexed by search engines.

	11

	12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single

	13 version of page template shell and the "instance" pages (bookmarks.html,

	14 etc...) can be generated with a build step.

	15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x html" jstcache="0"><!-- <head> data is significant and loads the needed librarie s and styles --><head jstcache="0">

	16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache= "0">

	17 <title jscontent="getPageTitle()" jstcache="1">chrome.* APIs</title>

	18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache= "0">

	19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js" jstcache="0">

	20 </script>

	21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0">< /script>

	22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script>

	23 </head><!-- <body> content is completely generated. Do not edit, as it will be

	24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0">

	25 <a name="top" jstcache="0"> </a>

	26 <!-- API HEADER -->

	27 <div id="pageHeader" jstcache="0">

	28 <div id="searchbox" jstcache="0">

	29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0 ">

	30 <div jstcache="0">

	31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq tno" jstcache="0">

	32 <input type="hidden" name="ie" value="UTF-8" jstcache="0">

	33 <input type="text" name="q" size="31" jstcache="0">

	34 <input type="submit" name="sa" value="Search" jstcache="0">

	35 </div>

	36 </form>

	37

	38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach e="0"></script>

	39 <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>

	40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n? form=cse-search-box&t13n_langs=en" jstcache="0"></script>

	41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand ?form=cse-search-box&lang=en" jstcache="0"></script>

	42 </div>

	43 <div id="pageTitle" jstcache="0">

	44 <h1 jscontent="getPageTitle()" jstcache="1">chrome.* APIs</h1>

	45 </div>

	46 </div> <!-- /pageHeader -->

	47

	48 <div id="pageContent" jstcache="0">

	49 <!-- SIDENAV -->

	50 <div id="leftNav" jstcache="0">

	51 <ul jstcache="0">

	52 <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li>

	53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start ed</a></li>

	54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l i>

	55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache=" 0">Developer's Guide</div></a>

	56 <ul jstcache="0">

	57 <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips< /a></li>

	58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti ons</a></li>

	59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back ground Pages</a></li>

	60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte nt Scripts</a></li>

	61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li >

	62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li>

	63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></ li>

	64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</ a></li>

	65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li >

	66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</ a></li>

	67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</ a></li>

	68 <li jstcache="0">Autoupdate</li>

	69 </ul>

	70 </li>

	71 <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache=" 0">Tutorials</div></a>

	72 <ul jstcache="0">

	73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi ng</a></li>

	74 </ul>

	75 </li>

	76 <li jstcache="0">Reference

	77 <ul jstcache="0">

	78 <li jstcache="0"> Formats

	79 <ul jstcache="0">

	80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li>

	81 <li jstcache="0"><a href="match_patterns.html" jstcache="0">Ma tch Patterns</a></li>

	82 <li jstcache="0">Packages (.crx)</li>

	83 </ul>

	84 </li>

	85 <li jstcache="0" class="leftNavSelected">chrome.* APIs </li>

	86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs </a> </li>

	87 </ul>

	88 </li>

	89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc uments/extensions/samples" jstcache="0">Samples</a></li>

	90 </ul>

	91 </div>

	92

	93 <div id="mainColumn" jstcache="0">

	94 <!-- TABLE OF CONTENTS -->

	95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: non e; ">

	96 <p jstcache="0">Contents</p>

	97 <ol jstcache="0">

	98 <li jsselect="getStaticTOC()" jstcache="9">

	99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Na me</a>

	100 <ol jstcache="0">

	101 <li jsselect="$this.children" jstcache="22">

	102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14"> h3Name</a>

	103 </li>

	104 </ol>

	105 </li>

	106 <div jsselect="apiDefinition" jstcache="3">

	107 <li jstcache="0">

	108 <a href="#apiReference" jscontent="'API reference: ' + getModule Name()" jstcache="4">API reference</a>

	109 <ol jstcache="0">

	110 <li jsdisplay="$this.properties" jstcache="5">

	111 <a href="#properties" jstcache="0">Properties</a>

	112 <ol jstcache="0">

	113 <li jsselect="getPropertyListFromObject($this)" jstcache=" 10">

	114 <a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>

	115 </li>

	116 </ol>

	117 </li>

	118 <li jsdisplay="functions && functions.length > 0" j stcache="6">

	119 <a href="#methods" jstcache="0">Methods</a>

	120 <ol jstcache="0">

	121 <li jsselect="functions.sort(sortByName)" jstcache="11">

	122 <a jscontent="name" jsvalues=".href:'#method-' + name" h ref="#method-anchor" jstcache="43">methodName</a>

	123 </li>

	124 </ol>

	125 </li>

	126 <li jsdisplay="events && events.length > 0" jstcach e="7">

	127 <a href="#events" jstcache="0">Events</a>

	128 <ol jstcache="0">

	129 <li jsselect="events.sort(sortByName)" jstcache="12">

	130 <a jscontent="name" jsvalues=".href:'#event-' + name" hr ef="#event-anchor" jstcache="44">eventName</a>

	131 </li>

	132 </ol>

	133 </li>

	134 <li jsdisplay="types && types.length > 0" jstcache= "8">

	135 <a href="#types" jstcache="0">Types</a>

	136 <ol jstcache="0">

	137 <li jsselect="types.sort(sortByName)" jstcache="38">

	138 <a jscontent="id" jsvalues=".href:'#type-' + id" href="# id-anchor" jstcache="45">id</a>

	139 </li>

	140 </ol>

	141 </li>

	142 </ol>

	143 </li>

	144 </div>

	145 </ol>

	146 </div>

	147 <!-- /TABLE OF CONTENTS -->

	148

	149 <!-- STATIC CONTENT PLACEHOLDER -->

	150 <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">chrome.* APIs</div>

	151

	152 <p jstcache="0">

	153 Google Chrome provides APIs such as

	154 <code jstcache="0">chrome.bookmarks</code> and <code jstcache="0">chrome.tab</co de>

	155 so that extensions can interact with the browser.

	156 Here are the supported chrome.* APIs:

	157 </p>

	158

	159 <ul jstcache="0">

	160 <li jstcache="0"><a href="bookmarks.html" jstcache="0">bookmarks</a></li>

	161 <li jstcache="0"><a href="extension.html" jstcache="0">extension</a></li>

	162 <li jstcache="0"><a href="pageActions.html" jstcache="0">pageActions</a></li>

	163 <li jstcache="0">self</li>

	164 <li jstcache="0"><a href="tabs.html" jstcache="0">tabs</a></li>

	165 <li jstcache="0"><a href="toolstrip.html" jstcache="0">toolstrip</a></li>

	166 <li jstcache="0"><a href="windows.html" jstcache="0">windows</a></li>

	167 </ul>

	168

	169 <p jstcache="0">

	170 Unless the doc says otherwise,

	171 methods in the chrome.* APIs are asynchronous:

	172 they return immediately,

	173 without waiting for the operation to finish.

	174 If you need to know the outcome of an operation,

	175 then you pass a callback function into the method.

	176 <span class="comment" jstcache="0">[PENDING: update/elaborate on that]</span>

	177 </p>

	178 </div>

	179

	180 <!-- API PAGE -->

	181 <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="displa y: none; ">

	182 <a name="apiReference" jstcache="0"></a>

	183 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref erence: chrome.apiname </h2>

	184

	185 <!-- PROPERTIES -->

	186 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5">

	187 <a name="properties" jstcache="0"></a>

	188 <h3 id="properties" jstcache="0">Properties</h3>

	189

	190 <div jsselect="getPropertyListFromObject($this)" jstcache="10">

	191 <a jsvalues=".name:'property-' + name" jstcache="15"></a>

	192 <h4 jscontent="name" jstcache="16">getLastError</h4>

	193 <div class="summary" jstcache="0">

	194 <!-- Note: intentionally longer 80 columns -->

	195 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext ension</span><span jscontent="$this.name" jstcache="24">lastError</span>

	196 </div>

	197 <div transclude="valueTemplate" jstcache="17">

	198 </div>

	199 </div>

	200

	201 </div> <!-- /apiGroup -->

	202

	203 <!-- METHODS -->

	204 <div jsdisplay="functions && functions.length > 0" class="a piGroup" id="methods" jstcache="6">

	205 <a name="methods" jstcache="0"></a>

	206 <h3 jstcache="0">Methods</h3>

	207

	208 <!-- iterates over all functions -->

	209 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache= "11">

	210 <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- metho d-anchor -->

	211 <h4 jscontent="name" jstcache="16">method name</h4>

	212

	213 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25">void</span>

	214 <!-- Note: intentionally longer 80 columns -->

	215 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="cla ss:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache=" 33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span>

	216 <var jstcache="0"><span jscontent="name" jstcache="16"></s pan></var></span>)</div>

	217

	218 <div class="description" jstcache="0">

	219 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>

	220 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">

	221 A description from the json schema def of the function goes he re.

	222 </p>

	223

	224 <!-- PARAMETERS -->

	225 <h4 jstcache="0">Parameters</h4>

	226 <dl jstcache="0">

	227 <div jsselect="parameters" jstcache="35">

	228

	229 <!-- VALUE: This is a subtemplate that is used elsewhere

	230 via jsTemplate transclude -->

	231 <div id="valueTemplate" jstcache="0">

	232 <dt jstcache="0">

	233 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">paramName</var>

	234 <em jstcache="0">

	235

	236 <!-- TYPE -->

	237 <div style="display:inline" jstcache="0">

	238 (

	239 <span class="optional" jsdisplay="optional" jstc ache="47">optional</span>

	240 <span id="typeTemplate" jstcache="0">

	241 <span jsdisplay="getTypeRef($this)" jstcache=" 48">

	242 <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type< /a>

	243 </span>

	244 <span jsdisplay="!getTypeRef($this)" jstcache= "49">

	245 <span jsdisplay="isArray($this)" jstcache="5 1">

	246 array of <span jsselect="items" jstcache=" 53"><span transclude="typeTemplate" jstcache="54"></span></span>

	247 </span>

	248 <span jsdisplay="!isArray($this)" jscontent= "getTypeName($this)" jstcache="52">paramType</span>

	249 </span>

	250 </span>

	251 )

	252 </div>

	253

	254 </em>

	255 </dt>

	256 <dd class="todo" jsdisplay="!$this.description" jstcache=" 39">

	257 Undocumented.

	258 </dd>

	259 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40">

	260 Description of this parameter from the json schema.

	261 </dd>

	262

	263 <!-- OBJECT PROPERTIES -->

	264 <dd jsdisplay="shouldExpandObject($this)" jstcache="41">

	265 <dl jstcache="0">

	266 <div jsselect="getPropertyListFromObject($this)" jstca che="10">

	267 <div transclude="valueTemplate" jstcache="17">

	268 </div>

	269 </div>

	270 </dl>

	271 </dd>

	272 </div> <!-- /VALUE -->

	273

	274 </div>

	275 </dl>

	276

	277 <!-- RETURNS -->

	278 <h4 jsdisplay="returns" jstcache="30">Returns</h4>

	279 <dl jstcache="0">

	280 <div jsselect="returns" jstcache="36">

	281 <div transclude="valueTemplate" jstcache="17">

	282 </div>

	283 </div>

	284 </dl>

	285

	286 <!-- CALLBACK -->

	287 <div jsdisplay="hasCallback(parameters)" jstcache="31">

	288 <div jsselect="getCallbackParameters(parameters)" jstcache="37 ">

	289 <h4 jstcache="0">Callback function</h4>

	290 <p jstcache="0">

	291 If you specify the <em jstcache="0">callback</em> parameter,

	292 it should specify a function that looks like this:

	293 </p>

	294

	295 <!-- Note: intentionally longer 80 columns -->

	296 <pre jstcache="0">function(<span jscontent="getSignatureString (parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue d" jstcache="0">{...}</span>);</pre>

	297 <dl jstcache="0">

	298 <div jsselect="parameters" jstcache="35">

	299 <div transclude="valueTemplate" jstcache="17">

	300 </div>

	301 </div>

	302 </dl>

	303 </div>

	304 </div>

	305

	306 </div> <!-- /description -->

	307

	308 </div> <!-- /apiItem -->

	309

	310 </div> <!-- /apiGroup -->

	311

	312 <!-- EVENTS -->

	313 <div jsdisplay="events && events.length > 0" class="apiGrou p" jstcache="7">

	314 <a name="events" jstcache="0"></a>

	315 <h3 id="events" jstcache="0">Events</h3>

	316

	317 <!-- iterates over all events -->

	318 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12 ">

	319 <a jsvalues=".name:'event-' + name" jstcache="19"></a>

	320 <h4 jscontent="name" jstcache="16">event name</h4>

	321

	322 <div class="summary" jstcache="0">

	323 <!-- Note: intentionally longer 80 columns -->

	324 <span jscontent="getModuleName() + '.'" class="subdued" jstcache ="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span> <span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent= "getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);

	325 </div>

	326

	327 <div class="description" jstcache="0">

	328 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>

	329 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">

	330 A description from the json schema def of the event goes here.

	331 </p>

	332

	333 <!-- PARAMETERS -->

	334 <h4 jstcache="0">Parameters</h4>

	335 <dl jstcache="0">

	336 <div jsselect="parameters" jstcache="35">

	337 <div transclude="valueTemplate" jstcache="17">

	338 </div>

	339 </div>

	340 </dl>

	341

	342 </div> <!-- /decription -->

	343

	344 </div> <!-- /apiItem -->

	345

	346 </div> <!-- /apiGroup -->

	347

	348 <!-- TYPES -->

	349 <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="8">

	350 <a name="types.sort(sortByName)" jstcache="0"></a>

	351 <h3 id="types" jstcache="0">Types</h3>

	352

	353 <!-- iterates over all types -->

	354 <div jsselect="types" class="apiItem" jstcache="13">

	355 <a jsvalues=".name:'type-' + id" jstcache="20"></a>

	356 <h4 jscontent="id" jstcache="21">type name</h4>

	357

	358 <div transclude="valueTemplate" jstcache="17">

	359 </div>

	360

	361 </div> <!-- /apiItem -->

	362

	363 </div> <!-- /apiGroup -->

	364

	365 </div> <!-- /apiPage -->

	366 </div> <!-- /mainColumn -->

	367 </div> <!-- /pageContent -->

	368 <div id="pageFooter" --="" jstcache="0">

	369 <p jstcache="0">

	370 Except as otherwise <a href="http://code.google.com/policies.html#restrictions " jstcache="0">noted</a>,

	371 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons

	372 Attribution 3.0 License</a>, and code samples are licensed under the

	373 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach e="0">BSD License</a>.

	374 </p>

	375 <p jstcache="0">

	376 ©2009 Google

	377 </p>

	378 </div> <!-- /pageFooter -->

	379 </div> <!-- /container -->
	Aaron Boodman 2009/09/02 08:12:24 Hooray for \n and \t! Hooray for \n and \t!
	380 </body></html>

	381 #EOF
	Aaron Boodman 2009/09/02 08:12:24 Err, is this #EOF actually in the file? Won't that Err, is this #EOF actually in the file? Won't that render?
OLD	NEW

« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/api_other.html » ('j') | no next file with comments »