chrome/common/extensions/docs/test.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/test.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.test</title> <link hre f="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_gene rator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstra p.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="conta iner" 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"> <inp ut 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.goog le.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0" >google.load("elements", "1", {packages: "transliteration"});</script> <script t ype="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-b ox&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="getPageTit le()" jstcache="1">chrome.test</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 j stcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstc ache="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcach e="0">Page Actions</a></li> <li jstcache="0"><a href="background_pages.html" jst cache="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.ht ml" jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li jstca che="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href= "windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks .html" jstcache="0">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache ="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0">< a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0">Autoupd ate</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="tu t_debugging.html" jstcache="0">Debugging</a></li> </ul> </li> <li jstcache="0">R eference <ul jstcache="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstca che="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li> <li jstcach e="0">Match Patterns</li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs</a> </li> </ul> < /li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documen ts/extensions/samples" jstcache="0">Samples</a></li> </ul> </div> <div id="mainC olumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPag eTOC()" jstcache="2"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jsselec t="getStaticTOC()" jstcache="9" jsinstance="0" style="display: none; "> <a jsco ntent="name" jsvalues=".href:'#' + href" jstcache="14">h2Name</a> <ol jstcache=" 0"> <li jsselect="$this.children" jstcache="22"> <a jscontent="name" jsvalues=". href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li> <div jsselect="apiDe finition" jstcache="3"> <li jstcache="0"> <a href="#apiReference" jscontent="'AP I reference: ' + getModuleName()" jstcache="4">API reference: chrome.test</a> <o l jstcache="0"> <li jsdisplay="$this.properties" jstcache="5" style="display: no ne; "> <a href="#properties" jstcache="0">Properties</a> <ol jstcache="0"> <li j sselect="getPropertyListFromObject($this)" jstcache="10"> <a jscontent="name" js values=".href:'#property-' + name" href="#property-anchor" jstcache="41">propert yName</a> </li> </ol> </li> <li jsdisplay="functions && functions.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache= "0"> <li jsselect="functions" jstcache="11" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-notifyFail" jstcache="42">notif yFail</a> </li><li jsselect="functions" jstcache="11" jsinstance="1"> <a jsconte nt="name" jsvalues=".href:'#method-' + name" href="#method-notifyPass" jstcache= "42">notifyPass</a> </li><li jsselect="functions" jstcache="11" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-log" jstca che="42">log</a> </li> </ol> </li> <li jsdisplay="events && events.lengt h > 0" jstcache="7" style="display: none; "> <a href="#events" jstcache="0">E vents</a> <ol jstcache="0"> <li jsselect="events" jstcache="12"> <a jscontent="n ame" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="43">eventN ame</a> </li> </ol> </li> <li jsdisplay="types && types.length > 0" j stcache="8" style="display: none; "> <a href="#types" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="id" jsvalues=". href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li> </ol> </li> </o l> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLA CEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE --> <div class=" apiPage" jsselect="apiDefinition" jstcache="3"> <a name="apiReference" jstcache= "0"></a> <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API re ference: chrome.test</h2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="apiGroup" jstcache="5" style="display: none; "> <a name="properties" jstc ache="0"></a> <h3 id="properties" jstcache="0">Properties</h3> <div jsselect="ge tPropertyListFromObject($this)" jstcache="10"> <a jsvalues=".name:'property-' + name" jstcache="15"></a> <h4 jscontent="name" jstcache="16">getLastError</h4> <d iv class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension</span><sp an jscontent="$this.name" jstcache="24">lastError</span> </div> <div transclude= "valueTemplate" jstcache="17"> </div> </div> </div> <!-- /apiGroup --> <!-- METH ODS --> <div jsdisplay="functions && functions.length > 0" class="api Group" id="methods" jstcache="6"> <a name="methods" jstcache="0"></a> <h3 jstcac he="0">Methods</h3> <!-- iterates over all functions --> <div class="apiItem" js select="functions" jstcache="11" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="18" name="method-notifyFail"></a> <!-- method-anchor --> <h4 jsc ontent="name" jstcache="16">notifyFail</h4> <div class="summary" jstcache="0"><s pan jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25" style="di splay: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.test.notif yFail</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27" jsinstance="0" class="null"><span jsdisplay="$index" jstcach e="33" style="display: none; ">, </span><span jscontent="getTypeName($this)" jst cache="34">string</span> <var jstcache="0"><span jscontent="name" jstcache="16"> message</span></var></span>)</div> <div class="description" jstcache="0"> <p cla ss="todo" jsdisplay="!description" jstcache="28" style="display: none; ">Undocum ented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache ="29">Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.</p> <!-- PARAMETERS --> <h4 jstcac he="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35 " jsinstance="0"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate transclude --> <div id="valueTemplate" jstcache="0"> <dt jstcache=" 0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">message</va r> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( < span class="optional" jsdisplay="optional" jstcache="46" style="display: none; " >optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeR ef($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRef Page($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcac he="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <s pan jsdisplay="isArray($this)" jstcache="50" style="display: none; "> array of < span jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53 "></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeNam e($this)" jstcache="51">string</span> </span> </span> ) </div> </em> </dt> <dd c lass="todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <d d jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache ="39" style="display: none; "> Description of this parameter from the json schem a. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" js tcache="40" style="display: none; "> <dl jstcache="0"> <div jsselect="getPropert yListFromObject($this)" jstcache="10"> <div transclude="valueTemplate" jstcache= "17"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36" style="display: none; "> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> <!-- CALLBAC K --> <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstcache="37"> <h4 js tcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcac he="0">callback</em> parameter, it should specify a function that looks like thi s: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">functio n(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Ty pe param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl js tcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemp late" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="11" jsinstance="1" > <a jsvalues=".name:'method-' + name" jstcache="18" name="method-notifyPass"></ a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">notifyPass</h4> <di v class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName( returns)" jstcache="25" style="display: none; ">void</span> <!-- Note: intention ally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this) " jstcache="26">chrome.test.notifyPass</span>(<span jsselect="parameters" jsvalu es="class:optional ? 'optional' : ''" jstcache="27" jsinstance="0" class="optio nal"><span jsdisplay="$index" jstcache="33" style="display: none; ">, </span><sp an jscontent="getTypeName($this)" jstcache="34">string</span> <var jstcache="0"> <span jscontent="name" jstcache="16">message</span></var></span>)</div> <div cla ss="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache ="28" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsval ues=".innerHTML:description" jstcache="29">Notify the browser process that test code running in the extension passed. This is only used for internal unit testin g.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <d iv jsselect="parameters" jstcache="35" jsinstance="0"> <!-- VALUE: This is a su btemplate that is used elsewhere via jsTemplate transclude --> <div id="valueT emplate" jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent=" $this.name" jstcache="45">message</var> <em jstcache="0"> <!-- TYPE --> <div sty le="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisp lay="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues=".hre f: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($ this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)" jstc ache="48"> <span jsdisplay="isArray($this)" jstcache="50" style="display: none; "> array of <span jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isArray($this)" jsconten t="getTypeName($this)" jstcache="51">string</span> </span> </span> ) </div> </em > </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38"> Undocumen ted. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descript ion" jstcache="39" style="display: none; "> Description of this parameter from t he json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObje ct($this)" jstcache="40" style="display: none; "> <dl jstcache="0"> <div jsselec t="getPropertyListFromObject($this)" jstcache="10"> <div transclude="valueTempla te" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30" style="display: none; "> Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36" style="disp lay: none; "> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="31" style="display: none; "> <div jsselect="getCallbackParameters(parameters)" jstca che="37"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specif y the <em jstcache="0">callback</em> parameter, it should specify a function tha t looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstc ache="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 trans clude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> </div> <! -- /description --> </div><div class="apiItem" jsselect="functions" jstcache="11 " jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="18" name="meth od-log"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">log</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeNa me(returns)" jstcache="25" style="display: none; ">void</span> <!-- Note: intent ionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($th is)" jstcache="26">chrome.test.log</span>(<span jsselect="parameters" jsvalues=" class:optional ? 'optional' : ''" jstcache="27" jsinstance="0" class="null"><sp an jsdisplay="$index" jstcache="33" style="display: none; ">, </span><span jscon tent="getTypeName($this)" jstcache="34">string</span> <var jstcache="0"><span js content="name" jstcache="16">message</span></var></span>)</div> <div class="desc ription" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="28" st yle="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".in nerHTML:description" jstcache="29">Logs a message during internal unit testing.< /p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35" jsinstance="0"> <!-- VALUE: This is a subte mplate that is used elsewhere via jsTemplate transclude* --> <div id="valueTemp late" jstcache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$th is.name" jstcache="45">message</var> <em jstcache="0"> <!-- TYPE --> <div style= "display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jst cache="46" style="display: none; ">optional</span> <span id="typeTemplate" jstca che="0"> <span jsdisplay="getTypeRef($this)" jstcache="47" style="display: none; "> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" js content="getTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!ge tTypeRef($this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50" s tyle="display: none; "> array of <span jsselect="items" jstcache="52"><span tran sclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!isA rray($this)" jscontent="getTypeName($this)" jstcache="51">string</span> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jst cache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".inn erHTML:$this.description" jstcache="39" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisp lay="shouldExpandObject($this)" jstcache="40" style="display: none; "> <dl jstca che="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div tr ansclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /V ALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30" sty le="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstc ache="36" style="display: none; "> <div transclude="valueTemplate" jstcache="17" > </div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters) " jstcache="31" style="display: none; "> <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" style="display: none; "> <a name="events" jstcache= "0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="12"> <a jsvalues=".name:'ev ent-' + name" jstcache="19"></a> <h4 jscontent="name" jstcache="16">event name</ h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 column s --> <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chro me.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><span clas s="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignat ureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span clas s="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache ="0"> <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p> < p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29"> A des cription from the json schema def of the event goes here. </p> <!-- PARAMETERS - -> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </d l> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup -- > <!-- TYPES --> <div jsdisplay="types && types.length > 0" class="ap iGroup" jstcache="8" style="display: none; "> <a name="types" jstcache="0"></a> <h3 id="types" jstcache="0">Types</h3> <!-- iterates over all types --> <div jss elect="types" class="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" js tcache="20"></a> <h4 jscontent="id" jstcache="21">type name</h4> <div transclude ="valueTemplate" jstcache="17"> </div> </div> <!-- /apiItem --> </div> <!-- /api Group --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /page Content --> <div id="pageFooter" --="" jstcache="0"> <p jstcache="0"> Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache=" 0">noted</a>, the content of this page is licensed under the <a rel="license" hr ef="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons A ttribution 3.0 License</a>, and code samples are licensed under the <a rel="lice nse" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD Lice nse</a>. </p> <p jstcache="0"> ©2009 Google </p> </div> <!-- /pageFooter --> </d iv> <!-- /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.test</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.test</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"> <a href="api_index.html" jstcache="0">chrome.* A PIs</a> </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">

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

	97 <ol jstcache="0">

	98 <li jsselect="getStaticTOC()" jstcache="9" jsinstance="*0" style="di splay: none; ">

	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: chrome.test</a>

	109 <ol jstcache="0">

	110 <li jsdisplay="$this.properties" jstcache="5" style="display: none; ">

	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" js instance="0">

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

	123 </li><li jsselect="functions.sort(sortByName)" jstcache="1 1" jsinstance="1">

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

	125 </li><li jsselect="functions.sort(sortByName)" jstcache="1 1" jsinstance="*2">

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

	127 </li>

	128 </ol>

	129 </li>

	130 <li jsdisplay="events && events.length > 0" jstcach e="7" style="display: none; ">

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

	132 <ol jstcache="0">

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

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

	135 </li>

	136 </ol>

	137 </li>

	138 <li jsdisplay="types && types.length > 0" jstcache= "8" style="display: none; ">

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

	140 <ol jstcache="0">

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

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

	143 </li>

	144 </ol>

	145 </li>

	146 </ol>

	147 </li>

	148 </div>

	149 </ol>

	150 </div>

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

	152

	153 <!-- STATIC CONTENT PLACEHOLDER -->

	154 <div id="static" jstcache="0"></div>

	155

	156 <!-- API PAGE -->

	157 <div class="apiPage" jsselect="apiDefinition" jstcache="3">

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

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

	160

	161 <!-- PROPERTIES -->

	162 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5" style= "display: none; ">

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

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

	165

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

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

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

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

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

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

	172 </div>

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

	174 </div>

	175 </div>

	176

	177 </div> <!-- /apiGroup -->

	178

	179 <!-- METHODS -->

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

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

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

	183

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

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

	186 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-lo g"></a> <!-- method-anchor -->

	187 <h4 jscontent="name" jstcache="16">log</h4>

	188

	189 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25" style="display: none; ">void</span>

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

	191 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.test.log</span>(<span jsselect="parameters" jsvalues="class:option al ? 'optional' : ''" jstcache="27" jsinstance="*0" class="null"><span jsdisplay ="$index" jstcache="33" style="display: none; ">, </span><span jscontent="getTyp eName($this)" jstcache="34">string</span>

	192 <var jstcache="0"><span jscontent="name" jstcache="16">mes sage</span></var></span>)</div>

	193

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

	195 <p class="todo" jsdisplay="!description" jstcache="28" style="di splay: none; ">Undocumented.</p>

	196 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">Logs a message during internal unit testing.</p>

	197

	198 <!-- PARAMETERS -->

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

	200 <dl jstcache="0">

	201 <div jsselect="parameters" jstcache="35" jsinstance="*0">

	202

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

	204 via jsTemplate transclude -->

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

	206 <dt jstcache="0">

	207 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">message</var>

	208 <em jstcache="0">

	209

	210 <!-- TYPE -->

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

	212 (

	213 <span class="optional" jsdisplay="optional" jstc ache="47" style="display: none; ">optional</span>

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

	215 <span jsdisplay="getTypeRef($this)" jstcache=" 48" style="display: none; ">

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

	217 </span>

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

	219 <span jsdisplay="isArray($this)" jstcache="5 1" style="display: none; ">

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

	221 </span>

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

	223 </span>

	224 </span>

	225 )

	226 </div>

	227

	228 </em>

	229 </dt>

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

	231 Undocumented.

	232 </dd>

	233 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40" style="display: none; ">

	234 Description of this parameter from the json schema.

	235 </dd>

	236

	237 <!-- OBJECT PROPERTIES -->

	238 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st yle="display: none; ">

	239 <dl jstcache="0">

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

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

	242 </div>

	243 </div>

	244 </dl>

	245 </dd>

	246 </div> <!-- /VALUE -->

	247

	248 </div>

	249 </dl>

	250

	251 <!-- RETURNS -->

	252 <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Re turns</h4>

	253 <dl jstcache="0">

	254 <div jsselect="returns" jstcache="36" style="display: none; ">

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

	256 </div>

	257 </div>

	258 </dl>

	259

	260 <!-- CALLBACK -->

	261 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di splay: none; ">

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

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

	264 <p jstcache="0">

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

	266 it should specify a function that looks like this:

	267 </p>

	268

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

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

	271 <dl jstcache="0">

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

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

	274 </div>

	275 </div>

	276 </dl>

	277 </div>

	278 </div>

	279

	280 </div> <!-- /description -->

	281

	282 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst cache="11" jsinstance="1">

	283 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-no tifyFail"></a> <!-- method-anchor -->

	284 <h4 jscontent="name" jstcache="16">notifyFail</h4>

	285

	286 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25" style="display: none; ">void</span>

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

	288 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.test.notifyFail</span>(<span jsselect="parameters" jsvalues="class :optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="null"><span js display="$index" jstcache="33" style="display: none; ">, </span><span jscontent= "getTypeName($this)" jstcache="34">string</span>

	289 <var jstcache="0"><span jscontent="name" jstcache="16">mes sage</span></var></span>)</div>

	290

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

	292 <p class="todo" jsdisplay="!description" jstcache="28" style="di splay: none; ">Undocumented.</p>

	293 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">Notify the browser process that test code running in the extension fa iled. This is only used for internal unit testing.</p>

	294

	295 <!-- PARAMETERS -->

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

	297 <dl jstcache="0">

	298 <div jsselect="parameters" jstcache="35" jsinstance="*0">

	299

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

	301 via jsTemplate transclude -->

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

	303 <dt jstcache="0">

	304 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">message</var>

	305 <em jstcache="0">

	306

	307 <!-- TYPE -->

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

	309 (

	310 <span class="optional" jsdisplay="optional" jstc ache="47" style="display: none; ">optional</span>

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

	312 <span jsdisplay="getTypeRef($this)" jstcache=" 48" style="display: none; ">

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

	314 </span>

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

	316 <span jsdisplay="isArray($this)" jstcache="5 1" style="display: none; ">

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

	318 </span>

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

	320 </span>

	321 </span>

	322 )

	323 </div>

	324

	325 </em>

	326 </dt>

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

	328 Undocumented.

	329 </dd>

	330 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40" style="display: none; ">

	331 Description of this parameter from the json schema.

	332 </dd>

	333

	334 <!-- OBJECT PROPERTIES -->

	335 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st yle="display: none; ">

	336 <dl jstcache="0">

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

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

	339 </div>

	340 </div>

	341 </dl>

	342 </dd>

	343 </div> <!-- /VALUE -->

	344

	345 </div>

	346 </dl>

	347

	348 <!-- RETURNS -->

	349 <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Re turns</h4>

	350 <dl jstcache="0">

	351 <div jsselect="returns" jstcache="36" style="display: none; ">

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

	353 </div>

	354 </div>

	355 </dl>

	356

	357 <!-- CALLBACK -->

	358 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di splay: none; ">

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

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

	361 <p jstcache="0">

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

	363 it should specify a function that looks like this:

	364 </p>

	365

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

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

	368 <dl jstcache="0">

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

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

	371 </div>

	372 </div>

	373 </dl>

	374 </div>

	375 </div>

	376

	377 </div> <!-- /description -->

	378

	379 </div><div class="apiItem" jsselect="functions.sort(sortByName)" jst cache="11" jsinstance="*2">

	380 <a jsvalues=".name:'method-' + name" jstcache="18" name="method-no tifyPass"></a> <!-- method-anchor -->

	381 <h4 jscontent="name" jstcache="16">notifyPass</h4>

	382

	383 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25" style="display: none; ">void</span>

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

	385 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.test.notifyPass</span>(<span jsselect="parameters" jsvalues="class :optional ? 'optional' : ''" jstcache="27" jsinstance="*0" class="optional"><spa n jsdisplay="$index" jstcache="33" style="display: none; ">, </span><span jscont ent="getTypeName($this)" jstcache="34">string</span>

	386 <var jstcache="0"><span jscontent="name" jstcache="16">mes sage</span></var></span>)</div>

	387

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

	389 <p class="todo" jsdisplay="!description" jstcache="28" style="di splay: none; ">Undocumented.</p>

	390 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">Notify the browser process that test code running in the extension pa ssed. This is only used for internal unit testing.</p>

	391

	392 <!-- PARAMETERS -->

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

	394 <dl jstcache="0">

	395 <div jsselect="parameters" jstcache="35" jsinstance="*0">

	396

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

	398 via jsTemplate transclude -->

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

	400 <dt jstcache="0">

	401 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">message</var>

	402 <em jstcache="0">

	403

	404 <!-- TYPE -->

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

	406 (

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

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

	409 <span jsdisplay="getTypeRef($this)" jstcache=" 48" style="display: none; ">

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

	411 </span>

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

	413 <span jsdisplay="isArray($this)" jstcache="5 1" style="display: none; ">

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

	415 </span>

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

	417 </span>

	418 </span>

	419 )

	420 </div>

	421

	422 </em>

	423 </dt>

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

	425 Undocumented.

	426 </dd>

	427 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40" style="display: none; ">

	428 Description of this parameter from the json schema.

	429 </dd>

	430

	431 <!-- OBJECT PROPERTIES -->

	432 <dd jsdisplay="shouldExpandObject($this)" jstcache="41" st yle="display: none; ">

	433 <dl jstcache="0">

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

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

	436 </div>

	437 </div>

	438 </dl>

	439 </dd>

	440 </div> <!-- /VALUE -->

	441

	442 </div>

	443 </dl>

	444

	445 <!-- RETURNS -->

	446 <h4 jsdisplay="returns" jstcache="30" style="display: none; ">Re turns</h4>

	447 <dl jstcache="0">

	448 <div jsselect="returns" jstcache="36" style="display: none; ">

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

	450 </div>

	451 </div>

	452 </dl>

	453

	454 <!-- CALLBACK -->

	455 <div jsdisplay="hasCallback(parameters)" jstcache="31" style="di splay: none; ">

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

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

	458 <p jstcache="0">

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

	460 it should specify a function that looks like this:

	461 </p>

	462

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

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

	465 <dl jstcache="0">

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

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

	468 </div>

	469 </div>

	470 </dl>

	471 </div>

	472 </div>

	473

	474 </div> <!-- /description -->

	475

	476 </div> <!-- /apiItem -->

	477

	478 </div> <!-- /apiGroup -->

	479

	480 <!-- EVENTS -->

	481 <div jsdisplay="events && events.length > 0" class="apiGrou p" jstcache="7" style="display: none; ">

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

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

	484

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

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

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

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

	489

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

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

	492 <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>);

	493 </div>

	494

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

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

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

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

	499 </p>

	500

	501 <!-- PARAMETERS -->

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

	503 <dl jstcache="0">

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

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

	506 </div>

	507 </div>

	508 </dl>

	509

	510 </div> <!-- /decription -->

	511

	512 </div> <!-- /apiItem -->

	513

	514 </div> <!-- /apiGroup -->

	515

	516 <!-- TYPES -->

	517 <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="8" style="display: none; ">

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

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

	520

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

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

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

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

	525

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

	527 </div>

	528

	529 </div> <!-- /apiItem -->

	530

	531 </div> <!-- /apiGroup -->

	532

	533 </div> <!-- /apiPage -->

	534 </div> <!-- /mainColumn -->

	535 </div> <!-- /pageContent -->

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

	537 <p jstcache="0">

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

	539 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

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

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

	542 </p>

	543 <p jstcache="0">

	544 ©2009 Google

	545 </p>

	546 </div> <!-- /pageFooter -->

	547 </div> <!-- /container -->

	548 </body></html>

	549 #EOF

OLD	NEW