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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.declarative.html

Issue 9192029: Bindings layer for declarative events API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Fix some stuff that apitests in followup CL discovered Created 8 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« chrome/common/extensions/api/webRequest.json ('K') | « chrome/common/extensions/api/webRequest.json ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/renderer/resources/extensions/event.js » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <div id="devModeWarning" class="displayModeWarning"> 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files. 2 1) The <head> information in this page is significant, should be uniform
3 </div> 3 across api docs and should be edited only with knowledge of the
4 <div id="branchWarning" class="displayModeWarning"> 4 templating mechanism.
5 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 It may not work with the stable release of Chrome.</span> 6 browser, it will be re-generated from the template, json schema and
7 <select id='branchChooser'> 7 authored overview content.
8 <option>Choose a different version... 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 <option value="">Stable 9 page may easily be indexed by search engines.
10 <option value="beta">Beta 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <option value="dev">Dev 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <option value="trunk">Trunk 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 </select> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 </div> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 <div id="unofficialWarning" class="displayModeWarning"> 15 </script>
16 <span>WARNING: This is unofficial documentation. It may not work with the 16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 current release of Chrome.</span> 17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <button id="goToOfficialDocs">Go to the official docs</button> 18 <script type="text/javascript" src="js/sidebar.js"></script>
19 </div> 19 <title>Experimental.declarative - Google Chrome Extensions - Google Code</titl e></head>
20 <div id="gc-container" class="labs"> 20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning">
22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with -- allow-file-access-from-files.
23 </div>
21 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
22 <!-- In particular, sub-templates that recurse, must be used by allowing 25 <!-- In particular, sub-templates that recurse, must be used by allowing
23 jstemplate to make a copy of the template in this section which 26 jstemplate to make a copy of the template in this section which
24 are not operated on by way of the jsskip="true" --> 27 are not operated on by way of the jsskip="true" -->
25 <div jsskip="true" style="display:none"> 28 <div style="display:none">
26 29
27 <!-- VALUE --> 30 <!-- VALUE -->
28 <div id="valueTemplate"> 31 <div id="valueTemplate">
29 <dt> 32 <dt>
30 <var jsdisplay="$this.name" jscontent="$this.name">paramName</var> 33 <var>paramName</var>
31 <em> 34 <em>
32 35
33 <!-- TYPE --> 36 <!-- TYPE -->
34 <div style="display:inline"> 37 <div style="display:inline">
35 ( 38 (
36 <span class="optional" jsdisplay="optional">optional</span> 39 <span class="optional">optional</span>
37 <span class="enum" jsdisplay="$this.enum">enumerated</span> 40 <span class="enum">enumerated</span>
38 <span id="typeTemplate"> 41 <span id="typeTemplate">
39 <span jsdisplay="getTypeRef($this)"> 42 <span>
40 <a jsvalues=".href: getTypeRefPage($this) + '#type-' + g etTypeRef($this)" 43 <a> Type</a>
41 jscontent="getTypeRef($this)"> Type</a>
42 </span> 44 </span>
43 <span jsdisplay="!getTypeRef($this)"> 45 <span>
44 <span jsdisplay="isArray($this)"> 46 <span>
45 array of <span jsselect="items"><span transclude="type Template"></span></span> 47 array of <span><span></span></span>
46 </span> 48 </span>
47 <span jsdisplay="!isArray($this)" jscontent="getTypeName ($this)">paramType</span> 49 <span>paramType</span>
48 <span jsdisplay="!isArray($this) && $this.enum" jsconten t="getEnumValues($this.enum, type);"></span> 50 <span></span>
49 </span> 51 </span>
50 </span> 52 </span>
51 ) 53 )
52 </div> 54 </div>
53 55
54 </em> 56 </em>
55 </dt> 57 </dt>
56 <dd class="todo" jsdisplay="!$this.description"> 58 <dd class="todo">
57 Undocumented. 59 Undocumented.
58 </dd> 60 </dd>
59 <dd jsdisplay="$this.description" 61 <dd>
60 jsvalues=".innerHTML:substituteTypeRefs($this.description)">
61 Description of this parameter from the json schema. 62 Description of this parameter from the json schema.
62 </dd> 63 </dd>
63 <dd jsdisplay="$this.min_version"> 64 <dd>
64 This parameter was added in version 65 This parameter was added in version
65 <b><span jscontent="$this.min_version"></span></b>. 66 <b><span></span></b>.
66 You must omit this parameter in earlier versions, 67 You must omit this parameter in earlier versions,
67 and you may omit it in any version. If you require this 68 and you may omit it in any version. If you require this
68 parameter, the manifest key 69 parameter, the manifest key
69 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
70 can ensure that your extension won't be run in an earlier browser ve rsion. 71 can ensure that your extension won't be run in an earlier browser ve rsion.
71 </dd> 72 </dd>
72 73
73 <!-- OBJECT PROPERTIES --> 74 <!-- OBJECT PROPERTIES -->
74 <dd jsdisplay="shouldExpandObject($this)"> 75 <dd>
75 <dl> 76 <dl>
76 <div jsselect="getPropertyListFromObject($this)"> 77 <div>
77 <div transclude="valueTemplate"> 78 <div>
78 </div> 79 </div>
79 </div> 80 </div>
80 </dl> 81 </dl>
81 </dd> 82 </dd>
82 83
83 <!-- OBJECT METHODS --> 84 <!-- OBJECT METHODS -->
84 <dd jsdisplay="$this.type === 'object' && 85 <dd>
85 $this.functions && $this.functions.length > 0" 86 <div></div>
86 jsvalues="$scope:id">
87 <div transclude="methodsTemplate"></div>
88 </dd> 87 </dd>
89 88
90 <!-- OBJECT EVENT FIELDS --> 89 <!-- OBJECT EVENT FIELDS -->
91 <dd jsdisplay="$this.type === 'object' && 90 <dd>
92 $this.events && $this.events.length > 0" 91 <div></div>
93 jsvalues="$scope:id">
94 <div transclude="eventsTemplate"></div>
95 </dd> 92 </dd>
96 93
97 <!-- FUNCTION PARAMETERS --> 94 <!-- FUNCTION PARAMETERS -->
98 <dd jsdisplay="isFunction($this) && $this.parameters && 95 <dd>
99 $this.name != 'callback'"> 96 <div></div>
100 <div transclude="functionParametersTemplate"></div>
101 </dd> 97 </dd>
102 98
103 </div> <!-- /VALUE --> 99 </div> <!-- /VALUE -->
104 100
105 <div id="functionParametersTemplate"> 101 <div id="functionParametersTemplate">
106 <h5>Parameters</h5> 102 <h5>Parameters</h5>
107 <dl> 103 <dl>
108 <div jsselect="$this.parameters"> 104 <div>
109 <div transclude="valueTemplate"> 105 <div>
110 </div> 106 </div>
111 </div> 107 </div>
112 </dl> 108 </dl>
113 </div> 109 </div>
114 110
115 <!-- Individual subsections from the table of contents --> 111 <!-- Individual subsections from the table of contents -->
116 <ol> 112 <ol>
117 <li id="propertiesTocTemplate" jsdisplay="$this.properties"> 113 <li id="propertiesTocTemplate">
118 <a href="#properties">Properties</a> 114 <a href="#properties">Properties</a>
119 <ol> 115 <ol>
120 <li jsselect="getPropertyListFromObject($this)"> 116 <li>
121 <a jscontent="name" 117 <a href="#property-anchor">propertyName</a>
122 jsvalues=".href:'#property-' + name"
123 href="#property-anchor">propertyName</a>
124 </li> 118 </li>
125 </ol> 119 </ol>
126 </li> 120 </li>
127 <li id="methodsTocTemplate" jsdisplay="functions && functions.length > 0"> 121 <li id="methodsTocTemplate">
128 <a jsvalues=".href:'#' + getAnchorName('global', 'methods', $type)"> Methods</a> 122 <a>Methods</a>
129 <ol> 123 <ol>
130 <li jsselect="functions.sort(sortByName)" 124 <li>
131 jsdisplay="!($this.nodoc)"> 125 <a href="#method-anchor">methodName</a>
132 <a jscontent="name"
133 jsvalues=".href:'#' + getAnchorName('method', name, $type)"
134 href="#method-anchor">methodName</a>
135 </li> 126 </li>
136 </ol> 127 </ol>
137 </li> 128 </li>
138 <li id="eventsTocTemplate" jsdisplay="events && events.length > 0"> 129 <li id="eventsTocTemplate">
139 <a jsvalues=".href:'#' + getAnchorName('global', 'events', $type)">E vents</a> 130 <a>Events</a>
140 <ol> 131 <ol>
141 <li jsselect="events.sort(sortByName)" 132 <li>
142 jsdisplay="!($this.nodoc)"> 133 <a href="#event-anchor">eventName</a>
143 <a jscontent="name"
144 jsvalues=".href:'#' + getAnchorName('event', name, $type)"
145 href="#event-anchor">eventName</a>
146 </li> 134 </li>
147 </ol> 135 </ol>
148 </li> 136 </li>
149 <li id="typesTocTemplate" jsdisplay="types && types.length > 0"> 137 <li id="typesTocTemplate">
150 <a href="#types">Types</a> 138 <a href="#types">Types</a>
151 <ol> 139 <ol>
152 <li jsselect="types.sort(sortByName)"> 140 <li>
153 <a jscontent="id" 141 <a href="#id-anchor">id</a>
154 jsvalues=".href:'#type-' + id" 142 <ol>
155 href="#id-anchor">id</a> 143 <div></div>
156 <ol jsvalues="$type:id"> 144 <div></div>
157 <div transclude="methodsTocTemplate"></div>
158 <div transclude="eventsTocTemplate"></div>
159 </ol> 145 </ol>
160 </li> 146 </li>
161 </ol> 147 </ol>
162 </li> 148 </li>
163 </ol> 149 </ol>
164 </div> <!-- /SUBTEMPLATES --> 150 </div> <!-- /SUBTEMPLATES -->
165 151
166 <a id="top"></a> 152 <a id="top"></a>
167 <div id="skipto"> 153 <div id="skipto">
168 <a href="#gc-pagecontent">Skip to page content</a> 154 <a href="#gc-pagecontent">Skip to page content</a>
169 <a href="#gc-toc">Skip to main navigation</a> 155 <a href="#gc-toc">Skip to main navigation</a>
170 </div> 156 </div>
171 <!-- API HEADER --> 157 <!-- API HEADER -->
172 <table id="header" width="100%" cellspacing="0" border="0"> 158 <table id="header" width="100%" cellspacing="0" border="0">
173 <tr> 159 <tbody><tr>
174 <td valign="middle" 160 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
175 ><a href="http://code.google.com/"><img src="images/code_labs_logo.gif " height="43" width="161" alt="Google Code Labs"
176 style="border:0; margin:0;"
177 ></a></td>
178 <td valign="middle" width="100%" style="padding-left:0.6em;"> 161 <td valign="middle" width="100%" style="padding-left:0.6em;">
179 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em"> 162 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
180 <div id="gsc-search-box"> 163 <div id="gsc-search-box">
181 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno" /> 164 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
182 <input type="hidden" name="ie" value="UTF-8" /> 165 <input type="hidden" name="ie" value="UTF-8">
183 <input type="text" name="q" value="" size="55" /> 166 <input type="text" name="q" value="" size="55">
184 <input class="gsc-search-button" type="submit" name="sa" value="Se arch" /> 167 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
185 <br> 168 <br>
186 <span class="greytext">e.g. "page action" or "tabs"</span> 169 <span class="greytext">e.g. "page action" or "tabs"</span>
187 </div> 170 </div>
188 </form> 171 </form>
189 172
190 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript> 173 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
191 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 174 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
192 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&t13n_langs=en"></script> 175 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
193 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&lang=en"></script> 176 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
194 </td> 177 </td>
195 </tr> 178 </tr>
196 </table> 179 </tbody></table>
197 180
198 <div id="codesiteContent" jsvalues=".className: showSideNav() ? '' : 'hideSi deNav'"> 181 <div id="codesiteContent" class="">
199 182
200 <a id="gc-topnav-anchor"></a> 183 <a id="gc-topnav-anchor"></a>
201 <div id="gc-topnav"> 184 <div id="gc-topnav">
202 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1> 185 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
203 <ul id="home" class="gc-topnav-tabs"> 186 <ul id="home" class="gc-topnav-tabs">
204 <li id="home_link"> 187 <li id="home_link">
205 <a href="index.html" title="Google Chrome Extensions home page">Home </a> 188 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
206 </li> 189 </li>
207 <li id="docs_link"> 190 <li id="docs_link">
208 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a> 191 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
209 </li> 192 </li>
210 <li id="faq_link"> 193 <li id="faq_link">
211 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a> 194 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
212 </li> 195 </li>
213 <li id="samples_link"> 196 <li id="samples_link">
214 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a> 197 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
215 </li> 198 </li>
216 <li id="group_link"> 199 <li id="group_link">
217 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a> 200 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
218 </li> 201 </li>
219 <li id="so_link"> 202 <li id="so_link">
220 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> 203 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
221 </li> 204 </li>
222 </ul> 205 </ul>
223 </div> <!-- end gc-topnav --> 206 </div> <!-- end gc-topnav -->
224 207
225 <div class="g-section g-tpl-170"> 208 <div class="g-section g-tpl-170">
226 <!-- SIDENAV --> 209 <!-- SIDENAV -->
227 <div class="g-unit g-first" id="gc-toc" jsdisplay="showSideNav()"> 210 <div class="g-unit g-first" id="gc-toc">
228 <ul> 211 <ul>
229 <li><a href="getstarted.html">Getting Started</a></li> 212 <li><a href="getstarted.html">Getting Started</a></li>
230 <li><a href="overview.html">Overview</a></li> 213 <li><a href="overview.html">Overview</a></li>
231 <li><a href="whats_new.html">What's New?</a></li> 214 <li><a href="whats_new.html">What's New?</a></li>
232 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 215 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
233 <ul> 216 <ul>
234 <li>Browser UI 217 <li>Browser UI
235 <ul> 218 <ul>
236 <li><a href="browserAction.html">Browser Actions</a></li> 219 <li><a href="browserAction.html">Browser Actions</a></li>
237 <li><a href="contextMenus.html">Context Menus</a></li> 220 <li><a href="contextMenus.html">Context Menus</a></li>
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after
305 </ul> 288 </ul>
306 </li> 289 </li>
307 </ul> 290 </ul>
308 </div> 291 </div>
309 <script> 292 <script>
310 initToggles(); 293 initToggles();
311 </script> 294 </script>
312 295
313 <div class="g-unit" id="gc-pagecontent"> 296 <div class="g-unit" id="gc-pagecontent">
314 <div id="pageTitle"> 297 <div id="pageTitle">
315 <h1 class="page_title" jscontent="getPageName()">chrome.apiname</h1> 298 <h1 class="page_title">Experimental.declarative</h1>
316 </div> 299 </div>
317 <!-- TABLE OF CONTENTS --> 300 <!-- TABLE OF CONTENTS -->
318 <div id="toc" jsdisplay="showPageTOC()"> 301 <div id="toc" style="display: none; ">
319 <h2>Contents</h2> 302 <h2>Contents</h2>
320 <ol> 303 <ol>
321 <li jsselect="getStaticTOC()"> 304 <li>
322 <a jscontent="name" 305 <a>h2Name</a>
323 jsvalues=".href:'#' + href">h2Name</a>
324 <ol> 306 <ol>
325 <li jsselect="$this.children"> 307 <li>
326 <a jscontent="name" 308 <a>h3Name</a>
327 jsvalues=".href:'#' + href">h3Name</a>
328 </li> 309 </li>
329 </ol> 310 </ol>
330 </li> 311 </li>
331 <li jsselect="apiDefinition" jsvalues="$type:''"> 312 <li>
332 <a href="#apiReference" jscontent="'API reference: ' + getModule Name()">API reference</a> 313 <a href="#apiReference">API reference</a>
333 <ol> 314 <ol>
334 <div transclude="propertiesTocTemplate"></div> 315 <div></div>
335 <div transclude="methodsTocTemplate"></div> 316 <div></div>
336 <div transclude="eventsTocTemplate"></div> 317 <div></div>
337 <div transclude="typesTocTemplate"></div> 318 <div></div>
338 </ol> 319 </ol>
339 </li> 320 </li>
340 </ol> 321 </ol>
341 </div> 322 </div>
342 <!-- /TABLE OF CONTENTS --> 323 <!-- /TABLE OF CONTENTS -->
343 324
344 <!-- Standard content lead-in for experimental API pages --> 325 <!-- Standard content lead-in for experimental API pages -->
345 <p jsdisplay="isExperimentalAPIPage();" id="classSummary"> 326 <p id="classSummary" style="display: none; ">
346 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 327 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
347 </p> 328 </p>
348 329
349 <!-- STATIC CONTENT PLACEHOLDER --> 330 <!-- STATIC CONTENT PLACEHOLDER -->
350 <div id="static"></div> 331 <div id="static"></div>
351 332
352 <!-- API PAGE --> 333 <!-- API PAGE -->
353 <div class="apiPage" jsselect="apiDefinition" jsvalues="$scope:''"> 334 <div class="apiPage" style="display: none; ">
354 <a name="apiReference"></a> 335 <a name="apiReference"></a>
355 <h2 jscontent="'API reference: ' + getModuleName()">API reference: chrom e.apiname </h2> 336 <h2>API reference: chrome.apiname </h2>
356 337
357 <!-- PROPERTIES --> 338 <!-- PROPERTIES -->
358 <div jsdisplay="$this.properties" class="apiGroup"> 339 <div class="apiGroup">
359 <a name="properties"></a> 340 <a name="properties"></a>
360 <h3 id="properties">Properties</h3> 341 <h3 id="properties">Properties</h3>
361 342
362 <div jsselect="getPropertyListFromObject($this)"> 343 <div>
363 <a jsvalues=".name:'property-' + name"></a> 344 <a></a>
364 <h4 jscontent="name">getLastError</h4> 345 <h4>getLastError</h4>
365 <div class="summary"> 346 <div class="summary">
366 <!-- Note: intentionally longer 80 columns --> 347 <!-- Note: intentionally longer 80 columns -->
367 <span jscontent="getModuleName() + '.'">chrome.extension</span>< span jscontent="$this.name">lastError</span> 348 <span>chrome.extension</span><span>lastError</span>
368 </div> 349 </div>
369 <div transclude="valueTemplate"> 350 <div>
370 </div> 351 </div>
371 </div> 352 </div>
372 353
373 </div> <!-- /apiGroup --> 354 </div> <!-- /apiGroup -->
374 355
375 <!-- METHODS --> 356 <!-- METHODS -->
376 <div id="methodsTemplate" class="apiGroup" 357 <div id="methodsTemplate" class="apiGroup">
377 jsdisplay="$this.functions && $this.functions.length > 0"> 358 <a></a>
378 <a jsvalues=".name:getAnchorName('global', 'methods', $scope)"></a> 359 <h3>Methods</h3>
379 <h3 jscontent="$scope ? 'Methods of ' + $scope : 'Methods'">Methods< /h3>
380 360
381 <!-- iterates over all functions --> 361 <!-- iterates over all functions -->
382 <div class="apiItem" jsselect="functions.sort(sortByName)" 362 <div class="apiItem">
383 jsdisplay="!($this.nodoc)"> 363 <a></a> <!-- method-anchor -->
384 <a jsvalues=".name:getAnchorName('method', name, $scope)"></a> <!- - method-anchor --> 364 <h4>method name</h4>
385 <h4 jscontent="name">method name</h4>
386 365
387 <div class="summary"><span jsdisplay="returns" jscontent="getTypeN ame(returns)">void</span> 366 <div class="summary"><span>void</span>
388 <!-- Note: intentionally longer 80 columns --> 367 <!-- Note: intentionally longer 80 columns -->
389 <span jscontent="getFullyQualifiedFunctionName($scope, $this)" >chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:opt ional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getT ypeName($this)"></span> 368 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
390 <var><span jscontent="$this.name"></span></var></span>)</d iv> 369 <var><span></span></var></span>)</div>
391 370
392 <div class="description"> 371 <div class="description">
393 <p class="todo" jsdisplay="!description">Undocumented.</p> 372 <p class="todo">Undocumented.</p>
394 <p jsdisplay="description" jsvalues=".innerHTML:description"> 373 <p>
395 A description from the json schema def of the function goes he re. 374 A description from the json schema def of the function goes he re.
396 </p> 375 </p>
397 376
398 <!-- PARAMETERS --> 377 <!-- PARAMETERS -->
399 <h4 jsdisplay="$this.parameters && $this.parameters.length > 0"> Parameters</h4> 378 <h4>Parameters</h4>
400 <dl> 379 <dl>
401 <div jsselect="parameters"> 380 <div>
402 <div transclude="valueTemplate"> 381 <div>
403 </div> 382 </div>
404 </div> 383 </div>
405 </dl> 384 </dl>
406 385
407 <!-- RETURNS --> 386 <!-- RETURNS -->
408 <h4 jsdisplay="returns">Returns</h4> 387 <h4>Returns</h4>
409 <dl> 388 <dl>
410 <div jsselect="returns"> 389 <div>
411 <div transclude="valueTemplate"> 390 <div>
412 </div> 391 </div>
413 </div> 392 </div>
414 </dl> 393 </dl>
415 394
416 <!-- CALLBACK --> 395 <!-- CALLBACK -->
417 <div jsdisplay="hasCallback(parameters)"> 396 <div>
418 <div jsselect="getCallbackParameters(parameters)"> 397 <div>
419 <h4>Callback function</h4> 398 <h4>Callback function</h4>
420 <p jsdisplay="!$this.optional"> 399 <p>
421 The callback <em>parameter</em> should specify a function 400 The callback <em>parameter</em> should specify a function
422 that looks like this: 401 that looks like this:
423 </p> 402 </p>
424 <p jsdisplay="$this.optional"> 403 <p>
425 If you specify the <em>callback</em> parameter, it should 404 If you specify the <em>callback</em> parameter, it should
426 specify a function that looks like this: 405 specify a function that looks like this:
427 </p> 406 </p>
428 407
429 <!-- Note: intentionally longer 80 columns --> 408 <!-- Note: intentionally longer 80 columns -->
430 <pre>function(<span jscontent="getSignatureString(parameters)" >Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 409 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
431 <dl> 410 <dl>
432 <div jsselect="parameters"> 411 <div>
433 <div transclude="valueTemplate"> 412 <div>
434 </div> 413 </div>
435 </div> 414 </div>
436 </dl> 415 </dl>
437 </div> 416 </div>
438 </div> 417 </div>
439 418
440 <!-- MIN_VERSION --> 419 <!-- MIN_VERSION -->
441 <p jsdisplay="min_version" > 420 <p>
442 This function was added in version <b><span jscontent="$this.m in_version"></span></b>. 421 This function was added in version <b><span></span></b>.
443 If you require this function, the manifest key 422 If you require this function, the manifest key
444 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 423 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
445 can ensure that your extension won't be run in an earlier brow ser version. 424 can ensure that your extension won't be run in an earlier brow ser version.
446 </p> 425 </p>
447 </div> <!-- /description --> 426 </div> <!-- /description -->
448 427
449 </div> <!-- /apiItem --> 428 </div> <!-- /apiItem -->
450 429
451 </div> <!-- /apiGroup --> 430 </div> <!-- /apiGroup -->
452 431
453 <!-- EVENTS --> 432 <!-- EVENTS -->
454 <div id="eventsTemplate" class="apiGroup" 433 <div id="eventsTemplate" class="apiGroup">
455 jsdisplay="$this.events && $this.events.length > 0"> 434 <a></a>
456 <a jsvalues=".name:getAnchorName('global', 'events', $scope)"></a> 435 <h3>Events</h3>
457 <h3 jscontent="$scope ? 'Events of ' + $scope : 'Events'">Events</h3 >
458 <!-- iterates over all events --> 436 <!-- iterates over all events -->
459 <div class="apiItem" jsselect="$this.events.sort(sortByName)" 437 <div class="apiItem">
460 jsdisplay="!($this.nodoc)"> 438 <a></a>
461 <a jsvalues=".name:getAnchorName('event', name, $scope)"></a> 439 <h4>event name</h4>
462 <h4 jscontent="name">event name</h4>
463 440
464 <div class="summary"> 441 <div class="summary">
465 <!-- Note: intentionally longer 80 columns --> 442 <!-- Note: intentionally longer 80 columns -->
466 <span jscontent="(getObjectName($scope) || getModuleName()) + '. '" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span>< span class="subdued">.addListener</span>(function(<span jscontent="getSignatureS tring($this.parameters)">Type param1, Type param2</span>) <span class="subdued"> {...}</span><span jscontent="getOptionalSignatureSubstring($this.extraParameters )">, Type opt_param1, Type opt_param2</span>); 443 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>);
467 </div> 444 </div>
468 445
469 <div class="description"> 446 <div class="description">
470 <p class="todo" jsdisplay="!description">Undocumented.</p> 447 <p class="todo">Undocumented.</p>
471 <p jsdisplay="description" jsvalues=".innerHTML:description"> 448 <p>
472 A description from the json schema def of the event goes here. 449 A description from the json schema def of the event goes here.
473 </p> 450 </p>
474 451
475 <!-- LISTENER PARAMETERS --> 452 <!-- LISTENER PARAMETERS -->
476 <div jsdisplay="parameters && parameters.length > 0"> 453 <div>
477 <h4>Listener parameters</h4> 454 <h4>Listener parameters</h4>
478 <dl> 455 <dl>
479 <div jsselect="parameters"> 456 <div>
480 <div transclude="valueTemplate"> 457 <div>
481 </div> 458 </div>
482 </div> 459 </div>
483 </dl> 460 </dl>
484 </div> 461 </div>
485 462
486 <!-- EXTRA PARAMETERS --> 463 <!-- EXTRA PARAMETERS -->
487 <div jsdisplay="extraParameters && extraParameters.length > 0"> 464 <div>
488 <h4>Extra parameters to addListener</h4> 465 <h4>Extra parameters to addListener</h4>
489 <dl> 466 <dl>
490 <div jsselect="extraParameters"> 467 <div>
491 <div transclude="valueTemplate"> 468 <div>
492 </div> 469 </div>
493 </div> 470 </div>
494 </dl> 471 </dl>
495 </div> 472 </div>
496 473
497 <!-- LISTENER RETURN VALUE --> 474 <!-- LISTENER RETURN VALUE -->
498 <h4 jsdisplay="returns">Listener returns</h4> 475 <h4>Listener returns</h4>
499 <dl> 476 <dl>
500 <div jsselect="returns"> 477 <div>
501 <div transclude="valueTemplate"> 478 <div>
502 </div> 479 </div>
503 </div> 480 </div>
504 </dl> 481 </dl>
505 482
506 </div> <!-- /description --> 483 </div> <!-- /description -->
507 </div> <!-- /apiItem --> 484 </div> <!-- /apiItem -->
508 485
509 </div> <!-- /apiGroup --> 486 </div> <!-- /apiGroup -->
510 487
511 <!-- TYPES --> 488 <!-- TYPES -->
512 <div jsdisplay="types && types.length > 0" class="apiGroup"> 489 <div class="apiGroup">
513 <a name="types"></a> 490 <a name="types"></a>
514 <h3 id="types">Types</h3> 491 <h3 id="types">Types</h3>
515 492
516 <!-- iterates over all types --> 493 <!-- iterates over all types -->
517 <div jsselect="types.sort(sortByName)" class="apiItem"> 494 <div class="apiItem">
518 <a jsvalues=".name:'type-' + id"></a> 495 <a></a>
519 <h4 jscontent="id">type name</h4> 496 <h4>type name</h4>
520 497
521 <div transclude="valueTemplate"> 498 <div>
522 </div> 499 </div>
523 500
524 </div> <!-- /apiItem --> 501 </div> <!-- /apiItem -->
525 502
526 </div> <!-- /apiGroup --> 503 </div> <!-- /apiGroup -->
527 504
528 </div> <!-- /apiPage --> 505 </div> <!-- /apiPage -->
529 </div> <!-- /gc-pagecontent --> 506 </div> <!-- /gc-pagecontent -->
530 </div> <!-- /g-section --> 507 </div> <!-- /g-section -->
531 </div> <!-- /codesiteContent --> 508 </div> <!-- /codesiteContent -->
532 <div id="gc-footer" --> 509 <div id="gc-footer" --="">
533 <div class="text"> 510 <div class="text">
534 <p> 511 <p>
535 Except as otherwise <a 512 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
536 href="http://code.google.com/policies.html#restrictions">noted</a>, 513 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
537 the content of this page is licensed under the <a rel="license"
538 href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
539 Attribution 3.0 License</a>, and code samples are licensed under the 514 Attribution 3.0 License</a>, and code samples are licensed under the
540 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>. 515 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
541 </p> 516 </p>
542 <p> 517 <p>
543 &copy;2011 Google 518 ©2011 Google
544 </p> 519 </p>
545 520
546 <!-- begin analytics --> 521 <!-- begin analytics -->
547 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script> 522 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
548 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript> 523 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
549 524
550 <script type="text/javascript"> 525 <script type="text/javascript">
551 // chrome doc tracking 526 // chrome doc tracking
552 try { 527 try {
553 var engdocs = _gat._getTracker("YT-10763712-2"); 528 var engdocs = _gat._getTracker("YT-10763712-2");
554 engdocs._trackPageview(); 529 engdocs._trackPageview();
555 } catch(err) {} 530 } catch(err) {}
556 531
557 // code.google.com site-wide tracking 532 // code.google.com site-wide tracking
558 try { 533 try {
559 _uacct="UA-18071-1"; 534 _uacct="UA-18071-1";
560 _uanchor=1; 535 _uanchor=1;
561 _uff=0; 536 _uff=0;
562 urchinTracker(); 537 urchinTracker();
563 } 538 }
564 catch(e) {/* urchinTracker not available. */} 539 catch(e) {/* urchinTracker not available. */}
565 </script> 540 </script>
566 <!-- end analytics --> 541 <!-- end analytics -->
567 </div> 542 </div>
568 </div> <!-- /gc-footer --> 543 </div> <!-- /gc-footer -->
569 </div> <!-- /gc-container --> 544 </div> <!-- /gc-container -->
545 </body></html>
OLDNEW
« chrome/common/extensions/api/webRequest.json ('K') | « chrome/common/extensions/api/webRequest.json ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/renderer/resources/extensions/event.js » ('J')

Powered by Google App Engine
This is Rietveld 408576698