chrome/common/extensions/docs/api_other.html - Issue 180016: Extension API Renaming/Consistency changes

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

Issue 180016: Extension API Renaming/Consistency changes (Closed)

Patch Set: render 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>	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">Other APIs</title> <link href ="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script t ype="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.j s" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_gener ator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap .js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="contai ner" 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"> <inpu t 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" j stcache="0"> </div> </form> <script type="text/javascript" src="http://www.googl e.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0"> google.load("elements", "1", {packages: "transliteration"});</script> <script ty pe="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-bo x&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="getPageTitl e()" jstcache="1">Other APIs</h1> </div> </div> <!-- /pageHeader --> <div id="pa geContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul js tcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <l i 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 jst cache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Gu ide</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcac he="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcache= "0">Page Actions</a></li> <li jstcache="0"><a href="background_pages.html" jstca che="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.html " jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li jstcach e="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="w indows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.h tml" 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">Autoupdat e</li> </ul> </li> <li jstcache="0"><a href="tutorials.html" jstcache="0"><div j stcache="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">Ref erence <ul jstcache="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcach e="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li> <li jstcache= "0">Match Patterns</li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li js tcache="0"> <a href="api_index.html" jstcache="0">chrome.* APIs</a> </li> <li js tcache="0" class="leftNavSelected">Other APIs </li> </ul> </li> <li jstcache="0" ><a href="http://dev.chromium.org/developers/design-documents/extensions/samples " jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jsse lect="getStaticTOC()" jstcache="9"> <a jscontent="name" jsvalues=".href:'#' + hr ef" jstcache="14">h2Name</a> <ol jstcache="0"> <li jsselect="$this.children" jst cache="22"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name </a> </li> </ol> </li> <div jsselect="apiDefinition" jstcache="3"> <li jstcache= "0"> <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jst cache="4">API reference</a> <ol jstcache="0"> <li jsdisplay="$this.properties" j stcache="5"> <a href="#properties" jstcache="0">Properties</a> <ol jstcache="0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jscontent="na me" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="41">p ropertyName</a> </li> </ol> </li> <li jsdisplay="functions && functions. length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol jst cache="0"> <li jsselect="functions" jstcache="11"> <a jscontent="name" jsvalues= ".href:'#method-' + name" href="#method-anchor" jstcache="42">methodName</a> </l i> </ol> </li> <li jsdisplay="events && events.length > 0" jstcache=" 7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="ev ents" jstcache="12"> <a jscontent="name" jsvalues=".href:'#event-' + name" href= "#event-anchor" jstcache="43">eventName</a> </li> </ol> </li> <li jsdisplay="typ es && types.length > 0" jstcache="8"> <a href="#types" jstcache="0">T ypes</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li> </o l> </li> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Other APIs</div> <p jstcache="0"> In addition to t he <a href="api_index.html" jstcache="0">chrome.* APIs</a>, extensions can use a ll the APIs that the browser provides to web pages and apps. If the browser does n't support an API you want to use, you can bundle additional API libraries into your extension. </p> <p jstcache="0">Here's a sampling of the APIs that extensi ons can use:</p> <dl jstcache="0"> <dt jstcache="0"><strong jstcache="0"> Standa rd JavaScript APIs </strong></dt> <dd jstcache="0"> <span class="comment" jstcac he="0">[PENDING: define, explain; link to complete list]</span> <!-- Use onclick in your toolbar div to add click behavior. E.g. window.open(someUrl). --></dd> <dt jstcache="0"><strong jstcache="0"> XMLHttpRequest </strong></dt> <dd jstcach e="0"> Lets the extension request data from one or more servers. The manifest sp ecifies which domains the extension can send requests to. <span class="comment" jstcache="0">[PENDING: link to doc]</span></dd> <dt jstcache="0"><strong jstcach e="0"> WebKit APIs </strong></dt> <dd jstcache="0"> Because Google Chrome is bui lt upon WebKit, your extensions can use WebKit APIs. Especially useful are the e xperimental CSS features such as filters, animations, and transformations. Here' s an example of using WebKit styles to make the UI spin: <pre jstcache="0"><s tyle> div:hover { -webkit-transform: rotate(360deg); -webkit-transition: all sl ease-out; } </style> </pre> <p class="comment" jstcache="0">[PENDING: l ink to complete list of webkit apis]</p> </dd> <dt jstcache="0"><strong jstcache ="0"> V8 APIs</strong>, such as<strong jstcache="0"> JSON </strong></dt> <dd jst cache="0"> JSON is in V8, so you don't need to include a JSON library to use JSO N functions. <span class="comment" jstcache="0">[PENDING: what other APIs are in v8? link to complete list]</span></dd> <dt jstcache="0"> <strong jstcache="0">H TML5</strong> <strong jstcache="0">APIs</strong>, such as <strong jstcache="0">l ocalStorage</strong> and <strong jstcache="0">Web Workers</strong></dt> <dd jstc ache="0"> HTML5 is still being defined and implemented, but one crucial feature it will provide is local storage... <!-- localStorage.setItem("foo", & quot;bar"); ... localStorage.getItem("foo"); --> <span class="com ment" jstcache="0">[PENDING: mention Web Workers, too. Other important API? link to complete list]</span></dd> <dt jstcache="0"><strong jstcache="0">APIs in bun dled libraries</strong></dt> <dd jstcache="0"> If you want to use a library that the browser doesn't provide (for example, jQuery), you can bundle that library' s JavaScript files with your extension. Bundled libraries work in extensions jus t as they would in any other web pages. </dd> </dl> </div> <!-- API PAGE --> <di v class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <a name="apiReference" jstcache="0"></a> <h2 jscontent="'API reference: ' + get ModuleName()" jstcache="4">API reference: chrome.apiname </h2> <!-- PROPERTIES - -> <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> <a name="pro perties" jstcache="0"></a> <h3 id="properties" jstcache="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jsvalues=".name:' property-' + name" jstcache="15"></a> <h4 jscontent="name" jstcache="16">getLast Error</h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extens ion</span><span jscontent="$this.name" jstcache="24">lastError</span> </div> <di v transclude="valueTemplate" jstcache="17"> </div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="6"> <a name="methods" jstcache="0"></ a> <h3 jstcache="0">Methods</h3> <!-- iterates over all functions --> <div class ="apiItem" jsselect="functions" jstcache="11"> <a jsvalues=".name:'method-' + na me" jstcache="18"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16" >method name</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" js content="getTypeName(returns)" jstcache="25">void</span> <!-- Note: intentionall y longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" j stcache="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalue s="class:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstc ache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> <v ar jstcache="0"><span jscontent="name" jstcache="16"></span></var></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 description from the json schema def of the funct ion goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jst cache="0"> <div jsselect="parameters" jstcache="35"> <!-- 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">paramName</var> <em jstcache="0"> <!-- TYPE --> <div styl e="display:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" j stcache="46">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdispl ay="getTypeRef($this)" jstcache="47"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Typ e</a> </span> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdispla y="isArray($this)" jstcache="50"> array of <span jsselect="items" jstcache="52"> <span transclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdis play="!isArray($this)" jscontent="getTypeName($this)" jstcache="51">paramType</s pan> </span> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="39"> Description of this parame ter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="should ExpandObject($this)" jstcache="40"> <dl jstcache="0"> <div jsselect="getProperty ListFromObject($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 js select="returns" jstcache="36"> <div transclude="valueTemplate" jstcache="17"> < /div> </div> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters) " jstcache="31"> <div jsselect="getCallbackParameters(parameters)" jstcache="37" > <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <e m jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0" >function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type pa ram1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre > <dl jstcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="v alueTemplate" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /desc ription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> < div jsdisplay="events && events.length > 0" class="apiGroup" jstcache ="7"> <a name="events" jstcache="0"></a> <h3 id="events" jstcache="0">Events</h3 > <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstca che="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="getModuleName() + '.'" cl ass="subdued" jstcache="23">chrome.bookmarks</span><span jscontent="name" jstcac he="16">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(fun ction(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1 , Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> < div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" j stcache="28">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:d escription" jstcache="29"> A description from the json schema def of the event g oes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache ="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiI tem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types &&amp ; types.length > 0" class="apiGroup" jstcache="8"> <a name="types" jstcache=" 0"></a> <h3 id="types" jstcache="0">Types</h3> <!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" jstcache="20"></a> <h4 jscontent="id" jstcache="21">type name</h4> <div tr ansclude="valueTemplate" jstcache="17"> </div> </div> <!-- /apiItem --> </div> < !-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <! -- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009. For terms of use, see the Chromium <a href="http://src.chromium.org/viewvc/chrome/t runk/src/LICENSE" jstcache="0">license</a>. </div> <!-- /pageFooter --> </div> < !-- /container --> </body></html>

2 <!-- This page is a placeholder for generated extensions api doc. Note:

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

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

5 templating mechanism.

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

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

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

9 authored overview content.

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

11 page may easily be indexed by search engines.

12

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

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

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

16 -->

17 <!-- <html> must retain id="template -->

18 <html xmlns="http://www.w3.org/1999/xhtml">

19 <!-- <head> data is significant and loads the needed libraries and styles -->

20 <head>

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

22 <title jscontent="pageTitle">pageTitle</title>

23 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

24 <script type="text/javascript"

25 src="../../../third_party/jstemplate/jstemplate_compiled.js">

26 </script>

27 <script type="text/javascript" src="js/api_page_generator.js"></script>

28 <script type="text/javascript" src="js/bootstrap.js"></script>

29 </head>

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

31 and rewritten. -->

32 <body>

33 </body>

34 </html>

OLD	NEW

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