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

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

Issue 3061041: Add the definition of the webRequest and webNavigation APIs. (Closed)
Patch Set: updates Created 10 years, 4 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
OLDNEW
(Empty)
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 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
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
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">
15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <title>chrome.experimental.webRequest - Google Chrome Extensions - Google Code </title></head>
19 <body> <div id="gc-container" class="labs">
20 <div id="devModeWarning">
21 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.
22 </div>
23 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
24 <!-- In particular, sub-templates that recurse, must be used by allowing
25 jstemplate to make a copy of the template in this section which
26 are not operated on by way of the jsskip="true" -->
27 <div style="display:none">
28
29 <!-- VALUE -->
30 <div id="valueTemplate">
31 <dt>
32 <var>paramName</var>
33 <em>
34
35 <!-- TYPE -->
36 <div style="display:inline">
37 (
38 <span class="optional">optional</span>
39 <span class="enum">enumerated</span>
40 <span id="typeTemplate">
41 <span>
42 <a> Type</a>
43 </span>
44 <span>
45 <span>
46 array of <span><span></span></span>
47 </span>
48 <span>paramType</span>
49 <span></span>
50 </span>
51 </span>
52 )
53 </div>
54
55 </em>
56 </dt>
57 <dd class="todo">
58 Undocumented.
59 </dd>
60 <dd>
61 Description of this parameter from the json schema.
62 </dd>
63 <dd>
64 This parameter was added in version
65 <b><span></span></b>.
66 You must omit this parameter in earlier versions,
67 and you may omit it in any version. If you require this
68 parameter, the manifest key
69 <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 </dd>
72
73 <!-- OBJECT PROPERTIES -->
74 <dd>
75 <dl>
76 <div>
77 <div>
78 </div>
79 </div>
80 </dl>
81 </dd>
82 </div> <!-- /VALUE -->
83
84 </div> <!-- /SUBTEMPLATES -->
85
86 <a id="top"></a>
87 <div id="skipto">
88 <a href="#gc-pagecontent">Skip to page content</a>
89 <a href="#gc-toc">Skip to main navigation</a>
90 </div>
91 <!-- API HEADER -->
92 <table id="header" width="100%" cellspacing="0" border="0">
93 <tbody><tr>
94 <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>
95 <td valign="middle" width="100%" style="padding-left:0.6em;">
96 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
97 <div id="gsc-search-box">
98 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
99 <input type="hidden" name="ie" value="UTF-8">
100 <input type="text" name="q" value="" size="55">
101 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
102 <br>
103 <span class="greytext">e.g. "page action" or "tabs"</span>
104 </div>
105 </form>
106
107 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
108 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
109 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
110 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
111 </td>
112 </tr>
113 </tbody></table>
114
115 <div id="codesiteContent" class="">
116
117 <a id="gc-topnav-anchor"></a>
118 <div id="gc-topnav">
119 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
120 <ul id="home" class="gc-topnav-tabs">
121 <li id="home_link">
122 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
123 </li>
124 <li id="docs_link">
125 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
126 </li>
127 <li id="faq_link">
128 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
129 </li>
130 <li id="samples_link">
131 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
132 </li>
133 <li id="group_link">
134 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
135 </li>
136 </ul>
137 </div> <!-- end gc-topnav -->
138
139 <div class="g-section g-tpl-170">
140 <!-- SIDENAV -->
141 <div class="g-unit g-first" id="gc-toc">
142 <ul>
143 <li><a href="getstarted.html">Getting Started</a></li>
144 <li><a href="overview.html">Overview</a></li>
145 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
146 <ul>
147 <li>Browser UI
148 <ul>
149 <li><a href="browserAction.html">Browser Actions</a></li>
150 <li><a href="contextMenus.html">Context Menus</a></li>
151 <li><a href="notifications.html">Desktop Notifications</a></li >
152 <li><a href="options.html">Options Pages</a></li>
153 <li><a href="override.html">Override Pages</a></li>
154 <li><a href="pageAction.html">Page Actions</a></li>
155 <li><a href="themes.html">Themes</a></li>
156 </ul>
157 </li>
158 <li>Browser Interaction
159 <ul>
160 <li><a href="bookmarks.html">Bookmarks</a></li>
161 <li><a href="cookies.html">Cookies</a></li>
162 <li><a href="events.html">Events</a></li>
163 <li><a href="history.html">History</a></li>
164 <li><a href="tabs.html">Tabs</a></li>
165 <li><a href="windows.html">Windows</a></li>
166 </ul>
167 </li>
168 <li>Implementation
169 <ul>
170 <li><a href="a11y.html">Accessibility</a></li>
171 <li><a href="background_pages.html">Background Pages</a></li>
172 <li><a href="content_scripts.html">Content Scripts</a></li>
173 <li><a href="xhr.html">Cross-Origin XHR</a></li>
174 <li><a href="idle.html">Idle</a></li>
175 <li><a href="i18n.html">Internationalization</a></li>
176 <li><a href="messaging.html">Message Passing</a></li>
177 <li><a href="npapi.html">NPAPI Plugins</a></li>
178 </ul>
179 </li>
180 <li>Finishing
181 <ul>
182 <li><a href="hosting.html">Hosting</a></li>
183 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
184 </ul>
185 </li>
186 </ul>
187 </li>
188 <li><h2><a href="tutorials.html">Tutorials</a></h2>
189 <ul>
190 <li><a href="tut_debugging.html">Debugging</a></li>
191 <li><a href="tut_analytics.html">Google Analytics</a></li>
192 <li><a href="tut_oauth.html">OAuth</a></li>
193 </ul>
194 </li>
195 <li><h2>Reference</h2>
196 <ul>
197 <li>Formats
198 <ul>
199 <li><a href="manifest.html">Manifest Files</a></li>
200 <li><a href="match_patterns.html">Match Patterns</a></li>
201 <!-- <li>Packages (.crx)</li> -->
202 </ul>
203 </li>
204 <li><a href="api_index.html">chrome.* APIs</a></li>
205 <li><a href="api_other.html">Other APIs</a></li>
206 </ul>
207 </li>
208 <li><h2><a href="samples.html">Samples</a></h2></li>
209 </ul>
210 </div>
211
212 <div class="g-unit" id="gc-pagecontent">
213 <div id="pageTitle">
214 <h1 class="page_title">chrome.experimental.webRequest</h1>
215 </div>
216 <!-- TABLE OF CONTENTS -->
217 <div id="toc">
218 <h2>Contents</h2>
219 <ol>
220 <li style="display: none; ">
221 <a>h2Name</a>
222 <ol>
223 <li>
224 <a>h3Name</a>
225 </li>
226 </ol>
227 </li>
228 <li>
229 <a href="#apiReference">API reference: chrome.experimental.webRe quest</a>
230 <ol>
231 <li style="display: none; ">
232 <a href="#properties">Properties</a>
233 <ol>
234 <li>
235 <a href="#property-anchor">propertyName</a>
236 </li>
237 </ol>
238 </li>
239 <li style="display: none; ">
240 <a href="#methods">Methods</a>
241 <ol>
242 <li>
243 <a href="#method-anchor">methodName</a>
244 </li>
245 </ol>
246 </li>
247 <li>
248 <a href="#events">Events</a>
249 <ol>
250 <li>
251 <a href="#event-onBeforeRedirect">onBeforeRedirect</a>
252 </li><li>
253 <a href="#event-onBeforeRequest">onBeforeRequest</a>
254 </li><li>
255 <a href="#event-onCompleted">onCompleted</a>
256 </li><li>
257 <a href="#event-onErrorOccurred">onErrorOccurred</a>
258 </li><li>
259 <a href="#event-onHeadersReceived">onHeadersReceived</a>
260 </li><li>
261 <a href="#event-onRequestSent">onRequestSent</a>
262 </li>
263 </ol>
264 </li>
265 <li style="display: none; ">
266 <a href="#types">Types</a>
267 <ol>
268 <li>
269 <a href="#id-anchor">id</a>
270 </li>
271 </ol>
272 </li>
273 </ol>
274 </li>
275 </ol>
276 </div>
277 <!-- /TABLE OF CONTENTS -->
278
279 <!-- Standard content lead-in for experimental API pages -->
280 <p id="classSummary">
281 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
282 </p>
283
284 <!-- STATIC CONTENT PLACEHOLDER -->
285 <div id="static"></div>
286
287 <!-- API PAGE -->
288 <div class="apiPage">
289 <a name="apiReference"></a>
290 <h2>API reference: chrome.experimental.webRequest</h2>
291
292 <!-- PROPERTIES -->
293 <div class="apiGroup" style="display: none; ">
294 <a name="properties"></a>
295 <h3 id="properties">Properties</h3>
296
297 <div>
298 <a></a>
299 <h4>getLastError</h4>
300 <div class="summary">
301 <!-- Note: intentionally longer 80 columns -->
302 <span>chrome.extension</span><span>lastError</span>
303 </div>
304 <div>
305 </div>
306 </div>
307
308 </div> <!-- /apiGroup -->
309
310 <!-- METHODS -->
311 <div class="apiGroup" id="methods" style="display: none; ">
312 <a name="methods"></a>
313 <h3>Methods</h3>
314
315 <!-- iterates over all functions -->
316 <div class="apiItem">
317 <a></a> <!-- method-anchor -->
318 <h4>method name</h4>
319
320 <div class="summary"><span>void</span>
321 <!-- Note: intentionally longer 80 columns -->
322 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
323 <var><span></span></var></span>)</div>
324
325 <div class="description">
326 <p class="todo">Undocumented.</p>
327 <p>
328 A description from the json schema def of the function goes he re.
329 </p>
330
331 <!-- PARAMETERS -->
332 <h4>Parameters</h4>
333 <dl>
334 <div>
335 <div>
336 </div>
337 </div>
338 </dl>
339
340 <!-- RETURNS -->
341 <h4>Returns</h4>
342 <dl>
343 <div>
344 <div>
345 </div>
346 </div>
347 </dl>
348
349 <!-- CALLBACK -->
350 <div>
351 <div>
352 <h4>Callback function</h4>
353 <p>
354 The callback <em>parameter</em> should specify a function
355 that looks like this:
356 </p>
357 <p>
358 If you specify the <em>callback</em> parameter, it should
359 specify a function that looks like this:
360 </p>
361
362 <!-- Note: intentionally longer 80 columns -->
363 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
364 <dl>
365 <div>
366 <div>
367 </div>
368 </div>
369 </dl>
370 </div>
371 </div>
372
373 <!-- MIN_VERSION -->
374 <p>
375 This function was added in version <b><span></span></b>.
376 If you require this function, the manifest key
377 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
378 can ensure that your extension won't be run in an earlier brow ser version.
379 </p>
380 </div> <!-- /description -->
381
382 </div> <!-- /apiItem -->
383
384 </div> <!-- /apiGroup -->
385
386 <!-- EVENTS -->
387 <div class="apiGroup">
388 <a name="events"></a>
389 <h3 id="events">Events</h3>
390
391 <!-- iterates over all events -->
392 <div class="apiItem">
393 <a name="event-onBeforeRedirect"></a>
394 <h4>onBeforeRedirect</h4>
395
396 <div class="summary">
397 <!-- Note: intentionally longer 80 columns -->
398 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeRedirect</span><span class="subdued">.addListener</span>(function(<spa n>object details</span>) <span class="subdued">{...}</span>);
399 </div>
400
401 <div class="description">
402 <p class="todo" style="display: none; ">Undocumented.</p>
403 <p>Fires when a server initiated redirect is about to occur.</p>
404
405 <!-- PARAMETERS -->
406 <h4>Parameters</h4>
407 <dl>
408 <div>
409 <div>
410 <dt>
411 <var>details</var>
412 <em>
413
414 <!-- TYPE -->
415 <div style="display:inline">
416 (
417 <span class="optional" style="display: none; ">optional</spa n>
418 <span class="enum" style="display: none; ">enumerated</span>
419 <span id="typeTemplate">
420 <span style="display: none; ">
421 <a> Type</a>
422 </span>
423 <span>
424 <span style="display: none; ">
425 array of <span><span></span></span>
426 </span>
427 <span>object</span>
428 <span style="display: none; "></span>
429 </span>
430 </span>
431 )
432 </div>
433
434 </em>
435 </dt>
436 <dd class="todo">
437 Undocumented.
438 </dd>
439 <dd style="display: none; ">
440 Description of this parameter from the json schema.
441 </dd>
442 <dd style="display: none; ">
443 This parameter was added in version
444 <b><span></span></b>.
445 You must omit this parameter in earlier versions,
446 and you may omit it in any version. If you require this
447 parameter, the manifest key
448 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
449 can ensure that your extension won't be run in an earlier browser ve rsion.
450 </dd>
451
452 <!-- OBJECT PROPERTIES -->
453 <dd>
454 <dl>
455 <div>
456 <div>
457 <dt>
458 <var>requestId</var>
459 <em>
460
461 <!-- TYPE -->
462 <div style="display:inline">
463 (
464 <span class="optional" style="display: none; ">optional</spa n>
465 <span class="enum" style="display: none; ">enumerated</span>
466 <span id="typeTemplate">
467 <span style="display: none; ">
468 <a> Type</a>
469 </span>
470 <span>
471 <span style="display: none; ">
472 array of <span><span></span></span>
473 </span>
474 <span>integer</span>
475 <span style="display: none; "></span>
476 </span>
477 </span>
478 )
479 </div>
480
481 </em>
482 </dt>
483 <dd class="todo" style="display: none; ">
484 Undocumented.
485 </dd>
486 <dd>The ID of the request.</dd>
487 <dd style="display: none; ">
488 This parameter was added in version
489 <b><span></span></b>.
490 You must omit this parameter in earlier versions,
491 and you may omit it in any version. If you require this
492 parameter, the manifest key
493 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
494 can ensure that your extension won't be run in an earlier browser ve rsion.
495 </dd>
496
497 <!-- OBJECT PROPERTIES -->
498 <dd style="display: none; ">
499 <dl>
500 <div>
501 <div>
502 </div>
503 </div>
504 </dl>
505 </dd>
506 </div>
507 </div><div>
508 <div>
509 <dt>
510 <var>url</var>
511 <em>
512
513 <!-- TYPE -->
514 <div style="display:inline">
515 (
516 <span class="optional" style="display: none; ">optional</spa n>
517 <span class="enum" style="display: none; ">enumerated</span>
518 <span id="typeTemplate">
519 <span style="display: none; ">
520 <a> Type</a>
521 </span>
522 <span>
523 <span style="display: none; ">
524 array of <span><span></span></span>
525 </span>
526 <span>string</span>
527 <span style="display: none; "></span>
528 </span>
529 </span>
530 )
531 </div>
532
533 </em>
534 </dt>
535 <dd class="todo" style="display: none; ">
536 Undocumented.
537 </dd>
538 <dd>The URL of the current request.</dd>
539 <dd style="display: none; ">
540 This parameter was added in version
541 <b><span></span></b>.
542 You must omit this parameter in earlier versions,
543 and you may omit it in any version. If you require this
544 parameter, the manifest key
545 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
546 can ensure that your extension won't be run in an earlier browser ve rsion.
547 </dd>
548
549 <!-- OBJECT PROPERTIES -->
550 <dd style="display: none; ">
551 <dl>
552 <div>
553 <div>
554 </div>
555 </div>
556 </dl>
557 </dd>
558 </div>
559 </div><div>
560 <div>
561 <dt>
562 <var>statusCode</var>
563 <em>
564
565 <!-- TYPE -->
566 <div style="display:inline">
567 (
568 <span class="optional" style="display: none; ">optional</spa n>
569 <span class="enum" style="display: none; ">enumerated</span>
570 <span id="typeTemplate">
571 <span style="display: none; ">
572 <a> Type</a>
573 </span>
574 <span>
575 <span style="display: none; ">
576 array of <span><span></span></span>
577 </span>
578 <span>integer</span>
579 <span style="display: none; "></span>
580 </span>
581 </span>
582 )
583 </div>
584
585 </em>
586 </dt>
587 <dd class="todo" style="display: none; ">
588 Undocumented.
589 </dd>
590 <dd>Standard HTTP status code returned by the server.</dd>
591 <dd style="display: none; ">
592 This parameter was added in version
593 <b><span></span></b>.
594 You must omit this parameter in earlier versions,
595 and you may omit it in any version. If you require this
596 parameter, the manifest key
597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
598 can ensure that your extension won't be run in an earlier browser ve rsion.
599 </dd>
600
601 <!-- OBJECT PROPERTIES -->
602 <dd style="display: none; ">
603 <dl>
604 <div>
605 <div>
606 </div>
607 </div>
608 </dl>
609 </dd>
610 </div>
611 </div><div>
612 <div>
613 <dt>
614 <var>redirectUrl</var>
615 <em>
616
617 <!-- TYPE -->
618 <div style="display:inline">
619 (
620 <span class="optional" style="display: none; ">optional</spa n>
621 <span class="enum" style="display: none; ">enumerated</span>
622 <span id="typeTemplate">
623 <span style="display: none; ">
624 <a> Type</a>
625 </span>
626 <span>
627 <span style="display: none; ">
628 array of <span><span></span></span>
629 </span>
630 <span>string</span>
631 <span style="display: none; "></span>
632 </span>
633 </span>
634 )
635 </div>
636
637 </em>
638 </dt>
639 <dd class="todo" style="display: none; ">
640 Undocumented.
641 </dd>
642 <dd>The new URL.</dd>
643 <dd style="display: none; ">
644 This parameter was added in version
645 <b><span></span></b>.
646 You must omit this parameter in earlier versions,
647 and you may omit it in any version. If you require this
648 parameter, the manifest key
649 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
650 can ensure that your extension won't be run in an earlier browser ve rsion.
651 </dd>
652
653 <!-- OBJECT PROPERTIES -->
654 <dd style="display: none; ">
655 <dl>
656 <div>
657 <div>
658 </div>
659 </div>
660 </dl>
661 </dd>
662 </div>
663 </div><div>
664 <div>
665 <dt>
666 <var>timeStamp</var>
667 <em>
668
669 <!-- TYPE -->
670 <div style="display:inline">
671 (
672 <span class="optional" style="display: none; ">optional</spa n>
673 <span class="enum" style="display: none; ">enumerated</span>
674 <span id="typeTemplate">
675 <span style="display: none; ">
676 <a> Type</a>
677 </span>
678 <span>
679 <span style="display: none; ">
680 array of <span><span></span></span>
681 </span>
682 <span>number</span>
683 <span style="display: none; "></span>
684 </span>
685 </span>
686 )
687 </div>
688
689 </em>
690 </dt>
691 <dd class="todo" style="display: none; ">
692 Undocumented.
693 </dd>
694 <dd>The time when the browser was about to make the redirect, in milli seconds since the epoch.</dd>
695 <dd style="display: none; ">
696 This parameter was added in version
697 <b><span></span></b>.
698 You must omit this parameter in earlier versions,
699 and you may omit it in any version. If you require this
700 parameter, the manifest key
701 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
702 can ensure that your extension won't be run in an earlier browser ve rsion.
703 </dd>
704
705 <!-- OBJECT PROPERTIES -->
706 <dd style="display: none; ">
707 <dl>
708 <div>
709 <div>
710 </div>
711 </div>
712 </dl>
713 </dd>
714 </div>
715 </div>
716 </dl>
717 </dd>
718 </div>
719 </div>
720 </dl>
721
722 </div> <!-- /decription -->
723
724 </div><div class="apiItem">
725 <a name="event-onBeforeRequest"></a>
726 <h4>onBeforeRequest</h4>
727
728 <div class="summary">
729 <!-- Note: intentionally longer 80 columns -->
730 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeRequest</span><span class="subdued">.addListener</span>(function(<span >object details</span>) <span class="subdued">{...}</span>);
731 </div>
732
733 <div class="description">
734 <p class="todo" style="display: none; ">Undocumented.</p>
735 <p>Fires when a request is about to occur.</p>
736
737 <!-- PARAMETERS -->
738 <h4>Parameters</h4>
739 <dl>
740 <div>
741 <div>
742 <dt>
743 <var>details</var>
744 <em>
745
746 <!-- TYPE -->
747 <div style="display:inline">
748 (
749 <span class="optional" style="display: none; ">optional</spa n>
750 <span class="enum" style="display: none; ">enumerated</span>
751 <span id="typeTemplate">
752 <span style="display: none; ">
753 <a> Type</a>
754 </span>
755 <span>
756 <span style="display: none; ">
757 array of <span><span></span></span>
758 </span>
759 <span>object</span>
760 <span style="display: none; "></span>
761 </span>
762 </span>
763 )
764 </div>
765
766 </em>
767 </dt>
768 <dd class="todo">
769 Undocumented.
770 </dd>
771 <dd style="display: none; ">
772 Description of this parameter from the json schema.
773 </dd>
774 <dd style="display: none; ">
775 This parameter was added in version
776 <b><span></span></b>.
777 You must omit this parameter in earlier versions,
778 and you may omit it in any version. If you require this
779 parameter, the manifest key
780 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
781 can ensure that your extension won't be run in an earlier browser ve rsion.
782 </dd>
783
784 <!-- OBJECT PROPERTIES -->
785 <dd>
786 <dl>
787 <div>
788 <div>
789 <dt>
790 <var>requestId</var>
791 <em>
792
793 <!-- TYPE -->
794 <div style="display:inline">
795 (
796 <span class="optional" style="display: none; ">optional</spa n>
797 <span class="enum" style="display: none; ">enumerated</span>
798 <span id="typeTemplate">
799 <span style="display: none; ">
800 <a> Type</a>
801 </span>
802 <span>
803 <span style="display: none; ">
804 array of <span><span></span></span>
805 </span>
806 <span>integer</span>
807 <span style="display: none; "></span>
808 </span>
809 </span>
810 )
811 </div>
812
813 </em>
814 </dt>
815 <dd class="todo" style="display: none; ">
816 Undocumented.
817 </dd>
818 <dd>The ID of the request. Request IDs are unique within a browser ses sion. As a result, they could be used to relate different events of the same req uest.</dd>
819 <dd style="display: none; ">
820 This parameter was added in version
821 <b><span></span></b>.
822 You must omit this parameter in earlier versions,
823 and you may omit it in any version. If you require this
824 parameter, the manifest key
825 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
826 can ensure that your extension won't be run in an earlier browser ve rsion.
827 </dd>
828
829 <!-- OBJECT PROPERTIES -->
830 <dd style="display: none; ">
831 <dl>
832 <div>
833 <div>
834 </div>
835 </div>
836 </dl>
837 </dd>
838 </div>
839 </div><div>
840 <div>
841 <dt>
842 <var>url</var>
843 <em>
844
845 <!-- TYPE -->
846 <div style="display:inline">
847 (
848 <span class="optional" style="display: none; ">optional</spa n>
849 <span class="enum" style="display: none; ">enumerated</span>
850 <span id="typeTemplate">
851 <span style="display: none; ">
852 <a> Type</a>
853 </span>
854 <span>
855 <span style="display: none; ">
856 array of <span><span></span></span>
857 </span>
858 <span>string</span>
859 <span style="display: none; "></span>
860 </span>
861 </span>
862 )
863 </div>
864
865 </em>
866 </dt>
867 <dd class="todo">
868 Undocumented.
869 </dd>
870 <dd style="display: none; ">
871 Description of this parameter from the json schema.
872 </dd>
873 <dd style="display: none; ">
874 This parameter was added in version
875 <b><span></span></b>.
876 You must omit this parameter in earlier versions,
877 and you may omit it in any version. If you require this
878 parameter, the manifest key
879 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
880 can ensure that your extension won't be run in an earlier browser ve rsion.
881 </dd>
882
883 <!-- OBJECT PROPERTIES -->
884 <dd style="display: none; ">
885 <dl>
886 <div>
887 <div>
888 </div>
889 </div>
890 </dl>
891 </dd>
892 </div>
893 </div><div>
894 <div>
895 <dt>
896 <var>method</var>
897 <em>
898
899 <!-- TYPE -->
900 <div style="display:inline">
901 (
902 <span class="optional" style="display: none; ">optional</spa n>
903 <span class="enum" style="display: none; ">enumerated</span>
904 <span id="typeTemplate">
905 <span style="display: none; ">
906 <a> Type</a>
907 </span>
908 <span>
909 <span style="display: none; ">
910 array of <span><span></span></span>
911 </span>
912 <span>string</span>
913 <span style="display: none; "></span>
914 </span>
915 </span>
916 )
917 </div>
918
919 </em>
920 </dt>
921 <dd class="todo" style="display: none; ">
922 Undocumented.
923 </dd>
924 <dd>Standard HTTP method.</dd>
925 <dd style="display: none; ">
926 This parameter was added in version
927 <b><span></span></b>.
928 You must omit this parameter in earlier versions,
929 and you may omit it in any version. If you require this
930 parameter, the manifest key
931 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
932 can ensure that your extension won't be run in an earlier browser ve rsion.
933 </dd>
934
935 <!-- OBJECT PROPERTIES -->
936 <dd style="display: none; ">
937 <dl>
938 <div>
939 <div>
940 </div>
941 </div>
942 </dl>
943 </dd>
944 </div>
945 </div><div>
946 <div>
947 <dt>
948 <var>tabId</var>
949 <em>
950
951 <!-- TYPE -->
952 <div style="display:inline">
953 (
954 <span class="optional" style="display: none; ">optional</spa n>
955 <span class="enum" style="display: none; ">enumerated</span>
956 <span id="typeTemplate">
957 <span style="display: none; ">
958 <a> Type</a>
959 </span>
960 <span>
961 <span style="display: none; ">
962 array of <span><span></span></span>
963 </span>
964 <span>integer</span>
965 <span style="display: none; "></span>
966 </span>
967 </span>
968 )
969 </div>
970
971 </em>
972 </dt>
973 <dd class="todo" style="display: none; ">
974 Undocumented.
975 </dd>
976 <dd>The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab.</dd>
977 <dd style="display: none; ">
978 This parameter was added in version
979 <b><span></span></b>.
980 You must omit this parameter in earlier versions,
981 and you may omit it in any version. If you require this
982 parameter, the manifest key
983 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
984 can ensure that your extension won't be run in an earlier browser ve rsion.
985 </dd>
986
987 <!-- OBJECT PROPERTIES -->
988 <dd style="display: none; ">
989 <dl>
990 <div>
991 <div>
992 </div>
993 </div>
994 </dl>
995 </dd>
996 </div>
997 </div><div>
998 <div>
999 <dt>
1000 <var>type</var>
1001 <em>
1002
1003 <!-- TYPE -->
1004 <div style="display:inline">
1005 (
1006 <span class="optional" style="display: none; ">optional</spa n>
1007 <span class="enum">enumerated</span>
1008 <span id="typeTemplate">
1009 <span style="display: none; ">
1010 <a> Type</a>
1011 </span>
1012 <span>
1013 <span style="display: none; ">
1014 array of <span><span></span></span>
1015 </span>
1016 <span>string</span>
1017 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "other"]</span>
1018 </span>
1019 </span>
1020 )
1021 </div>
1022
1023 </em>
1024 </dt>
1025 <dd class="todo" style="display: none; ">
1026 Undocumented.
1027 </dd>
1028 <dd>How the requested resource will be used.</dd>
1029 <dd style="display: none; ">
1030 This parameter was added in version
1031 <b><span></span></b>.
1032 You must omit this parameter in earlier versions,
1033 and you may omit it in any version. If you require this
1034 parameter, the manifest key
1035 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1036 can ensure that your extension won't be run in an earlier browser ve rsion.
1037 </dd>
1038
1039 <!-- OBJECT PROPERTIES -->
1040 <dd style="display: none; ">
1041 <dl>
1042 <div>
1043 <div>
1044 </div>
1045 </div>
1046 </dl>
1047 </dd>
1048 </div>
1049 </div><div>
1050 <div>
1051 <dt>
1052 <var>timeStamp</var>
1053 <em>
1054
1055 <!-- TYPE -->
1056 <div style="display:inline">
1057 (
1058 <span class="optional" style="display: none; ">optional</spa n>
1059 <span class="enum" style="display: none; ">enumerated</span>
1060 <span id="typeTemplate">
1061 <span style="display: none; ">
1062 <a> Type</a>
1063 </span>
1064 <span>
1065 <span style="display: none; ">
1066 array of <span><span></span></span>
1067 </span>
1068 <span>number</span>
1069 <span style="display: none; "></span>
1070 </span>
1071 </span>
1072 )
1073 </div>
1074
1075 </em>
1076 </dt>
1077 <dd class="todo" style="display: none; ">
1078 Undocumented.
1079 </dd>
1080 <dd>The time when the browser was about to make the request, in millis econds since the epoch.</dd>
1081 <dd style="display: none; ">
1082 This parameter was added in version
1083 <b><span></span></b>.
1084 You must omit this parameter in earlier versions,
1085 and you may omit it in any version. If you require this
1086 parameter, the manifest key
1087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1088 can ensure that your extension won't be run in an earlier browser ve rsion.
1089 </dd>
1090
1091 <!-- OBJECT PROPERTIES -->
1092 <dd style="display: none; ">
1093 <dl>
1094 <div>
1095 <div>
1096 </div>
1097 </div>
1098 </dl>
1099 </dd>
1100 </div>
1101 </div>
1102 </dl>
1103 </dd>
1104 </div>
1105 </div>
1106 </dl>
1107
1108 </div> <!-- /decription -->
1109
1110 </div><div class="apiItem">
1111 <a name="event-onCompleted"></a>
1112 <h4>onCompleted</h4>
1113
1114 <div class="summary">
1115 <!-- Note: intentionally longer 80 columns -->
1116 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onCompleted</span><span class="subdued">.addListener</span>(function(<span>obj ect details</span>) <span class="subdued">{...}</span>);
1117 </div>
1118
1119 <div class="description">
1120 <p class="todo" style="display: none; ">Undocumented.</p>
1121 <p>Fires when a request is completed.</p>
1122
1123 <!-- PARAMETERS -->
1124 <h4>Parameters</h4>
1125 <dl>
1126 <div>
1127 <div>
1128 <dt>
1129 <var>details</var>
1130 <em>
1131
1132 <!-- TYPE -->
1133 <div style="display:inline">
1134 (
1135 <span class="optional" style="display: none; ">optional</spa n>
1136 <span class="enum" style="display: none; ">enumerated</span>
1137 <span id="typeTemplate">
1138 <span style="display: none; ">
1139 <a> Type</a>
1140 </span>
1141 <span>
1142 <span style="display: none; ">
1143 array of <span><span></span></span>
1144 </span>
1145 <span>object</span>
1146 <span style="display: none; "></span>
1147 </span>
1148 </span>
1149 )
1150 </div>
1151
1152 </em>
1153 </dt>
1154 <dd class="todo">
1155 Undocumented.
1156 </dd>
1157 <dd style="display: none; ">
1158 Description of this parameter from the json schema.
1159 </dd>
1160 <dd style="display: none; ">
1161 This parameter was added in version
1162 <b><span></span></b>.
1163 You must omit this parameter in earlier versions,
1164 and you may omit it in any version. If you require this
1165 parameter, the manifest key
1166 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1167 can ensure that your extension won't be run in an earlier browser ve rsion.
1168 </dd>
1169
1170 <!-- OBJECT PROPERTIES -->
1171 <dd>
1172 <dl>
1173 <div>
1174 <div>
1175 <dt>
1176 <var>requestId</var>
1177 <em>
1178
1179 <!-- TYPE -->
1180 <div style="display:inline">
1181 (
1182 <span class="optional" style="display: none; ">optional</spa n>
1183 <span class="enum" style="display: none; ">enumerated</span>
1184 <span id="typeTemplate">
1185 <span style="display: none; ">
1186 <a> Type</a>
1187 </span>
1188 <span>
1189 <span style="display: none; ">
1190 array of <span><span></span></span>
1191 </span>
1192 <span>integer</span>
1193 <span style="display: none; "></span>
1194 </span>
1195 </span>
1196 )
1197 </div>
1198
1199 </em>
1200 </dt>
1201 <dd class="todo" style="display: none; ">
1202 Undocumented.
1203 </dd>
1204 <dd>The ID of the request.</dd>
1205 <dd style="display: none; ">
1206 This parameter was added in version
1207 <b><span></span></b>.
1208 You must omit this parameter in earlier versions,
1209 and you may omit it in any version. If you require this
1210 parameter, the manifest key
1211 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1212 can ensure that your extension won't be run in an earlier browser ve rsion.
1213 </dd>
1214
1215 <!-- OBJECT PROPERTIES -->
1216 <dd style="display: none; ">
1217 <dl>
1218 <div>
1219 <div>
1220 </div>
1221 </div>
1222 </dl>
1223 </dd>
1224 </div>
1225 </div><div>
1226 <div>
1227 <dt>
1228 <var>url</var>
1229 <em>
1230
1231 <!-- TYPE -->
1232 <div style="display:inline">
1233 (
1234 <span class="optional" style="display: none; ">optional</spa n>
1235 <span class="enum" style="display: none; ">enumerated</span>
1236 <span id="typeTemplate">
1237 <span style="display: none; ">
1238 <a> Type</a>
1239 </span>
1240 <span>
1241 <span style="display: none; ">
1242 array of <span><span></span></span>
1243 </span>
1244 <span>string</span>
1245 <span style="display: none; "></span>
1246 </span>
1247 </span>
1248 )
1249 </div>
1250
1251 </em>
1252 </dt>
1253 <dd class="todo" style="display: none; ">
1254 Undocumented.
1255 </dd>
1256 <dd>The URL of the current request.</dd>
1257 <dd style="display: none; ">
1258 This parameter was added in version
1259 <b><span></span></b>.
1260 You must omit this parameter in earlier versions,
1261 and you may omit it in any version. If you require this
1262 parameter, the manifest key
1263 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1264 can ensure that your extension won't be run in an earlier browser ve rsion.
1265 </dd>
1266
1267 <!-- OBJECT PROPERTIES -->
1268 <dd style="display: none; ">
1269 <dl>
1270 <div>
1271 <div>
1272 </div>
1273 </div>
1274 </dl>
1275 </dd>
1276 </div>
1277 </div><div>
1278 <div>
1279 <dt>
1280 <var>statusCode</var>
1281 <em>
1282
1283 <!-- TYPE -->
1284 <div style="display:inline">
1285 (
1286 <span class="optional" style="display: none; ">optional</spa n>
1287 <span class="enum" style="display: none; ">enumerated</span>
1288 <span id="typeTemplate">
1289 <span style="display: none; ">
1290 <a> Type</a>
1291 </span>
1292 <span>
1293 <span style="display: none; ">
1294 array of <span><span></span></span>
1295 </span>
1296 <span>integer</span>
1297 <span style="display: none; "></span>
1298 </span>
1299 </span>
1300 )
1301 </div>
1302
1303 </em>
1304 </dt>
1305 <dd class="todo" style="display: none; ">
1306 Undocumented.
1307 </dd>
1308 <dd>Standard HTTP status code returned by the server.</dd>
1309 <dd style="display: none; ">
1310 This parameter was added in version
1311 <b><span></span></b>.
1312 You must omit this parameter in earlier versions,
1313 and you may omit it in any version. If you require this
1314 parameter, the manifest key
1315 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1316 can ensure that your extension won't be run in an earlier browser ve rsion.
1317 </dd>
1318
1319 <!-- OBJECT PROPERTIES -->
1320 <dd style="display: none; ">
1321 <dl>
1322 <div>
1323 <div>
1324 </div>
1325 </div>
1326 </dl>
1327 </dd>
1328 </div>
1329 </div><div>
1330 <div>
1331 <dt>
1332 <var>timeStamp</var>
1333 <em>
1334
1335 <!-- TYPE -->
1336 <div style="display:inline">
1337 (
1338 <span class="optional" style="display: none; ">optional</spa n>
1339 <span class="enum" style="display: none; ">enumerated</span>
1340 <span id="typeTemplate">
1341 <span style="display: none; ">
1342 <a> Type</a>
1343 </span>
1344 <span>
1345 <span style="display: none; ">
1346 array of <span><span></span></span>
1347 </span>
1348 <span>number</span>
1349 <span style="display: none; "></span>
1350 </span>
1351 </span>
1352 )
1353 </div>
1354
1355 </em>
1356 </dt>
1357 <dd class="todo" style="display: none; ">
1358 Undocumented.
1359 </dd>
1360 <dd>The time when the response was received completely, in millisecond s since the epoch.</dd>
1361 <dd style="display: none; ">
1362 This parameter was added in version
1363 <b><span></span></b>.
1364 You must omit this parameter in earlier versions,
1365 and you may omit it in any version. If you require this
1366 parameter, the manifest key
1367 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1368 can ensure that your extension won't be run in an earlier browser ve rsion.
1369 </dd>
1370
1371 <!-- OBJECT PROPERTIES -->
1372 <dd style="display: none; ">
1373 <dl>
1374 <div>
1375 <div>
1376 </div>
1377 </div>
1378 </dl>
1379 </dd>
1380 </div>
1381 </div>
1382 </dl>
1383 </dd>
1384 </div>
1385 </div>
1386 </dl>
1387
1388 </div> <!-- /decription -->
1389
1390 </div><div class="apiItem">
1391 <a name="event-onErrorOccurred"></a>
1392 <h4>onErrorOccurred</h4>
1393
1394 <div class="summary">
1395 <!-- Note: intentionally longer 80 columns -->
1396 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span >object details</span>) <span class="subdued">{...}</span>);
1397 </div>
1398
1399 <div class="description">
1400 <p class="todo" style="display: none; ">Undocumented.</p>
1401 <p>Fires when an error occurs.</p>
1402
1403 <!-- PARAMETERS -->
1404 <h4>Parameters</h4>
1405 <dl>
1406 <div>
1407 <div>
1408 <dt>
1409 <var>details</var>
1410 <em>
1411
1412 <!-- TYPE -->
1413 <div style="display:inline">
1414 (
1415 <span class="optional" style="display: none; ">optional</spa n>
1416 <span class="enum" style="display: none; ">enumerated</span>
1417 <span id="typeTemplate">
1418 <span style="display: none; ">
1419 <a> Type</a>
1420 </span>
1421 <span>
1422 <span style="display: none; ">
1423 array of <span><span></span></span>
1424 </span>
1425 <span>object</span>
1426 <span style="display: none; "></span>
1427 </span>
1428 </span>
1429 )
1430 </div>
1431
1432 </em>
1433 </dt>
1434 <dd class="todo">
1435 Undocumented.
1436 </dd>
1437 <dd style="display: none; ">
1438 Description of this parameter from the json schema.
1439 </dd>
1440 <dd style="display: none; ">
1441 This parameter was added in version
1442 <b><span></span></b>.
1443 You must omit this parameter in earlier versions,
1444 and you may omit it in any version. If you require this
1445 parameter, the manifest key
1446 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1447 can ensure that your extension won't be run in an earlier browser ve rsion.
1448 </dd>
1449
1450 <!-- OBJECT PROPERTIES -->
1451 <dd>
1452 <dl>
1453 <div>
1454 <div>
1455 <dt>
1456 <var>requestId</var>
1457 <em>
1458
1459 <!-- TYPE -->
1460 <div style="display:inline">
1461 (
1462 <span class="optional" style="display: none; ">optional</spa n>
1463 <span class="enum" style="display: none; ">enumerated</span>
1464 <span id="typeTemplate">
1465 <span style="display: none; ">
1466 <a> Type</a>
1467 </span>
1468 <span>
1469 <span style="display: none; ">
1470 array of <span><span></span></span>
1471 </span>
1472 <span>integer</span>
1473 <span style="display: none; "></span>
1474 </span>
1475 </span>
1476 )
1477 </div>
1478
1479 </em>
1480 </dt>
1481 <dd class="todo" style="display: none; ">
1482 Undocumented.
1483 </dd>
1484 <dd>The ID of the request.</dd>
1485 <dd style="display: none; ">
1486 This parameter was added in version
1487 <b><span></span></b>.
1488 You must omit this parameter in earlier versions,
1489 and you may omit it in any version. If you require this
1490 parameter, the manifest key
1491 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1492 can ensure that your extension won't be run in an earlier browser ve rsion.
1493 </dd>
1494
1495 <!-- OBJECT PROPERTIES -->
1496 <dd style="display: none; ">
1497 <dl>
1498 <div>
1499 <div>
1500 </div>
1501 </div>
1502 </dl>
1503 </dd>
1504 </div>
1505 </div><div>
1506 <div>
1507 <dt>
1508 <var>url</var>
1509 <em>
1510
1511 <!-- TYPE -->
1512 <div style="display:inline">
1513 (
1514 <span class="optional" style="display: none; ">optional</spa n>
1515 <span class="enum" style="display: none; ">enumerated</span>
1516 <span id="typeTemplate">
1517 <span style="display: none; ">
1518 <a> Type</a>
1519 </span>
1520 <span>
1521 <span style="display: none; ">
1522 array of <span><span></span></span>
1523 </span>
1524 <span>string</span>
1525 <span style="display: none; "></span>
1526 </span>
1527 </span>
1528 )
1529 </div>
1530
1531 </em>
1532 </dt>
1533 <dd class="todo" style="display: none; ">
1534 Undocumented.
1535 </dd>
1536 <dd>The URL of the current request.</dd>
1537 <dd style="display: none; ">
1538 This parameter was added in version
1539 <b><span></span></b>.
1540 You must omit this parameter in earlier versions,
1541 and you may omit it in any version. If you require this
1542 parameter, the manifest key
1543 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1544 can ensure that your extension won't be run in an earlier browser ve rsion.
1545 </dd>
1546
1547 <!-- OBJECT PROPERTIES -->
1548 <dd style="display: none; ">
1549 <dl>
1550 <div>
1551 <div>
1552 </div>
1553 </div>
1554 </dl>
1555 </dd>
1556 </div>
1557 </div><div>
1558 <div>
1559 <dt>
1560 <var>error</var>
1561 <em>
1562
1563 <!-- TYPE -->
1564 <div style="display:inline">
1565 (
1566 <span class="optional" style="display: none; ">optional</spa n>
1567 <span class="enum" style="display: none; ">enumerated</span>
1568 <span id="typeTemplate">
1569 <span style="display: none; ">
1570 <a> Type</a>
1571 </span>
1572 <span>
1573 <span style="display: none; ">
1574 array of <span><span></span></span>
1575 </span>
1576 <span>string</span>
1577 <span style="display: none; "></span>
1578 </span>
1579 </span>
1580 )
1581 </div>
1582
1583 </em>
1584 </dt>
1585 <dd class="todo" style="display: none; ">
1586 Undocumented.
1587 </dd>
1588 <dd>The error description.</dd>
1589 <dd style="display: none; ">
1590 This parameter was added in version
1591 <b><span></span></b>.
1592 You must omit this parameter in earlier versions,
1593 and you may omit it in any version. If you require this
1594 parameter, the manifest key
1595 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1596 can ensure that your extension won't be run in an earlier browser ve rsion.
1597 </dd>
1598
1599 <!-- OBJECT PROPERTIES -->
1600 <dd style="display: none; ">
1601 <dl>
1602 <div>
1603 <div>
1604 </div>
1605 </div>
1606 </dl>
1607 </dd>
1608 </div>
1609 </div><div>
1610 <div>
1611 <dt>
1612 <var>timeStamp</var>
1613 <em>
1614
1615 <!-- TYPE -->
1616 <div style="display:inline">
1617 (
1618 <span class="optional" style="display: none; ">optional</spa n>
1619 <span class="enum" style="display: none; ">enumerated</span>
1620 <span id="typeTemplate">
1621 <span style="display: none; ">
1622 <a> Type</a>
1623 </span>
1624 <span>
1625 <span style="display: none; ">
1626 array of <span><span></span></span>
1627 </span>
1628 <span>number</span>
1629 <span style="display: none; "></span>
1630 </span>
1631 </span>
1632 )
1633 </div>
1634
1635 </em>
1636 </dt>
1637 <dd class="todo" style="display: none; ">
1638 Undocumented.
1639 </dd>
1640 <dd>The time when the error occurred, in milliseconds since the epoch. </dd>
1641 <dd style="display: none; ">
1642 This parameter was added in version
1643 <b><span></span></b>.
1644 You must omit this parameter in earlier versions,
1645 and you may omit it in any version. If you require this
1646 parameter, the manifest key
1647 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1648 can ensure that your extension won't be run in an earlier browser ve rsion.
1649 </dd>
1650
1651 <!-- OBJECT PROPERTIES -->
1652 <dd style="display: none; ">
1653 <dl>
1654 <div>
1655 <div>
1656 </div>
1657 </div>
1658 </dl>
1659 </dd>
1660 </div>
1661 </div>
1662 </dl>
1663 </dd>
1664 </div>
1665 </div>
1666 </dl>
1667
1668 </div> <!-- /decription -->
1669
1670 </div><div class="apiItem">
1671 <a name="event-onHeadersReceived"></a>
1672 <h4>onHeadersReceived</h4>
1673
1674 <div class="summary">
1675 <!-- Note: intentionally longer 80 columns -->
1676 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onHeadersReceived</span><span class="subdued">.addListener</span>(function(<sp an>object details</span>) <span class="subdued">{...}</span>);
1677 </div>
1678
1679 <div class="description">
1680 <p class="todo" style="display: none; ">Undocumented.</p>
1681 <p>Fires when the status line and response headers are received after a request is sent to the server.</p>
1682
1683 <!-- PARAMETERS -->
1684 <h4>Parameters</h4>
1685 <dl>
1686 <div>
1687 <div>
1688 <dt>
1689 <var>details</var>
1690 <em>
1691
1692 <!-- TYPE -->
1693 <div style="display:inline">
1694 (
1695 <span class="optional" style="display: none; ">optional</spa n>
1696 <span class="enum" style="display: none; ">enumerated</span>
1697 <span id="typeTemplate">
1698 <span style="display: none; ">
1699 <a> Type</a>
1700 </span>
1701 <span>
1702 <span style="display: none; ">
1703 array of <span><span></span></span>
1704 </span>
1705 <span>object</span>
1706 <span style="display: none; "></span>
1707 </span>
1708 </span>
1709 )
1710 </div>
1711
1712 </em>
1713 </dt>
1714 <dd class="todo">
1715 Undocumented.
1716 </dd>
1717 <dd style="display: none; ">
1718 Description of this parameter from the json schema.
1719 </dd>
1720 <dd style="display: none; ">
1721 This parameter was added in version
1722 <b><span></span></b>.
1723 You must omit this parameter in earlier versions,
1724 and you may omit it in any version. If you require this
1725 parameter, the manifest key
1726 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1727 can ensure that your extension won't be run in an earlier browser ve rsion.
1728 </dd>
1729
1730 <!-- OBJECT PROPERTIES -->
1731 <dd>
1732 <dl>
1733 <div>
1734 <div>
1735 <dt>
1736 <var>requestId</var>
1737 <em>
1738
1739 <!-- TYPE -->
1740 <div style="display:inline">
1741 (
1742 <span class="optional" style="display: none; ">optional</spa n>
1743 <span class="enum" style="display: none; ">enumerated</span>
1744 <span id="typeTemplate">
1745 <span style="display: none; ">
1746 <a> Type</a>
1747 </span>
1748 <span>
1749 <span style="display: none; ">
1750 array of <span><span></span></span>
1751 </span>
1752 <span>integer</span>
1753 <span style="display: none; "></span>
1754 </span>
1755 </span>
1756 )
1757 </div>
1758
1759 </em>
1760 </dt>
1761 <dd class="todo" style="display: none; ">
1762 Undocumented.
1763 </dd>
1764 <dd>The ID of the request.</dd>
1765 <dd style="display: none; ">
1766 This parameter was added in version
1767 <b><span></span></b>.
1768 You must omit this parameter in earlier versions,
1769 and you may omit it in any version. If you require this
1770 parameter, the manifest key
1771 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1772 can ensure that your extension won't be run in an earlier browser ve rsion.
1773 </dd>
1774
1775 <!-- OBJECT PROPERTIES -->
1776 <dd style="display: none; ">
1777 <dl>
1778 <div>
1779 <div>
1780 </div>
1781 </div>
1782 </dl>
1783 </dd>
1784 </div>
1785 </div><div>
1786 <div>
1787 <dt>
1788 <var>url</var>
1789 <em>
1790
1791 <!-- TYPE -->
1792 <div style="display:inline">
1793 (
1794 <span class="optional" style="display: none; ">optional</spa n>
1795 <span class="enum" style="display: none; ">enumerated</span>
1796 <span id="typeTemplate">
1797 <span style="display: none; ">
1798 <a> Type</a>
1799 </span>
1800 <span>
1801 <span style="display: none; ">
1802 array of <span><span></span></span>
1803 </span>
1804 <span>string</span>
1805 <span style="display: none; "></span>
1806 </span>
1807 </span>
1808 )
1809 </div>
1810
1811 </em>
1812 </dt>
1813 <dd class="todo">
1814 Undocumented.
1815 </dd>
1816 <dd style="display: none; ">
1817 Description of this parameter from the json schema.
1818 </dd>
1819 <dd style="display: none; ">
1820 This parameter was added in version
1821 <b><span></span></b>.
1822 You must omit this parameter in earlier versions,
1823 and you may omit it in any version. If you require this
1824 parameter, the manifest key
1825 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1826 can ensure that your extension won't be run in an earlier browser ve rsion.
1827 </dd>
1828
1829 <!-- OBJECT PROPERTIES -->
1830 <dd style="display: none; ">
1831 <dl>
1832 <div>
1833 <div>
1834 </div>
1835 </div>
1836 </dl>
1837 </dd>
1838 </div>
1839 </div><div>
1840 <div>
1841 <dt>
1842 <var>statusCode</var>
1843 <em>
1844
1845 <!-- TYPE -->
1846 <div style="display:inline">
1847 (
1848 <span class="optional" style="display: none; ">optional</spa n>
1849 <span class="enum" style="display: none; ">enumerated</span>
1850 <span id="typeTemplate">
1851 <span style="display: none; ">
1852 <a> Type</a>
1853 </span>
1854 <span>
1855 <span style="display: none; ">
1856 array of <span><span></span></span>
1857 </span>
1858 <span>integer</span>
1859 <span style="display: none; "></span>
1860 </span>
1861 </span>
1862 )
1863 </div>
1864
1865 </em>
1866 </dt>
1867 <dd class="todo" style="display: none; ">
1868 Undocumented.
1869 </dd>
1870 <dd>Standard HTTP status code returned by the server.</dd>
1871 <dd style="display: none; ">
1872 This parameter was added in version
1873 <b><span></span></b>.
1874 You must omit this parameter in earlier versions,
1875 and you may omit it in any version. If you require this
1876 parameter, the manifest key
1877 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1878 can ensure that your extension won't be run in an earlier browser ve rsion.
1879 </dd>
1880
1881 <!-- OBJECT PROPERTIES -->
1882 <dd style="display: none; ">
1883 <dl>
1884 <div>
1885 <div>
1886 </div>
1887 </div>
1888 </dl>
1889 </dd>
1890 </div>
1891 </div><div>
1892 <div>
1893 <dt>
1894 <var>timeStamp</var>
1895 <em>
1896
1897 <!-- TYPE -->
1898 <div style="display:inline">
1899 (
1900 <span class="optional" style="display: none; ">optional</spa n>
1901 <span class="enum" style="display: none; ">enumerated</span>
1902 <span id="typeTemplate">
1903 <span style="display: none; ">
1904 <a> Type</a>
1905 </span>
1906 <span>
1907 <span style="display: none; ">
1908 array of <span><span></span></span>
1909 </span>
1910 <span>number</span>
1911 <span style="display: none; "></span>
1912 </span>
1913 </span>
1914 )
1915 </div>
1916
1917 </em>
1918 </dt>
1919 <dd class="todo" style="display: none; ">
1920 Undocumented.
1921 </dd>
1922 <dd>The time when the status line and response headers were received, in milliseconds since the epoch.</dd>
1923 <dd style="display: none; ">
1924 This parameter was added in version
1925 <b><span></span></b>.
1926 You must omit this parameter in earlier versions,
1927 and you may omit it in any version. If you require this
1928 parameter, the manifest key
1929 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1930 can ensure that your extension won't be run in an earlier browser ve rsion.
1931 </dd>
1932
1933 <!-- OBJECT PROPERTIES -->
1934 <dd style="display: none; ">
1935 <dl>
1936 <div>
1937 <div>
1938 </div>
1939 </div>
1940 </dl>
1941 </dd>
1942 </div>
1943 </div>
1944 </dl>
1945 </dd>
1946 </div>
1947 </div>
1948 </dl>
1949
1950 </div> <!-- /decription -->
1951
1952 </div><div class="apiItem">
1953 <a name="event-onRequestSent"></a>
1954 <h4>onRequestSent</h4>
1955
1956 <div class="summary">
1957 <!-- Note: intentionally longer 80 columns -->
1958 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onRequestSent</span><span class="subdued">.addListener</span>(function(<span>o bject details</span>) <span class="subdued">{...}</span>);
1959 </div>
1960
1961 <div class="description">
1962 <p class="todo" style="display: none; ">Undocumented.</p>
1963 <p>Fires when a request is sent to the server.</p>
1964
1965 <!-- PARAMETERS -->
1966 <h4>Parameters</h4>
1967 <dl>
1968 <div>
1969 <div>
1970 <dt>
1971 <var>details</var>
1972 <em>
1973
1974 <!-- TYPE -->
1975 <div style="display:inline">
1976 (
1977 <span class="optional" style="display: none; ">optional</spa n>
1978 <span class="enum" style="display: none; ">enumerated</span>
1979 <span id="typeTemplate">
1980 <span style="display: none; ">
1981 <a> Type</a>
1982 </span>
1983 <span>
1984 <span style="display: none; ">
1985 array of <span><span></span></span>
1986 </span>
1987 <span>object</span>
1988 <span style="display: none; "></span>
1989 </span>
1990 </span>
1991 )
1992 </div>
1993
1994 </em>
1995 </dt>
1996 <dd class="todo">
1997 Undocumented.
1998 </dd>
1999 <dd style="display: none; ">
2000 Description of this parameter from the json schema.
2001 </dd>
2002 <dd style="display: none; ">
2003 This parameter was added in version
2004 <b><span></span></b>.
2005 You must omit this parameter in earlier versions,
2006 and you may omit it in any version. If you require this
2007 parameter, the manifest key
2008 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2009 can ensure that your extension won't be run in an earlier browser ve rsion.
2010 </dd>
2011
2012 <!-- OBJECT PROPERTIES -->
2013 <dd>
2014 <dl>
2015 <div>
2016 <div>
2017 <dt>
2018 <var>requestId</var>
2019 <em>
2020
2021 <!-- TYPE -->
2022 <div style="display:inline">
2023 (
2024 <span class="optional" style="display: none; ">optional</spa n>
2025 <span class="enum" style="display: none; ">enumerated</span>
2026 <span id="typeTemplate">
2027 <span style="display: none; ">
2028 <a> Type</a>
2029 </span>
2030 <span>
2031 <span style="display: none; ">
2032 array of <span><span></span></span>
2033 </span>
2034 <span>integer</span>
2035 <span style="display: none; "></span>
2036 </span>
2037 </span>
2038 )
2039 </div>
2040
2041 </em>
2042 </dt>
2043 <dd class="todo" style="display: none; ">
2044 Undocumented.
2045 </dd>
2046 <dd>The ID of the request.</dd>
2047 <dd style="display: none; ">
2048 This parameter was added in version
2049 <b><span></span></b>.
2050 You must omit this parameter in earlier versions,
2051 and you may omit it in any version. If you require this
2052 parameter, the manifest key
2053 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2054 can ensure that your extension won't be run in an earlier browser ve rsion.
2055 </dd>
2056
2057 <!-- OBJECT PROPERTIES -->
2058 <dd style="display: none; ">
2059 <dl>
2060 <div>
2061 <div>
2062 </div>
2063 </div>
2064 </dl>
2065 </dd>
2066 </div>
2067 </div><div>
2068 <div>
2069 <dt>
2070 <var>url</var>
2071 <em>
2072
2073 <!-- TYPE -->
2074 <div style="display:inline">
2075 (
2076 <span class="optional" style="display: none; ">optional</spa n>
2077 <span class="enum" style="display: none; ">enumerated</span>
2078 <span id="typeTemplate">
2079 <span style="display: none; ">
2080 <a> Type</a>
2081 </span>
2082 <span>
2083 <span style="display: none; ">
2084 array of <span><span></span></span>
2085 </span>
2086 <span>string</span>
2087 <span style="display: none; "></span>
2088 </span>
2089 </span>
2090 )
2091 </div>
2092
2093 </em>
2094 </dt>
2095 <dd class="todo">
2096 Undocumented.
2097 </dd>
2098 <dd style="display: none; ">
2099 Description of this parameter from the json schema.
2100 </dd>
2101 <dd style="display: none; ">
2102 This parameter was added in version
2103 <b><span></span></b>.
2104 You must omit this parameter in earlier versions,
2105 and you may omit it in any version. If you require this
2106 parameter, the manifest key
2107 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2108 can ensure that your extension won't be run in an earlier browser ve rsion.
2109 </dd>
2110
2111 <!-- OBJECT PROPERTIES -->
2112 <dd style="display: none; ">
2113 <dl>
2114 <div>
2115 <div>
2116 </div>
2117 </div>
2118 </dl>
2119 </dd>
2120 </div>
2121 </div><div>
2122 <div>
2123 <dt>
2124 <var>ip</var>
2125 <em>
2126
2127 <!-- TYPE -->
2128 <div style="display:inline">
2129 (
2130 <span class="optional" style="display: none; ">optional</spa n>
2131 <span class="enum" style="display: none; ">enumerated</span>
2132 <span id="typeTemplate">
2133 <span style="display: none; ">
2134 <a> Type</a>
2135 </span>
2136 <span>
2137 <span style="display: none; ">
2138 array of <span><span></span></span>
2139 </span>
2140 <span>string</span>
2141 <span style="display: none; "></span>
2142 </span>
2143 </span>
2144 )
2145 </div>
2146
2147 </em>
2148 </dt>
2149 <dd class="todo" style="display: none; ">
2150 Undocumented.
2151 </dd>
2152 <dd>The server IP address that is actually connected to. Note that it may be a literal IPv6 address.</dd>
2153 <dd style="display: none; ">
2154 This parameter was added in version
2155 <b><span></span></b>.
2156 You must omit this parameter in earlier versions,
2157 and you may omit it in any version. If you require this
2158 parameter, the manifest key
2159 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2160 can ensure that your extension won't be run in an earlier browser ve rsion.
2161 </dd>
2162
2163 <!-- OBJECT PROPERTIES -->
2164 <dd style="display: none; ">
2165 <dl>
2166 <div>
2167 <div>
2168 </div>
2169 </div>
2170 </dl>
2171 </dd>
2172 </div>
2173 </div><div>
2174 <div>
2175 <dt>
2176 <var>timeStamp</var>
2177 <em>
2178
2179 <!-- TYPE -->
2180 <div style="display:inline">
2181 (
2182 <span class="optional" style="display: none; ">optional</spa n>
2183 <span class="enum" style="display: none; ">enumerated</span>
2184 <span id="typeTemplate">
2185 <span style="display: none; ">
2186 <a> Type</a>
2187 </span>
2188 <span>
2189 <span style="display: none; ">
2190 array of <span><span></span></span>
2191 </span>
2192 <span>number</span>
2193 <span style="display: none; "></span>
2194 </span>
2195 </span>
2196 )
2197 </div>
2198
2199 </em>
2200 </dt>
2201 <dd class="todo" style="display: none; ">
2202 Undocumented.
2203 </dd>
2204 <dd>The time when the browser finished sending the request, in millise conds since the epoch.</dd>
2205 <dd style="display: none; ">
2206 This parameter was added in version
2207 <b><span></span></b>.
2208 You must omit this parameter in earlier versions,
2209 and you may omit it in any version. If you require this
2210 parameter, the manifest key
2211 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2212 can ensure that your extension won't be run in an earlier browser ve rsion.
2213 </dd>
2214
2215 <!-- OBJECT PROPERTIES -->
2216 <dd style="display: none; ">
2217 <dl>
2218 <div>
2219 <div>
2220 </div>
2221 </div>
2222 </dl>
2223 </dd>
2224 </div>
2225 </div>
2226 </dl>
2227 </dd>
2228 </div>
2229 </div>
2230 </dl>
2231
2232 </div> <!-- /decription -->
2233
2234 </div> <!-- /apiItem -->
2235
2236 </div> <!-- /apiGroup -->
2237
2238 <!-- TYPES -->
2239 <div class="apiGroup" style="display: none; ">
2240 <a name="types"></a>
2241 <h3 id="types">Types</h3>
2242
2243 <!-- iterates over all types -->
2244 <div class="apiItem">
2245 <a></a>
2246 <h4>type name</h4>
2247
2248 <div>
2249 </div>
2250
2251 </div> <!-- /apiItem -->
2252
2253 </div> <!-- /apiGroup -->
2254
2255 </div> <!-- /apiPage -->
2256 </div> <!-- /gc-pagecontent -->
2257 </div> <!-- /g-section -->
2258 </div> <!-- /codesiteContent -->
2259 <div id="gc-footer" --="">
2260 <div class="text">
2261 <p>
2262 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2263 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2264 Attribution 3.0 License</a>, and code samples are licensed under the
2265 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2266 </p>
2267 <p>
2268 ©2010 Google
2269 </p>
2270
2271 <!-- begin analytics -->
2272 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
2273 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
2274
2275 <script type="text/javascript">
2276 // chrome doc tracking
2277 try {
2278 var engdocs = _gat._getTracker("YT-10763712-2");
2279 engdocs._trackPageview();
2280 } catch(err) {}
2281
2282 // code.google.com site-wide tracking
2283 try {
2284 _uacct="UA-18071-1";
2285 _uanchor=1;
2286 _uff=0;
2287 urchinTracker();
2288 }
2289 catch(e) {/* urchinTracker not available. */}
2290 </script>
2291 <!-- end analytics -->
2292 </div>
2293 </div> <!-- /gc-footer -->
2294 </div> <!-- /gc-container -->
2295 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698