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

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

Issue 10257006: Move Declarative Web Request API out of experimental and make it a feature (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Merged with ToT Created 8 years, 7 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
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js"> 16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script> 17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script> 18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script> 19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script> 20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.experimental.we bRequest module, which is part of the Google Chrome extension APIs."><title>exp erimental.webRequest - Google Chrome Extensions - Google Code</title></head> 21 <meta name="description" content="Documentation for the chrome.declarativeWebR equest module, which is part of the Google Chrome extension APIs."><title>chrom e.declarativeWebRequest - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning"> 22 <body> <div id="devModeWarning" class="displayModeWarning">
23 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. 23 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.
24 </div> 24 </div>
25 <div id="branchWarning" class="displayModeWarning"> 25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span> 27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser"> 28 <select id="branchChooser">
29 <option>Choose a different version... 29 <option>Choose a different version...
30 </option><option value="">Stable 30 </option><option value="">Stable
31 </option><option value="beta">Beta 31 </option><option value="beta">Beta
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after
178 <li><a href="themes.html">Themes</a></li> 178 <li><a href="themes.html">Themes</a></li>
179 </ul> 179 </ul>
180 </li> 180 </li>
181 </ul> 181 </ul>
182 </div> 182 </div>
183 <script> 183 <script>
184 initToggles(); 184 initToggles();
185 </script> 185 </script>
186 <div class="g-unit" id="gc-pagecontent"> 186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle"> 187 <div id="pageTitle">
188 <h1 class="page_title">experimental.webRequest</h1> 188 <h1 class="page_title">chrome.declarativeWebRequest</h1>
189 </div> 189 </div>
190 <!-- TABLE OF CONTENTS --> 190 <!-- TABLE OF CONTENTS -->
191 <div id="toc"> 191 <div id="toc">
192 <h2>Contents</h2> 192 <h2>Contents</h2>
193 <ol> 193 <ol>
194 <li> 194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.webRe quest</a> 195 <a href="#apiReference">API reference: chrome.declarativeWebRequ est</a>
196 <ol> 196 <ol>
197 <li> 197 <li>
198 <a href="#global-events">Events</a> 198 <a href="#global-events">Events</a>
199 <ol> 199 <ol>
200 <li> 200 <li>
201 <a href="#event-onRequest">onRequest</a> 201 <a href="#event-onRequest">onRequest</a>
202 </li> 202 </li>
203 </ol> 203 </ol>
204 </li> 204 </li>
205 <li> 205 <li>
(...skipping 13 matching lines...) Expand all
219 </ol> 219 </ol>
220 </li> 220 </li>
221 </ol> 221 </ol>
222 </li> 222 </li>
223 </ol> 223 </ol>
224 </li> 224 </li>
225 </ol> 225 </ol>
226 </div> 226 </div>
227 <!-- /TABLE OF CONTENTS --> 227 <!-- /TABLE OF CONTENTS -->
228 <!-- Standard content lead-in for experimental API pages --> 228 <!-- Standard content lead-in for experimental API pages -->
229 <p class="warning">
230 <!-- Standard content lead-in for APIs that are not yet available on
231 the stable channel. -->
232 <em>Warning:</em> This API is still under development. It is only
233 available for Chrome users on the
234 <span>
235 <strong>dev</strong>
236 <a href="http://www.chromium.org/getting-involved/dev-channel">ear ly
237 release channel</a>.</span>
238 <a href="TODO">Learn more</a>.
239 </p>
229 <!-- STATIC CONTENT PLACEHOLDER --> 240 <!-- STATIC CONTENT PLACEHOLDER -->
230 <div id="static"><div id="pageData-name" class="pageData">experimental.w ebRequest</div> 241 <div id="static"></div>
231 <p>
232 The <code>WebRequest</code> API is no longer experimental;
233 it's supported! You can read all about it at its new home:
234 </p>
235 <blockquote>
236 <a href="webRequest.html">chrome.webRequest</a>
237 </blockquote>
238 <p>
239 What you see below are early outcomes of the plan to implement a declarative
240 version of the WebRequest API. Please ignore this until we give notice.
241 </p>
242 </div>
243 <!-- API PAGE --> 242 <!-- API PAGE -->
244 <div class="apiPage"> 243 <div class="apiPage">
245 <a name="apiReference"></a> 244 <a name="apiReference"></a>
246 <h2>API reference: chrome.experimental.webRequest</h2> 245 <h2>API reference: chrome.declarativeWebRequest</h2>
247 <!-- PROPERTIES --> 246 <!-- PROPERTIES -->
248 <!-- /apiGroup --> 247 <!-- /apiGroup -->
249 <!-- METHODS --> 248 <!-- METHODS -->
250 <!-- /apiGroup --> 249 <!-- /apiGroup -->
251 <!-- EVENTS --> 250 <!-- EVENTS -->
252 <div id="eventsTemplate" class="apiGroup"> 251 <div id="eventsTemplate" class="apiGroup">
253 <a name="global-events"></a> 252 <a name="global-events"></a>
254 <h3>Events</h3> 253 <h3>Events</h3>
255 <!-- iterates over all events --> 254 <!-- iterates over all events -->
256 <div class="apiItem"> 255 <div class="apiItem">
257 <a name="event-onRequest"></a> 256 <a name="event-onRequest"></a>
258 <h4>onRequest</h4> 257 <h4>onRequest</h4>
259 <div class="summary"> 258 <div class="summary">
260 <!-- Note: intentionally longer 80 columns --> 259 <!-- Note: intentionally longer 80 columns -->
261 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onRequest</span><span class="subdued">.addListener</span>(function(<span></spa n>) <span class="subdued">{...}</span><span></span>); 260 <span class="subdued">chrome.declarativeWebRequest.</span><span> onRequest</span><span class="subdued">.addListener</span>(function(<span></span> ) <span class="subdued">{...}</span><span></span>);
262 </div> 261 </div>
263 <div class="description"> 262 <div class="description">
264 <!-- LISTENER PARAMETERS --> 263 <!-- LISTENER PARAMETERS -->
265 <!-- EXTRA PARAMETERS --> 264 <!-- EXTRA PARAMETERS -->
266 <!-- LISTENER RETURN VALUE --> 265 <!-- LISTENER RETURN VALUE -->
267 <dl> 266 <dl>
268 </dl> 267 </dl>
269 </div> <!-- /description --> 268 </div> <!-- /description -->
270 </div> <!-- /apiItem --> 269 </div> <!-- /apiItem -->
271 </div> <!-- /apiGroup --> 270 </div> <!-- /apiGroup -->
(...skipping 84 matching lines...) Expand 10 before | Expand all | Expand 10 after
356 <dt> 355 <dt>
357 <var>instanceType</var> 356 <var>instanceType</var>
358 <em> 357 <em>
359 <!-- TYPE --> 358 <!-- TYPE -->
360 <div style="display:inline"> 359 <div style="display:inline">
361 ( 360 (
362 <span class="enum">enumerated</span> 361 <span class="enum">enumerated</span>
363 <span id="typeTemplate"> 362 <span id="typeTemplate">
364 <span> 363 <span>
365 <span>string</span> 364 <span>string</span>
366 <span>["experimental.webRequest.RequestMatcher"]</span> 365 <span>["declarativeWebRequest.RequestMatcher"]</span>
367 </span> 366 </span>
368 </span> 367 </span>
369 ) 368 )
370 </div> 369 </div>
371 </em> 370 </em>
372 </dt> 371 </dt>
373 <dd class="todo"> 372 <dd class="todo">
374 Undocumented. 373 Undocumented.
375 </dd> 374 </dd>
376 <!-- OBJECT PROPERTIES --> 375 <!-- OBJECT PROPERTIES -->
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
412 <dt> 411 <dt>
413 <var>instanceType</var> 412 <var>instanceType</var>
414 <em> 413 <em>
415 <!-- TYPE --> 414 <!-- TYPE -->
416 <div style="display:inline"> 415 <div style="display:inline">
417 ( 416 (
418 <span class="enum">enumerated</span> 417 <span class="enum">enumerated</span>
419 <span id="typeTemplate"> 418 <span id="typeTemplate">
420 <span> 419 <span>
421 <span>string</span> 420 <span>string</span>
422 <span>["experimental.webRequest.CancelRequest"]</span> 421 <span>["declarativeWebRequest.CancelRequest"]</span>
423 </span> 422 </span>
424 </span> 423 </span>
425 ) 424 )
426 </div> 425 </div>
427 </em> 426 </em>
428 </dt> 427 </dt>
429 <dd class="todo"> 428 <dd class="todo">
430 Undocumented. 429 Undocumented.
431 </dd> 430 </dd>
432 <!-- OBJECT PROPERTIES --> 431 <!-- OBJECT PROPERTIES -->
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
468 <dt> 467 <dt>
469 <var>instanceType</var> 468 <var>instanceType</var>
470 <em> 469 <em>
471 <!-- TYPE --> 470 <!-- TYPE -->
472 <div style="display:inline"> 471 <div style="display:inline">
473 ( 472 (
474 <span class="enum">enumerated</span> 473 <span class="enum">enumerated</span>
475 <span id="typeTemplate"> 474 <span id="typeTemplate">
476 <span> 475 <span>
477 <span>string</span> 476 <span>string</span>
478 <span>["experimental.webRequest.RedirectRequest"]</span> 477 <span>["declarativeWebRequest.RedirectRequest"]</span>
479 </span> 478 </span>
480 </span> 479 </span>
481 ) 480 )
482 </div> 481 </div>
483 </em> 482 </em>
484 </dt> 483 </dt>
485 <dd class="todo"> 484 <dd class="todo">
486 Undocumented. 485 Undocumented.
487 </dd> 486 </dd>
488 <!-- OBJECT PROPERTIES --> 487 <!-- OBJECT PROPERTIES -->
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after
553 _uff=0; 552 _uff=0;
554 urchinTracker(); 553 urchinTracker();
555 } 554 }
556 catch(e) {/* urchinTracker not available. */} 555 catch(e) {/* urchinTracker not available. */}
557 </script> 556 </script>
558 <!-- end analytics --> 557 <!-- end analytics -->
559 </div> 558 </div>
560 </div> <!-- /gc-footer --> 559 </div> <!-- /gc-footer -->
561 </div> <!-- /gc-container --> 560 </div> <!-- /gc-container -->
562 </body></html> 561 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/api_index.html ('k') | chrome/common/extensions/docs/examples/api/eventPage/basic.zip » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698