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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 8662010: Rename chrome.experimental.webRequest to chrome.webRequest and chrome.webRequestBlocking (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Added webRequest_blocking back Created 9 years 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/manifest.html » ('j') | chrome/common/extensions/extension_permission_set.cc » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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 <script type="text/javascript" src="js/sidebar.js"></script>
19 <title>WebRequest API - Google Chrome Extensions - Google Code</title></head>
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>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing
26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none">
29
30 <!-- VALUE -->
31 <div id="valueTemplate">
32 <dt>
33 <var>paramName</var>
34 <em>
35
36 <!-- TYPE -->
37 <div style="display:inline">
38 (
39 <span class="optional">optional</span>
40 <span class="enum">enumerated</span>
41 <span id="typeTemplate">
42 <span>
43 <a> Type</a>
44 </span>
45 <span>
46 <span>
47 array of <span><span></span></span>
48 </span>
49 <span>paramType</span>
50 <span></span>
51 </span>
52 </span>
53 )
54 </div>
55
56 </em>
57 </dt>
58 <dd class="todo">
59 Undocumented.
60 </dd>
61 <dd>
62 Description of this parameter from the json schema.
63 </dd>
64 <dd>
65 This parameter was added in version
66 <b><span></span></b>.
67 You must omit this parameter in earlier versions,
68 and you may omit it in any version. If you require this
69 parameter, the manifest key
70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
71 can ensure that your extension won't be run in an earlier browser ve rsion.
72 </dd>
73
74 <!-- OBJECT PROPERTIES -->
75 <dd>
76 <dl>
77 <div>
78 <div>
79 </div>
80 </div>
81 </dl>
82 </dd>
83
84 <!-- OBJECT METHODS -->
85 <dd>
86 <div></div>
87 </dd>
88
89 <!-- OBJECT EVENT FIELDS -->
90 <dd>
91 <div></div>
92 </dd>
93
94 <!-- FUNCTION PARAMETERS -->
95 <dd>
96 <div></div>
97 </dd>
98
99 </div> <!-- /VALUE -->
100
101 <div id="functionParametersTemplate">
102 <h5>Parameters</h5>
103 <dl>
104 <div>
105 <div>
106 </div>
107 </div>
108 </dl>
109 </div>
110
111 <!-- Individual subsections from the table of contents -->
112 <ol>
113 <li id="propertiesTocTemplate">
114 <a href="#properties">Properties</a>
115 <ol>
116 <li>
117 <a href="#property-anchor">propertyName</a>
118 </li>
119 </ol>
120 </li>
121 <li id="methodsTocTemplate">
122 <a>Methods</a>
123 <ol>
124 <li>
125 <a href="#method-anchor">methodName</a>
126 </li>
127 </ol>
128 </li>
129 <li id="eventsTocTemplate">
130 <a>Events</a>
131 <ol>
132 <li>
133 <a href="#event-anchor">eventName</a>
134 </li>
135 </ol>
136 </li>
137 <li id="typesTocTemplate">
138 <a href="#types">Types</a>
139 <ol>
140 <li>
141 <a href="#id-anchor">id</a>
142 <ol>
143 <div></div>
144 <div></div>
145 </ol>
146 </li>
147 </ol>
148 </li>
149 </ol>
150 </div> <!-- /SUBTEMPLATES -->
151
152 <a id="top"></a>
153 <div id="skipto">
154 <a href="#gc-pagecontent">Skip to page content</a>
155 <a href="#gc-toc">Skip to main navigation</a>
156 </div>
157 <!-- API HEADER -->
158 <table id="header" width="100%" cellspacing="0" border="0">
159 <tbody><tr>
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>
161 <td valign="middle" width="100%" style="padding-left:0.6em;">
162 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
163 <div id="gsc-search-box">
164 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
165 <input type="hidden" name="ie" value="UTF-8">
166 <input type="text" name="q" value="" size="55">
167 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
168 <br>
169 <span class="greytext">e.g. "page action" or "tabs"</span>
170 </div>
171 </form>
172
173 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
174 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
175 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
176 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
177 </td>
178 </tr>
179 </tbody></table>
180
181 <div id="codesiteContent" class="">
182
183 <a id="gc-topnav-anchor"></a>
184 <div id="gc-topnav">
185 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
186 <ul id="home" class="gc-topnav-tabs">
187 <li id="home_link">
188 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
189 </li>
190 <li id="docs_link">
191 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
192 </li>
193 <li id="faq_link">
194 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
195 </li>
196 <li id="samples_link">
197 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
198 </li>
199 <li id="group_link">
200 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
201 </li>
202 <li id="so_link">
203 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
204 </li>
205 </ul>
206 </div> <!-- end gc-topnav -->
207
208 <div class="g-section g-tpl-170">
209 <!-- SIDENAV -->
210 <div class="g-unit g-first" id="gc-toc">
211 <ul>
212 <li><a href="getstarted.html">Getting Started</a></li>
213 <li><a href="overview.html">Overview</a></li>
214 <li><a href="whats_new.html">What's New?</a></li>
215 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
216 <ul>
217 <li>Browser UI
218 <ul>
219 <li><a href="browserAction.html">Browser Actions</a></li>
220 <li><a href="contextMenus.html">Context Menus</a></li>
221 <li><a href="notifications.html">Desktop Notifications</a></li >
222 <li><a href="omnibox.html">Omnibox</a></li>
223 <li><a href="options.html">Options Pages</a></li>
224 <li><a href="override.html">Override Pages</a></li>
225 <li><a href="pageAction.html">Page Actions</a></li>
226 </ul>
227 </li>
228 <li>Browser Interaction
229 <ul>
230 <li><a href="bookmarks.html">Bookmarks</a></li>
231 <li><a href="cookies.html">Cookies</a></li>
232 <li><a href="events.html">Events</a></li>
233 <li><a href="history.html">History</a></li>
234 <li><a href="management.html">Management</a></li>
235 <li><a href="tabs.html">Tabs</a></li>
236 <li><a href="windows.html">Windows</a></li>
237 </ul>
238 </li>
239 <li>Implementation
240 <ul>
241 <li><a href="a11y.html">Accessibility</a></li>
242 <li><a href="background_pages.html">Background Pages</a></li>
243 <li><a href="content_scripts.html">Content Scripts</a></li>
244 <li><a href="xhr.html">Cross-Origin XHR</a></li>
245 <li><a href="i18n.html">Internationalization</a></li>
246 <li><a href="messaging.html">Message Passing</a></li>
247 <li><a href="permissions.html">Optional Permissions</a></li>
248 <li><a href="npapi.html">NPAPI Plugins</a></li>
249 </ul>
250 </li>
251 <li>Finishing
252 <ul>
253 <li><a href="hosting.html">Hosting</a></li>
254 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
255 </ul>
256 </li>
257 </ul>
258 </li>
259 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
260 <li><h2><a href="tutorials.html">Tutorials</a></h2>
261 <ul>
262 <li><a href="tut_debugging.html">Debugging</a></li>
263 <li><a href="tut_analytics.html">Google Analytics</a></li>
264 <li><a href="tut_oauth.html">OAuth</a></li>
265 </ul>
266 </li>
267 <li><h2>Reference</h2>
268 <ul>
269 <li>Formats
270 <ul>
271 <li><a href="manifest.html">Manifest Files</a></li>
272 <li><a href="match_patterns.html">Match Patterns</a></li>
273 </ul>
274 </li>
275 <li><a href="permission_warnings.html">Permission Warnings</a></li >
276 <li><a href="api_index.html">chrome.* APIs</a></li>
277 <li><a href="api_other.html">Other APIs</a></li>
278 </ul>
279 </li>
280 <li><h2><a href="samples.html">Samples</a></h2></li>
281 <div class="line"> </div>
282 <li><h2>More</h2>
283 <ul>
284 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
285 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
286 <li><a href="themes.html">Themes</a></li>
287 </ul>
288 </li>
289 </ul>
290 </div>
291 <script>
292 initToggles();
293 </script>
294
295 <div class="g-unit" id="gc-pagecontent">
296 <div id="pageTitle">
297 <h1 class="page_title">WebRequest API</h1>
298 </div>
299 <!-- TABLE OF CONTENTS -->
300 <div id="toc">
301 <h2>Contents</h2>
302 <ol>
303 <li>
304 <a href="#manifest">Manifest</a>
305 <ol>
306 <li style="display: none; ">
307 <a>h3Name</a>
308 </li>
309 </ol>
310 </li><li>
311 <a href="#life_cycle">Life-cycle of requests</a>
312 <ol>
313 <li style="display: none; ">
314 <a>h3Name</a>
315 </li>
316 </ol>
317 </li><li>
318 <a href="#concepts">Concepts of the webRequest API</a>
319 <ol>
320 <li>
321 <a href="#Request IDs">Request IDs</a>
322 </li><li>
323 <a href="#subscription">Subscription</a>
324 </li>
325 </ol>
326 </li><li>
327 <a href="#conflict_resolution">Conflict resolution</a>
328 <ol>
329 <li style="display: none; ">
330 <a>h3Name</a>
331 </li>
332 </ol>
333 </li><li>
334 <a href="#H2-6">A note about caching</a>
335 <ol>
336 <li style="display: none; ">
337 <a>h3Name</a>
338 </li>
339 </ol>
340 </li><li>
341 <a href="#H2-7">A note about timestamps</a>
342 <ol>
343 <li style="display: none; ">
344 <a>h3Name</a>
345 </li>
346 </ol>
347 </li><li>
348 <a href="#examples">Examples</a>
349 <ol>
350 <li style="display: none; ">
351 <a>h3Name</a>
352 </li>
353 </ol>
354 </li>
355 <li>
356 <a href="#apiReference">API reference: chrome.experimental.webRe quest</a>
357 <ol>
358 <li style="display: none; ">
359 <a href="#properties">Properties</a>
360 <ol>
361 <li>
362 <a href="#property-anchor">propertyName</a>
363 </li>
364 </ol>
365 </li>
366 <li>
367 <a href="#global-methods">Methods</a>
368 <ol>
369 <li style="display: none; ">
370 <a href="#method-anchor">methodName</a>
371 </li><li style="display: none; ">
372 <a href="#method-anchor">methodName</a>
373 </li><li>
374 <a href="#method-handlerBehaviorChanged">handlerBehaviorChanged< /a>
375 </li>
376 </ol>
377 </li>
378 <li>
379 <a href="#global-events">Events</a>
380 <ol>
381 <li>
382 <a href="#event-onAuthRequired">onAuthRequired</a>
383 </li><li>
384 <a href="#event-onBeforeRedirect">onBeforeRedirect</a>
385 </li><li>
386 <a href="#event-onBeforeRequest">onBeforeRequest</a>
387 </li><li>
388 <a href="#event-onBeforeSendHeaders">onBeforeSendHeaders</a>
389 </li><li>
390 <a href="#event-onCompleted">onCompleted</a>
391 </li><li>
392 <a href="#event-onErrorOccurred">onErrorOccurred</a>
393 </li><li>
394 <a href="#event-onHeadersReceived">onHeadersReceived</a>
395 </li><li>
396 <a href="#event-onResponseStarted">onResponseStarted</a>
397 </li><li>
398 <a href="#event-onSendHeaders">onSendHeaders</a>
399 </li>
400 </ol>
401 </li>
402 <li>
403 <a href="#types">Types</a>
404 <ol>
405 <li>
406 <a href="#type-RequestFilter">RequestFilter</a>
407 <ol>
408 <li style="display: none; ">
409 <a>Methods</a>
410 <ol>
411 <li>
412 <a href="#method-anchor">methodName</a>
413 </li>
414 </ol>
415 </li>
416 <li style="display: none; ">
417 <a>Events</a>
418 <ol>
419 <li>
420 <a href="#event-anchor">eventName</a>
421 </li>
422 </ol>
423 </li>
424 </ol>
425 </li><li>
426 <a href="#type-HttpHeaders">HttpHeaders</a>
427 <ol>
428 <li style="display: none; ">
429 <a>Methods</a>
430 <ol>
431 <li>
432 <a href="#method-anchor">methodName</a>
433 </li>
434 </ol>
435 </li>
436 <li style="display: none; ">
437 <a>Events</a>
438 <ol>
439 <li>
440 <a href="#event-anchor">eventName</a>
441 </li>
442 </ol>
443 </li>
444 </ol>
445 </li><li>
446 <a href="#type-BlockingResponse">BlockingResponse</a>
447 <ol>
448 <li style="display: none; ">
449 <a>Methods</a>
450 <ol>
451 <li>
452 <a href="#method-anchor">methodName</a>
453 </li>
454 </ol>
455 </li>
456 <li style="display: none; ">
457 <a>Events</a>
458 <ol>
459 <li>
460 <a href="#event-anchor">eventName</a>
461 </li>
462 </ol>
463 </li>
464 </ol>
465 </li>
466 </ol>
467 </li>
468 </ol>
469 </li>
470 </ol>
471 </div>
472 <!-- /TABLE OF CONTENTS -->
473
474 <!-- Standard content lead-in for experimental API pages -->
475 <p id="classSummary" style="display: none; ">
476 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
477 </p>
478
479 <!-- STATIC CONTENT PLACEHOLDER -->
480 <div id="static"><div id="pageData-name" class="pageData">WebRequest API </div>
481
482 <!-- BEGIN AUTHORED CONTENT -->
483 <p id="classSummary">
484 Use the <code>chrome.experimental.webRequest</code> module to intercept, block,
485 or modify requests in-flight. This module is still experimental. For
486 information on how to use experimental APIs, see the
487 <a href="experimental.html">chrome.experimental.* APIs</a> page.
488 </p>
489
490 <h2 id="manifest">Manifest</h2>
491 <p>You must declare the "experimental" permission in the <a href="manifest.html" >extension manifest</a> to use the webRequest settings
492 API, along with <a href="manifest.html#permissions">host permissions</a>
493 for any hosts whose network requests you want to access.
494 For example:</p>
495 <pre>{
496 "name": "My extension",
497 ...
498 <b>"permissions": [
499 "experimental",
500 "*://*.google.com"
501 ]</b>,
502 ...
503 }</pre>
504
505 <h2 id="life_cycle">Life-cycle of requests</h2>
506
507 <p>
508 The webRequest API defines the following events:
509 </p><dl>
510 <dt><code>onBeforeRequest (optionally synchronous)</code></dt>
511 <dd>Fires when a request is about to occur. This is sent before any TCP
512 connection is made and can be used to cancel or redirect requests.</dd>
513 <dt><code>onBeforeSendHeaders (optionally synchronous)</code></dt>
514 <dd>Fires when a request is about to occur and the initial headers are
515 prepared. The event is intended to allow extensions to add, modify and delete
516 request headers <a href="#life_cycle_footnote">(*)</a>. The
517 <code>onBeforeSendHeaders</code> event is passed to all subscribers, so
518 different subscribers may attempt to modify the request, see section <a href=" #conflict_resolution">conflict resolution</a> for details how this is
519 handled. This event can still be used to cancel the request.</dd>
520 <dt><code>onSendHeaders</code></dt>
521 <dd>Fires after all extensions had a chance of modifying the request headers
522 and presents the final <a href="#life_cycle_footnote">(*)</a> version. The
523 event is triggered, before the headers are sent to the network. This event is
524 informational and handled asynchronously. It does not allow to modify or
525 cancel the request.</dd>
526 <dt><code>onHeadersReceived (optionally synchronous)</code></dt>
527 <dd>Fires each time when a HTTP(S) response header has been received. Due
528 to redirects and authentication requests this can happen multiple times per
529 request. This event is intended to allow extensions to add, modify and delete
530 response headers, like incoming Set-Cookie headers for example.</dd>
531 <dt><code>onAuthRequired (optionally synchronous)</code></dt>
532 <dd>Fires when a request requires authentication of the user. This signal can
533 be handled synchronously to provide authentication credentials. Note that
534 extensions may provide invalid credentials. Take care not to enter an infinite
535 loop by repeatedly providing invalid credentials.</dd>
536 <dt><code>onBeforeRedirect</code></dt>
537 <dd>Fires before a redirect is about to be executed. A redirection can be
538 triggered by a HTTP response code or by an extension. This event is
539 informational and handled asynchronously. It does not allow you to modify or
540 cancel the request. </dd>
541 <dt><code>onResponseStarted</code></dt>
542 <dd>Fires when the first byte of the response body is received. For HTTP
543 requests, this means that the status line and response headers are
544 available. This event is informational and handled asynchronously. It does not
545 allow to modify or cancel the request.</dd>
546 <dt><code>onCompleted</code></dt>
547 <dd>Fires when a request has been processed successfully.</dd>
548 <dt><code>onErrorOccurred</code></dt>
549 <dd>Fires when a request could not be processed successfully.</dd>
550 </dl>
551 The webRequest API gurantees that for each request either
552 <code>onComplete</code> or <code>onErrorOccurred</code> is fired as the final
553 event.
554 <p></p>
555
556 <p>
557 The life-cycle of successful requests can be illustrated as follows:
558 </p><pre> |
559 v
560 onBeforeRequest --------------------------------
561 | ^ | | [data and file URLs]
562 | | | [redirection |
563 | ---------- | from extension] |
564 v | | |
565 onBeforeSendHeaders | | |
566 | ^ | | |
567 v | | | |
568 onSendHeaders | | | |
569 | | | | |
570 v | | | |
571 onHeadersReceived | | | |
572 | | | | | | |
573 | | v | | | |
574 | | onAuthRequired / | |
575 | v / | |
576 | onBeforeRedirect &lt;---- |
577 v |
578 onResponseStarted &lt;-----------------------------
579 |
580 v
581 onCompleted
582 </pre>
583 <em>Note that this diagram does not capture a bug that will be fixed soon: If
584 extensions redirect a URL request via the webRequest API, this redirection does
585 not trigger <code>onBeforeRedirect</code>. Instead the request is cancelled
586 and a new request is started at <code>onBeforeRedirect</code>. See <a href="http ://crbug.com/79520">http://crbug.com/79520</a>.</em>
587 <p></p>
588
589 <p id="life_cycle_footnote">(*) Note that the webRequest API presents an
590 abstraction of the network stack to the extension. Internally, one URL request
591 can be split into several HTTP requests (for example to fetch individual byte
592 ranges from a large file) or can be handled by the network stack without
593 communicating with the network. For this reason, the API does not provide the
594 final HTTP headers that are sent to the network. For example all headers that
595 are related to caching are invisible to the extension.</p>
596
597 <p>This is a list of headers that are currently not provided to the
598 onBeforeSendHeaders signal. The list is not guaranteed to be complete nor
599 stable:
600 </p><ul>
601 <li>Authorization</li>
602 <li>Cache-Control</li>
603 <li>Connection</li>
604 <li>Content-Length</li>
605 <li>Host</li>
606 <li>If-Modified-Since</li>
607 <li>If-None-Match</li>
608 <li>If-Range</li>
609 <li>Partial-Data</li>
610 <li>Pragma</li>
611 <li>Proxy-Authorization</li>
612 <li>Proxy-Connection</li>
613 <li>Transfer-Encoding</li>
614 </ul>
615 <p></p>
616
617 <h2 id="concepts">Concepts of the webRequest API</h2>
618
619 <p>The signals of the webRequest API follow certain concepts and patterns that
620 shall be described in the following.</p>
621
622 <h3 id="Request IDs">Request IDs</h3>
623
624 <p>Each request is identified by a request ID. This ID is unique within a
625 browser session and the context of an extension. It remains constant during the
626 the life-cycle of a request and can be used to match signals for the same
627 request. Note that several HTTP requests are mapped to one webRequest in case of
628 HTTP redirection or HTTP authentication.</p>
629
630 <h3 id="subscription">Subscription</h3>
631
632 <p>For each signal XXX of the webRequest API, the API provides a function
633 <code>chrome.experimental.webRequest.XXX.addListener()</code> with the following
634 signature.</p>
635
636 <pre>var callback = function(details) {...};
637 var opt_filter = {...};
638 var opt_extraInfoSpec = [...];
639
640 chrome.experimental.webRequest.XXX.addListener(
641 callback, opt_filter, opt_extraInfoSpec);
642 </pre>
643
644 <p>Each <code>addListener()</code> call takes a mandatory callback function as
645 the first parameter. This callback function is passed a dictionary containing
646 information about the current URL request. The information in this dictionary
647 depends on the specific event type as well as the content of
648 <code>opt_extraInfoSpec</code>.</p>
649
650 <p>If the optional <code>opt_extraInfoSpec</code> array contains the string
651 <code>'blocking'</code> (only allowed for specific signals), the callback
652 function is handled synchronously. That means that the request is blocked until
653 the callback function returns. In this case, the callback can return a <a href=" #type-BlockingResponse">BlockingResponse</a> that determines the further
654 life-cycle of the request. Depending on the context, this response allows
655 cancelling or redirecting a request (onBeforeRequest), cancelling or
656 modifying headers (onBeforeSendHeaders, onHeadersReceived), or providing
657 authentication credentials (onAuthRequired).</p>
658
659 <p>Depending on the specific signal, <code>opt_extraInfoSpec</code> may contain
660 further strings that indicate that specific information shall be passed to the
661 extension. This is used to provide detailed information on requests data only if
662 explicitly requested.</p>
663
664 <p>The optional <a href="#type-RequestFilter">RequestFilter</a>
665 <code>opt_filter</code> allows to limit the requests for which events are
666 triggered in various dimensions:
667 </p><dl>
668 <dt>URLs</dt>
669 <dd>URL patterns like <code>*://www.google.com/foo*bar</code>.</dd>
670 <dt>Types</dt>
671 <dd>Request types like <code>main_frame</code> (a document that is loaded for
672 a top-level frame), <code>sub_frame</code> (a document that is loaded for an
673 embedded frame), <code>image</code> (an image on a web site) and others. See
674 <a href="#type-RequestFilter">RequestFilter</a>.</dd>
675 <dt>Tab IDs</dt>
676 <dd>The ID that identifies a specific tab in a window.</dd>
677 <dt>Window IDs</dt>
678 <dd>The ID that identifies a specific window.</dd>
679 <p></p>
680
681 <h2 id="conflict_resolution">Conflict resolution</h2>
682
683 <p>In the current implementation of the webRequest API, a request is considered
684 as canceled if at least one extension instructs to cancel the request. If
685 an extension cancels a request, all extensions are notified by an
686 onErrorOccurred event. Only one extension is allowed to redirect a request or
687 modify a header at a time. If more than one extension attempts to modify the
688 request, the most recently installed extension wins while all others are
689 ignored. An extension is currently not notified, if its instruction to modify or
690 redirect has been ignored.</p>
691
692 <a name="H2-6"></a><h2>A note about caching</h2>
693 <p>
694 Chrome employs two caches, an on-disk cache and a very fast in-memory cache.
695 The life-time of an in-memory cache is attached to the life-time of a render
696 process which roughly corresponds to a tab. Requests that are answered from the
697 in-memory cache are invisible to the webRequest API. If a request handler
698 changes its behavior (for example the behavior according to which requests are
699 blocked), a simple page refresh might not respect this changed behavior.
700 <code>chrome.experimental.webRequest.handlerBehaviorChanged()</code> needs to be
701 called to flush the in-memory cache. This is a very expensive operation and
702 should not be done often.
703 </p>
704
705 <a name="H2-7"></a><h2>A note about timestamps</h2>
706 <p>
707 It's important to note that some technical oddities in the OS's handling
708 of distinct Chrome processes can cause the clock to be skewed between the
709 browser itself and extension processes. That means that WebRequest's events'
710 <code>timeStamp</code> property is only guaranteed to be <i>internally</i>
711 consistent. Comparing one event to another event will give you the correct
712 offset between them, but comparing them to the current time inside the
713 extension (via <code>(new Date()).getTime()</code>, for instance) might give
714 unexpected results.
715 </p>
716
717 <h2 id="examples">Examples</h2>
718
719 <p>The following example illustrates how to block all requests to
720 <code>www.evil.com</code>:</p>
721 <pre>chrome.experimental.webRequest.onBeforeRequest.addListener(
722 function(details) {
723 return {cancel: details.url.indexOf("://www.evil.com/") != -1};
724 },
725 {},
726 ["blocking"]);
727 </pre>
728
729 <p>The following example achives the same goal in a more efficient way because
730 requests that are not targeted to <code>www.evil.com</code> do not need to be
731 passed to the extension:</p>
732 <pre>chrome.experimental.webRequest.onBeforeRequest.addListener(
733 function(details) { return {cancel: true}; },
734 {urls: ["*://www.evil.com/*"]},
735 ["blocking"]);
736 </pre>
737
738 <p>The following example illustrates how the User-Agent header can be deleted
739 from all requests:</p>
740 <pre>chrome.experimental.webRequest.onBeforeSendHeaders.addListener(
741 function(details) {
742 delete details.requestHeaders['User-Agent'];
743 return {requestHeaders: details.requestHeaders};
744 },
745 {},
746 ["blocking"]);
747 </pre>
748
749 <!--
750 TODO(mkwst): update this section. We do not pass windowIds any more.
751 http://crbug.com/98937
752
753 <h3 id="tracking_frames">Tracking frames</h3>
754 <p>For efficiency reason, the webRequest API does not pass the URL of the frame
755 that issued a request to each request. If this information is required, for
756 example to distinguish between first and third party requests, this example
757 shows how to track the URLs of frames.</p>
758 <pre>
759 // dictionary "windowId" -> "tabId"-"frameId" -> "frameUrl"
760 var frameUrl = {};
761
762 function recordFrameUrl(windowId, tabId, frameId, frameUrl) {
763 if (!frameUrl[windowId]) {
764 frameUrl[windowId] = {};
765 }
766 frameUrl[windowId][tabId + "-" + frameId] = frameUrl;
767 }
768
769 function getFrameUrl(windowId, tabId, frameId, frameUrl) {
770 return (frameUrl[windowId] || {})[tabId + "-" + frameId];
771 }
772
773 chrome.experimental.webRequest.onBeforeRequest.addListener(
774 function(d) {
775 if (d.type == 'main_frame' || d.type == 'sub_frame') {
776 recordFrameUrl(d.windowId, d.tabId, d.frameId, d.frameUrl);
777 }
778 var frameUrl = getFrameUrl(d.windowId, d.tabId, d.frameId);
779 // Use the frameUrl e.g. to selectively cancel requests.
780 // Attention: The frameUrl can be undefined in some cases. Requests may not
781 // originate from a frame (e.g. requests from extensions or shared workers).
782 });
783
784 chrome.windows.onRemoved.addListener(
785 function(windowId) {delete frameUrl[windowId];}
786 );
787 </pre>
788 -->
789 <!-- END AUTHORED CONTENT -->
790 </dl></div>
791
792 <!-- API PAGE -->
793 <div class="apiPage">
794 <a name="apiReference"></a>
795 <h2>API reference: chrome.experimental.webRequest</h2>
796
797 <!-- PROPERTIES -->
798 <div class="apiGroup" style="display: none; ">
799 <a name="properties"></a>
800 <h3 id="properties">Properties</h3>
801
802 <div>
803 <a></a>
804 <h4>getLastError</h4>
805 <div class="summary">
806 <!-- Note: intentionally longer 80 columns -->
807 <span>chrome.extension</span><span>lastError</span>
808 </div>
809 <div>
810 </div>
811 </div>
812
813 </div> <!-- /apiGroup -->
814
815 <!-- METHODS -->
816 <div id="methodsTemplate" class="apiGroup">
817 <a name="global-methods"></a>
818 <h3>Methods</h3>
819
820 <!-- iterates over all functions -->
821 <div class="apiItem" style="display: none; ">
822 <a></a> <!-- method-anchor -->
823 <h4>method name</h4>
824
825 <div class="summary"><span>void</span>
826 <!-- Note: intentionally longer 80 columns -->
827 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
828 <var><span></span></var></span>)</div>
829
830 <div class="description">
831 <p class="todo">Undocumented.</p>
832 <p>
833 A description from the json schema def of the function goes he re.
834 </p>
835
836 <!-- PARAMETERS -->
837 <h4>Parameters</h4>
838 <dl>
839 <div>
840 <div>
841 </div>
842 </div>
843 </dl>
844
845 <!-- RETURNS -->
846 <h4>Returns</h4>
847 <dl>
848 <div>
849 <div>
850 </div>
851 </div>
852 </dl>
853
854 <!-- CALLBACK -->
855 <div>
856 <div>
857 <h4>Callback function</h4>
858 <p>
859 The callback <em>parameter</em> should specify a function
860 that looks like this:
861 </p>
862 <p>
863 If you specify the <em>callback</em> parameter, it should
864 specify a function that looks like this:
865 </p>
866
867 <!-- Note: intentionally longer 80 columns -->
868 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
869 <dl>
870 <div>
871 <div>
872 </div>
873 </div>
874 </dl>
875 </div>
876 </div>
877
878 <!-- MIN_VERSION -->
879 <p>
880 This function was added in version <b><span></span></b>.
881 If you require this function, the manifest key
882 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
883 can ensure that your extension won't be run in an earlier brow ser version.
884 </p>
885 </div> <!-- /description -->
886
887 </div><div class="apiItem" style="display: none; ">
888 <a></a> <!-- method-anchor -->
889 <h4>method name</h4>
890
891 <div class="summary"><span>void</span>
892 <!-- Note: intentionally longer 80 columns -->
893 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
894 <var><span></span></var></span>)</div>
895
896 <div class="description">
897 <p class="todo">Undocumented.</p>
898 <p>
899 A description from the json schema def of the function goes he re.
900 </p>
901
902 <!-- PARAMETERS -->
903 <h4>Parameters</h4>
904 <dl>
905 <div>
906 <div>
907 </div>
908 </div>
909 </dl>
910
911 <!-- RETURNS -->
912 <h4>Returns</h4>
913 <dl>
914 <div>
915 <div>
916 </div>
917 </div>
918 </dl>
919
920 <!-- CALLBACK -->
921 <div>
922 <div>
923 <h4>Callback function</h4>
924 <p>
925 The callback <em>parameter</em> should specify a function
926 that looks like this:
927 </p>
928 <p>
929 If you specify the <em>callback</em> parameter, it should
930 specify a function that looks like this:
931 </p>
932
933 <!-- Note: intentionally longer 80 columns -->
934 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
935 <dl>
936 <div>
937 <div>
938 </div>
939 </div>
940 </dl>
941 </div>
942 </div>
943
944 <!-- MIN_VERSION -->
945 <p>
946 This function was added in version <b><span></span></b>.
947 If you require this function, the manifest key
948 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
949 can ensure that your extension won't be run in an earlier brow ser version.
950 </p>
951 </div> <!-- /description -->
952
953 </div><div class="apiItem">
954 <a name="method-handlerBehaviorChanged"></a> <!-- method-anchor -- >
955 <h4>handlerBehaviorChanged</h4>
956
957 <div class="summary"><span style="display: none; ">void</span>
958 <!-- Note: intentionally longer 80 columns -->
959 <span>chrome.experimental.webRequest.handlerBehaviorChanged</s pan>(<span class="optional"><span style="display: none; ">, </span><span>functio n</span>
960 <var><span>callback</span></var></span>)</div>
961
962 <div class="description">
963 <p class="todo" style="display: none; ">Undocumented.</p>
964 <p>Needs to be called when the behavior of the webRequest handle rs has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.</p>
965
966 <!-- PARAMETERS -->
967 <h4>Parameters</h4>
968 <dl>
969 <div>
970 <div>
971 <dt>
972 <var>callback</var>
973 <em>
974
975 <!-- TYPE -->
976 <div style="display:inline">
977 (
978 <span class="optional">optional</span>
979 <span class="enum" style="display: none; ">enumerated</span>
980 <span id="typeTemplate">
981 <span style="display: none; ">
982 <a> Type</a>
983 </span>
984 <span>
985 <span style="display: none; ">
986 array of <span><span></span></span>
987 </span>
988 <span>function</span>
989 <span style="display: none; "></span>
990 </span>
991 </span>
992 )
993 </div>
994
995 </em>
996 </dt>
997 <dd class="todo">
998 Undocumented.
999 </dd>
1000 <dd style="display: none; ">
1001 Description of this parameter from the json schema.
1002 </dd>
1003 <dd style="display: none; ">
1004 This parameter was added in version
1005 <b><span></span></b>.
1006 You must omit this parameter in earlier versions,
1007 and you may omit it in any version. If you require this
1008 parameter, the manifest key
1009 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1010 can ensure that your extension won't be run in an earlier browser ve rsion.
1011 </dd>
1012
1013 <!-- OBJECT PROPERTIES -->
1014 <dd style="display: none; ">
1015 <dl>
1016 <div>
1017 <div>
1018 </div>
1019 </div>
1020 </dl>
1021 </dd>
1022
1023 <!-- OBJECT METHODS -->
1024 <dd style="display: none; ">
1025 <div></div>
1026 </dd>
1027
1028 <!-- OBJECT EVENT FIELDS -->
1029 <dd style="display: none; ">
1030 <div></div>
1031 </dd>
1032
1033 <!-- FUNCTION PARAMETERS -->
1034 <dd style="display: none; ">
1035 <div></div>
1036 </dd>
1037
1038 </div>
1039 </div>
1040 </dl>
1041
1042 <!-- RETURNS -->
1043 <h4 style="display: none; ">Returns</h4>
1044 <dl>
1045 <div style="display: none; ">
1046 <div>
1047 </div>
1048 </div>
1049 </dl>
1050
1051 <!-- CALLBACK -->
1052 <div>
1053 <div>
1054 <h4>Callback function</h4>
1055 <p style="display: none; ">
1056 The callback <em>parameter</em> should specify a function
1057 that looks like this:
1058 </p>
1059 <p>
1060 If you specify the <em>callback</em> parameter, it should
1061 specify a function that looks like this:
1062 </p>
1063
1064 <!-- Note: intentionally longer 80 columns -->
1065 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1066 <dl>
1067 <div style="display: none; ">
1068 <div>
1069 </div>
1070 </div>
1071 </dl>
1072 </div>
1073 </div>
1074
1075 <!-- MIN_VERSION -->
1076 <p style="display: none; ">
1077 This function was added in version <b><span></span></b>.
1078 If you require this function, the manifest key
1079 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1080 can ensure that your extension won't be run in an earlier brow ser version.
1081 </p>
1082 </div> <!-- /description -->
1083
1084 </div> <!-- /apiItem -->
1085
1086 </div> <!-- /apiGroup -->
1087
1088 <!-- EVENTS -->
1089 <div id="eventsTemplate" class="apiGroup">
1090 <a name="global-events"></a>
1091 <h3>Events</h3>
1092 <!-- iterates over all events -->
1093 <div class="apiItem">
1094 <a name="event-onAuthRequired"></a>
1095 <h4>onAuthRequired</h4>
1096
1097 <div class="summary">
1098 <!-- Note: intentionally longer 80 columns -->
1099 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onAuthRequired</span><span class="subdued">.addListener</span>(function(<span> object details, function callback</span>) <span class="subdued">{...}</span><spa n>, RequestFilter filter, array of string extraInfoSpec</span>);
1100 </div>
1101
1102 <div class="description">
1103 <p class="todo" style="display: none; ">Undocumented.</p>
1104 <p>Fired when an authentication failure was received. The listen er has three options: it can provide authentication credentials, it can cancel t he request and display the error page, or it can take no action on the challenge . If bad user credentials are provided, this may be called multiple times for th e same request.</p>
1105
1106 <!-- LISTENER PARAMETERS -->
1107 <div>
1108 <h4>Listener parameters</h4>
1109 <dl>
1110 <div>
1111 <div>
1112 <dt>
1113 <var>details</var>
1114 <em>
1115
1116 <!-- TYPE -->
1117 <div style="display:inline">
1118 (
1119 <span class="optional" style="display: none; ">optional</spa n>
1120 <span class="enum" style="display: none; ">enumerated</span>
1121 <span id="typeTemplate">
1122 <span style="display: none; ">
1123 <a> Type</a>
1124 </span>
1125 <span>
1126 <span style="display: none; ">
1127 array of <span><span></span></span>
1128 </span>
1129 <span>object</span>
1130 <span style="display: none; "></span>
1131 </span>
1132 </span>
1133 )
1134 </div>
1135
1136 </em>
1137 </dt>
1138 <dd class="todo">
1139 Undocumented.
1140 </dd>
1141 <dd style="display: none; ">
1142 Description of this parameter from the json schema.
1143 </dd>
1144 <dd style="display: none; ">
1145 This parameter was added in version
1146 <b><span></span></b>.
1147 You must omit this parameter in earlier versions,
1148 and you may omit it in any version. If you require this
1149 parameter, the manifest key
1150 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1151 can ensure that your extension won't be run in an earlier browser ve rsion.
1152 </dd>
1153
1154 <!-- OBJECT PROPERTIES -->
1155 <dd>
1156 <dl>
1157 <div>
1158 <div>
1159 <dt>
1160 <var>requestId</var>
1161 <em>
1162
1163 <!-- TYPE -->
1164 <div style="display:inline">
1165 (
1166 <span class="optional" style="display: none; ">optional</spa n>
1167 <span class="enum" style="display: none; ">enumerated</span>
1168 <span id="typeTemplate">
1169 <span style="display: none; ">
1170 <a> Type</a>
1171 </span>
1172 <span>
1173 <span style="display: none; ">
1174 array of <span><span></span></span>
1175 </span>
1176 <span>string</span>
1177 <span style="display: none; "></span>
1178 </span>
1179 </span>
1180 )
1181 </div>
1182
1183 </em>
1184 </dt>
1185 <dd class="todo" style="display: none; ">
1186 Undocumented.
1187 </dd>
1188 <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>
1189 <dd style="display: none; ">
1190 This parameter was added in version
1191 <b><span></span></b>.
1192 You must omit this parameter in earlier versions,
1193 and you may omit it in any version. If you require this
1194 parameter, the manifest key
1195 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1196 can ensure that your extension won't be run in an earlier browser ve rsion.
1197 </dd>
1198
1199 <!-- OBJECT PROPERTIES -->
1200 <dd style="display: none; ">
1201 <dl>
1202 <div>
1203 <div>
1204 </div>
1205 </div>
1206 </dl>
1207 </dd>
1208
1209 <!-- OBJECT METHODS -->
1210 <dd style="display: none; ">
1211 <div></div>
1212 </dd>
1213
1214 <!-- OBJECT EVENT FIELDS -->
1215 <dd style="display: none; ">
1216 <div></div>
1217 </dd>
1218
1219 <!-- FUNCTION PARAMETERS -->
1220 <dd style="display: none; ">
1221 <div></div>
1222 </dd>
1223
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">
1254 Undocumented.
1255 </dd>
1256 <dd style="display: none; ">
1257 Description of this parameter from the json schema.
1258 </dd>
1259 <dd style="display: none; ">
1260 This parameter was added in version
1261 <b><span></span></b>.
1262 You must omit this parameter in earlier versions,
1263 and you may omit it in any version. If you require this
1264 parameter, the manifest key
1265 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1266 can ensure that your extension won't be run in an earlier browser ve rsion.
1267 </dd>
1268
1269 <!-- OBJECT PROPERTIES -->
1270 <dd style="display: none; ">
1271 <dl>
1272 <div>
1273 <div>
1274 </div>
1275 </div>
1276 </dl>
1277 </dd>
1278
1279 <!-- OBJECT METHODS -->
1280 <dd style="display: none; ">
1281 <div></div>
1282 </dd>
1283
1284 <!-- OBJECT EVENT FIELDS -->
1285 <dd style="display: none; ">
1286 <div></div>
1287 </dd>
1288
1289 <!-- FUNCTION PARAMETERS -->
1290 <dd style="display: none; ">
1291 <div></div>
1292 </dd>
1293
1294 </div>
1295 </div><div>
1296 <div>
1297 <dt>
1298 <var>method</var>
1299 <em>
1300
1301 <!-- TYPE -->
1302 <div style="display:inline">
1303 (
1304 <span class="optional" style="display: none; ">optional</spa n>
1305 <span class="enum" style="display: none; ">enumerated</span>
1306 <span id="typeTemplate">
1307 <span style="display: none; ">
1308 <a> Type</a>
1309 </span>
1310 <span>
1311 <span style="display: none; ">
1312 array of <span><span></span></span>
1313 </span>
1314 <span>string</span>
1315 <span style="display: none; "></span>
1316 </span>
1317 </span>
1318 )
1319 </div>
1320
1321 </em>
1322 </dt>
1323 <dd class="todo" style="display: none; ">
1324 Undocumented.
1325 </dd>
1326 <dd>Standard HTTP method.</dd>
1327 <dd style="display: none; ">
1328 This parameter was added in version
1329 <b><span></span></b>.
1330 You must omit this parameter in earlier versions,
1331 and you may omit it in any version. If you require this
1332 parameter, the manifest key
1333 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1334 can ensure that your extension won't be run in an earlier browser ve rsion.
1335 </dd>
1336
1337 <!-- OBJECT PROPERTIES -->
1338 <dd style="display: none; ">
1339 <dl>
1340 <div>
1341 <div>
1342 </div>
1343 </div>
1344 </dl>
1345 </dd>
1346
1347 <!-- OBJECT METHODS -->
1348 <dd style="display: none; ">
1349 <div></div>
1350 </dd>
1351
1352 <!-- OBJECT EVENT FIELDS -->
1353 <dd style="display: none; ">
1354 <div></div>
1355 </dd>
1356
1357 <!-- FUNCTION PARAMETERS -->
1358 <dd style="display: none; ">
1359 <div></div>
1360 </dd>
1361
1362 </div>
1363 </div><div>
1364 <div>
1365 <dt>
1366 <var>frameId</var>
1367 <em>
1368
1369 <!-- TYPE -->
1370 <div style="display:inline">
1371 (
1372 <span class="optional" style="display: none; ">optional</spa n>
1373 <span class="enum" style="display: none; ">enumerated</span>
1374 <span id="typeTemplate">
1375 <span style="display: none; ">
1376 <a> Type</a>
1377 </span>
1378 <span>
1379 <span style="display: none; ">
1380 array of <span><span></span></span>
1381 </span>
1382 <span>integer</span>
1383 <span style="display: none; "></span>
1384 </span>
1385 </span>
1386 )
1387 </div>
1388
1389 </em>
1390 </dt>
1391 <dd class="todo" style="display: none; ">
1392 Undocumented.
1393 </dd>
1394 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
1395 <dd style="display: none; ">
1396 This parameter was added in version
1397 <b><span></span></b>.
1398 You must omit this parameter in earlier versions,
1399 and you may omit it in any version. If you require this
1400 parameter, the manifest key
1401 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1402 can ensure that your extension won't be run in an earlier browser ve rsion.
1403 </dd>
1404
1405 <!-- OBJECT PROPERTIES -->
1406 <dd style="display: none; ">
1407 <dl>
1408 <div>
1409 <div>
1410 </div>
1411 </div>
1412 </dl>
1413 </dd>
1414
1415 <!-- OBJECT METHODS -->
1416 <dd style="display: none; ">
1417 <div></div>
1418 </dd>
1419
1420 <!-- OBJECT EVENT FIELDS -->
1421 <dd style="display: none; ">
1422 <div></div>
1423 </dd>
1424
1425 <!-- FUNCTION PARAMETERS -->
1426 <dd style="display: none; ">
1427 <div></div>
1428 </dd>
1429
1430 </div>
1431 </div><div>
1432 <div>
1433 <dt>
1434 <var>parentFrameId</var>
1435 <em>
1436
1437 <!-- TYPE -->
1438 <div style="display:inline">
1439 (
1440 <span class="optional" style="display: none; ">optional</spa n>
1441 <span class="enum" style="display: none; ">enumerated</span>
1442 <span id="typeTemplate">
1443 <span style="display: none; ">
1444 <a> Type</a>
1445 </span>
1446 <span>
1447 <span style="display: none; ">
1448 array of <span><span></span></span>
1449 </span>
1450 <span>integer</span>
1451 <span style="display: none; "></span>
1452 </span>
1453 </span>
1454 )
1455 </div>
1456
1457 </em>
1458 </dt>
1459 <dd class="todo" style="display: none; ">
1460 Undocumented.
1461 </dd>
1462 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
1463 <dd style="display: none; ">
1464 This parameter was added in version
1465 <b><span></span></b>.
1466 You must omit this parameter in earlier versions,
1467 and you may omit it in any version. If you require this
1468 parameter, the manifest key
1469 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1470 can ensure that your extension won't be run in an earlier browser ve rsion.
1471 </dd>
1472
1473 <!-- OBJECT PROPERTIES -->
1474 <dd style="display: none; ">
1475 <dl>
1476 <div>
1477 <div>
1478 </div>
1479 </div>
1480 </dl>
1481 </dd>
1482
1483 <!-- OBJECT METHODS -->
1484 <dd style="display: none; ">
1485 <div></div>
1486 </dd>
1487
1488 <!-- OBJECT EVENT FIELDS -->
1489 <dd style="display: none; ">
1490 <div></div>
1491 </dd>
1492
1493 <!-- FUNCTION PARAMETERS -->
1494 <dd style="display: none; ">
1495 <div></div>
1496 </dd>
1497
1498 </div>
1499 </div><div>
1500 <div>
1501 <dt>
1502 <var>tabId</var>
1503 <em>
1504
1505 <!-- TYPE -->
1506 <div style="display:inline">
1507 (
1508 <span class="optional" style="display: none; ">optional</spa n>
1509 <span class="enum" style="display: none; ">enumerated</span>
1510 <span id="typeTemplate">
1511 <span style="display: none; ">
1512 <a> Type</a>
1513 </span>
1514 <span>
1515 <span style="display: none; ">
1516 array of <span><span></span></span>
1517 </span>
1518 <span>integer</span>
1519 <span style="display: none; "></span>
1520 </span>
1521 </span>
1522 )
1523 </div>
1524
1525 </em>
1526 </dt>
1527 <dd class="todo" style="display: none; ">
1528 Undocumented.
1529 </dd>
1530 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
1531 <dd style="display: none; ">
1532 This parameter was added in version
1533 <b><span></span></b>.
1534 You must omit this parameter in earlier versions,
1535 and you may omit it in any version. If you require this
1536 parameter, the manifest key
1537 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1538 can ensure that your extension won't be run in an earlier browser ve rsion.
1539 </dd>
1540
1541 <!-- OBJECT PROPERTIES -->
1542 <dd style="display: none; ">
1543 <dl>
1544 <div>
1545 <div>
1546 </div>
1547 </div>
1548 </dl>
1549 </dd>
1550
1551 <!-- OBJECT METHODS -->
1552 <dd style="display: none; ">
1553 <div></div>
1554 </dd>
1555
1556 <!-- OBJECT EVENT FIELDS -->
1557 <dd style="display: none; ">
1558 <div></div>
1559 </dd>
1560
1561 <!-- FUNCTION PARAMETERS -->
1562 <dd style="display: none; ">
1563 <div></div>
1564 </dd>
1565
1566 </div>
1567 </div><div>
1568 <div>
1569 <dt>
1570 <var>type</var>
1571 <em>
1572
1573 <!-- TYPE -->
1574 <div style="display:inline">
1575 (
1576 <span class="optional" style="display: none; ">optional</spa n>
1577 <span class="enum">enumerated</span>
1578 <span id="typeTemplate">
1579 <span style="display: none; ">
1580 <a> Type</a>
1581 </span>
1582 <span>
1583 <span style="display: none; ">
1584 array of <span><span></span></span>
1585 </span>
1586 <span>string</span>
1587 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
1588 </span>
1589 </span>
1590 )
1591 </div>
1592
1593 </em>
1594 </dt>
1595 <dd class="todo" style="display: none; ">
1596 Undocumented.
1597 </dd>
1598 <dd>How the requested resource will be used.</dd>
1599 <dd style="display: none; ">
1600 This parameter was added in version
1601 <b><span></span></b>.
1602 You must omit this parameter in earlier versions,
1603 and you may omit it in any version. If you require this
1604 parameter, the manifest key
1605 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1606 can ensure that your extension won't be run in an earlier browser ve rsion.
1607 </dd>
1608
1609 <!-- OBJECT PROPERTIES -->
1610 <dd style="display: none; ">
1611 <dl>
1612 <div>
1613 <div>
1614 </div>
1615 </div>
1616 </dl>
1617 </dd>
1618
1619 <!-- OBJECT METHODS -->
1620 <dd style="display: none; ">
1621 <div></div>
1622 </dd>
1623
1624 <!-- OBJECT EVENT FIELDS -->
1625 <dd style="display: none; ">
1626 <div></div>
1627 </dd>
1628
1629 <!-- FUNCTION PARAMETERS -->
1630 <dd style="display: none; ">
1631 <div></div>
1632 </dd>
1633
1634 </div>
1635 </div><div>
1636 <div>
1637 <dt>
1638 <var>timeStamp</var>
1639 <em>
1640
1641 <!-- TYPE -->
1642 <div style="display:inline">
1643 (
1644 <span class="optional" style="display: none; ">optional</spa n>
1645 <span class="enum" style="display: none; ">enumerated</span>
1646 <span id="typeTemplate">
1647 <span style="display: none; ">
1648 <a> Type</a>
1649 </span>
1650 <span>
1651 <span style="display: none; ">
1652 array of <span><span></span></span>
1653 </span>
1654 <span>number</span>
1655 <span style="display: none; "></span>
1656 </span>
1657 </span>
1658 )
1659 </div>
1660
1661 </em>
1662 </dt>
1663 <dd class="todo" style="display: none; ">
1664 Undocumented.
1665 </dd>
1666 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
1667 <dd style="display: none; ">
1668 This parameter was added in version
1669 <b><span></span></b>.
1670 You must omit this parameter in earlier versions,
1671 and you may omit it in any version. If you require this
1672 parameter, the manifest key
1673 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1674 can ensure that your extension won't be run in an earlier browser ve rsion.
1675 </dd>
1676
1677 <!-- OBJECT PROPERTIES -->
1678 <dd style="display: none; ">
1679 <dl>
1680 <div>
1681 <div>
1682 </div>
1683 </div>
1684 </dl>
1685 </dd>
1686
1687 <!-- OBJECT METHODS -->
1688 <dd style="display: none; ">
1689 <div></div>
1690 </dd>
1691
1692 <!-- OBJECT EVENT FIELDS -->
1693 <dd style="display: none; ">
1694 <div></div>
1695 </dd>
1696
1697 <!-- FUNCTION PARAMETERS -->
1698 <dd style="display: none; ">
1699 <div></div>
1700 </dd>
1701
1702 </div>
1703 </div><div>
1704 <div>
1705 <dt>
1706 <var>scheme</var>
1707 <em>
1708
1709 <!-- TYPE -->
1710 <div style="display:inline">
1711 (
1712 <span class="optional" style="display: none; ">optional</spa n>
1713 <span class="enum" style="display: none; ">enumerated</span>
1714 <span id="typeTemplate">
1715 <span style="display: none; ">
1716 <a> Type</a>
1717 </span>
1718 <span>
1719 <span style="display: none; ">
1720 array of <span><span></span></span>
1721 </span>
1722 <span>string</span>
1723 <span style="display: none; "></span>
1724 </span>
1725 </span>
1726 )
1727 </div>
1728
1729 </em>
1730 </dt>
1731 <dd class="todo" style="display: none; ">
1732 Undocumented.
1733 </dd>
1734 <dd>The authentication scheme, e.g. Basic or Digest.</dd>
1735 <dd style="display: none; ">
1736 This parameter was added in version
1737 <b><span></span></b>.
1738 You must omit this parameter in earlier versions,
1739 and you may omit it in any version. If you require this
1740 parameter, the manifest key
1741 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1742 can ensure that your extension won't be run in an earlier browser ve rsion.
1743 </dd>
1744
1745 <!-- OBJECT PROPERTIES -->
1746 <dd style="display: none; ">
1747 <dl>
1748 <div>
1749 <div>
1750 </div>
1751 </div>
1752 </dl>
1753 </dd>
1754
1755 <!-- OBJECT METHODS -->
1756 <dd style="display: none; ">
1757 <div></div>
1758 </dd>
1759
1760 <!-- OBJECT EVENT FIELDS -->
1761 <dd style="display: none; ">
1762 <div></div>
1763 </dd>
1764
1765 <!-- FUNCTION PARAMETERS -->
1766 <dd style="display: none; ">
1767 <div></div>
1768 </dd>
1769
1770 </div>
1771 </div><div>
1772 <div>
1773 <dt>
1774 <var>realm</var>
1775 <em>
1776
1777 <!-- TYPE -->
1778 <div style="display:inline">
1779 (
1780 <span class="optional">optional</span>
1781 <span class="enum" style="display: none; ">enumerated</span>
1782 <span id="typeTemplate">
1783 <span style="display: none; ">
1784 <a> Type</a>
1785 </span>
1786 <span>
1787 <span style="display: none; ">
1788 array of <span><span></span></span>
1789 </span>
1790 <span>string</span>
1791 <span style="display: none; "></span>
1792 </span>
1793 </span>
1794 )
1795 </div>
1796
1797 </em>
1798 </dt>
1799 <dd class="todo" style="display: none; ">
1800 Undocumented.
1801 </dd>
1802 <dd>The authentication realm provided by the server, if there is one.< /dd>
1803 <dd style="display: none; ">
1804 This parameter was added in version
1805 <b><span></span></b>.
1806 You must omit this parameter in earlier versions,
1807 and you may omit it in any version. If you require this
1808 parameter, the manifest key
1809 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1810 can ensure that your extension won't be run in an earlier browser ve rsion.
1811 </dd>
1812
1813 <!-- OBJECT PROPERTIES -->
1814 <dd style="display: none; ">
1815 <dl>
1816 <div>
1817 <div>
1818 </div>
1819 </div>
1820 </dl>
1821 </dd>
1822
1823 <!-- OBJECT METHODS -->
1824 <dd style="display: none; ">
1825 <div></div>
1826 </dd>
1827
1828 <!-- OBJECT EVENT FIELDS -->
1829 <dd style="display: none; ">
1830 <div></div>
1831 </dd>
1832
1833 <!-- FUNCTION PARAMETERS -->
1834 <dd style="display: none; ">
1835 <div></div>
1836 </dd>
1837
1838 </div>
1839 </div><div>
1840 <div>
1841 <dt>
1842 <var>challenger</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>object</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>The server requesting authentication.</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>
1883 <dl>
1884 <div>
1885 <div>
1886 <dt>
1887 <var>host</var>
1888 <em>
1889
1890 <!-- TYPE -->
1891 <div style="display:inline">
1892 (
1893 <span class="optional" style="display: none; ">optional</spa n>
1894 <span class="enum" style="display: none; ">enumerated</span>
1895 <span id="typeTemplate">
1896 <span style="display: none; ">
1897 <a> Type</a>
1898 </span>
1899 <span>
1900 <span style="display: none; ">
1901 array of <span><span></span></span>
1902 </span>
1903 <span>string</span>
1904 <span style="display: none; "></span>
1905 </span>
1906 </span>
1907 )
1908 </div>
1909
1910 </em>
1911 </dt>
1912 <dd class="todo">
1913 Undocumented.
1914 </dd>
1915 <dd style="display: none; ">
1916 Description of this parameter from the json schema.
1917 </dd>
1918 <dd style="display: none; ">
1919 This parameter was added in version
1920 <b><span></span></b>.
1921 You must omit this parameter in earlier versions,
1922 and you may omit it in any version. If you require this
1923 parameter, the manifest key
1924 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1925 can ensure that your extension won't be run in an earlier browser ve rsion.
1926 </dd>
1927
1928 <!-- OBJECT PROPERTIES -->
1929 <dd style="display: none; ">
1930 <dl>
1931 <div>
1932 <div>
1933 </div>
1934 </div>
1935 </dl>
1936 </dd>
1937
1938 <!-- OBJECT METHODS -->
1939 <dd style="display: none; ">
1940 <div></div>
1941 </dd>
1942
1943 <!-- OBJECT EVENT FIELDS -->
1944 <dd style="display: none; ">
1945 <div></div>
1946 </dd>
1947
1948 <!-- FUNCTION PARAMETERS -->
1949 <dd style="display: none; ">
1950 <div></div>
1951 </dd>
1952
1953 </div>
1954 </div><div>
1955 <div>
1956 <dt>
1957 <var>port</var>
1958 <em>
1959
1960 <!-- TYPE -->
1961 <div style="display:inline">
1962 (
1963 <span class="optional" style="display: none; ">optional</spa n>
1964 <span class="enum" style="display: none; ">enumerated</span>
1965 <span id="typeTemplate">
1966 <span style="display: none; ">
1967 <a> Type</a>
1968 </span>
1969 <span>
1970 <span style="display: none; ">
1971 array of <span><span></span></span>
1972 </span>
1973 <span>integer</span>
1974 <span style="display: none; "></span>
1975 </span>
1976 </span>
1977 )
1978 </div>
1979
1980 </em>
1981 </dt>
1982 <dd class="todo">
1983 Undocumented.
1984 </dd>
1985 <dd style="display: none; ">
1986 Description of this parameter from the json schema.
1987 </dd>
1988 <dd style="display: none; ">
1989 This parameter was added in version
1990 <b><span></span></b>.
1991 You must omit this parameter in earlier versions,
1992 and you may omit it in any version. If you require this
1993 parameter, the manifest key
1994 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1995 can ensure that your extension won't be run in an earlier browser ve rsion.
1996 </dd>
1997
1998 <!-- OBJECT PROPERTIES -->
1999 <dd style="display: none; ">
2000 <dl>
2001 <div>
2002 <div>
2003 </div>
2004 </div>
2005 </dl>
2006 </dd>
2007
2008 <!-- OBJECT METHODS -->
2009 <dd style="display: none; ">
2010 <div></div>
2011 </dd>
2012
2013 <!-- OBJECT EVENT FIELDS -->
2014 <dd style="display: none; ">
2015 <div></div>
2016 </dd>
2017
2018 <!-- FUNCTION PARAMETERS -->
2019 <dd style="display: none; ">
2020 <div></div>
2021 </dd>
2022
2023 </div>
2024 </div>
2025 </dl>
2026 </dd>
2027
2028 <!-- OBJECT METHODS -->
2029 <dd style="display: none; ">
2030 <div></div>
2031 </dd>
2032
2033 <!-- OBJECT EVENT FIELDS -->
2034 <dd style="display: none; ">
2035 <div></div>
2036 </dd>
2037
2038 <!-- FUNCTION PARAMETERS -->
2039 <dd style="display: none; ">
2040 <div></div>
2041 </dd>
2042
2043 </div>
2044 </div><div>
2045 <div>
2046 <dt>
2047 <var>isProxy</var>
2048 <em>
2049
2050 <!-- TYPE -->
2051 <div style="display:inline">
2052 (
2053 <span class="optional" style="display: none; ">optional</spa n>
2054 <span class="enum" style="display: none; ">enumerated</span>
2055 <span id="typeTemplate">
2056 <span style="display: none; ">
2057 <a> Type</a>
2058 </span>
2059 <span>
2060 <span style="display: none; ">
2061 array of <span><span></span></span>
2062 </span>
2063 <span>boolean</span>
2064 <span style="display: none; "></span>
2065 </span>
2066 </span>
2067 )
2068 </div>
2069
2070 </em>
2071 </dt>
2072 <dd class="todo" style="display: none; ">
2073 Undocumented.
2074 </dd>
2075 <dd>True for Proxy-Authenticate, false for WWW-Authenticate.</dd>
2076 <dd style="display: none; ">
2077 This parameter was added in version
2078 <b><span></span></b>.
2079 You must omit this parameter in earlier versions,
2080 and you may omit it in any version. If you require this
2081 parameter, the manifest key
2082 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2083 can ensure that your extension won't be run in an earlier browser ve rsion.
2084 </dd>
2085
2086 <!-- OBJECT PROPERTIES -->
2087 <dd style="display: none; ">
2088 <dl>
2089 <div>
2090 <div>
2091 </div>
2092 </div>
2093 </dl>
2094 </dd>
2095
2096 <!-- OBJECT METHODS -->
2097 <dd style="display: none; ">
2098 <div></div>
2099 </dd>
2100
2101 <!-- OBJECT EVENT FIELDS -->
2102 <dd style="display: none; ">
2103 <div></div>
2104 </dd>
2105
2106 <!-- FUNCTION PARAMETERS -->
2107 <dd style="display: none; ">
2108 <div></div>
2109 </dd>
2110
2111 </div>
2112 </div><div>
2113 <div>
2114 <dt>
2115 <var>responseHeaders</var>
2116 <em>
2117
2118 <!-- TYPE -->
2119 <div style="display:inline">
2120 (
2121 <span class="optional">optional</span>
2122 <span class="enum" style="display: none; ">enumerated</span>
2123 <span id="typeTemplate">
2124 <span>
2125 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
2126 </span>
2127 <span style="display: none; ">
2128 <span>
2129 array of <span><span></span></span>
2130 </span>
2131 <span>paramType</span>
2132 <span></span>
2133 </span>
2134 </span>
2135 )
2136 </div>
2137
2138 </em>
2139 </dt>
2140 <dd class="todo" style="display: none; ">
2141 Undocumented.
2142 </dd>
2143 <dd>The HTTP response headers that were received along with this respo nse.</dd>
2144 <dd style="display: none; ">
2145 This parameter was added in version
2146 <b><span></span></b>.
2147 You must omit this parameter in earlier versions,
2148 and you may omit it in any version. If you require this
2149 parameter, the manifest key
2150 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2151 can ensure that your extension won't be run in an earlier browser ve rsion.
2152 </dd>
2153
2154 <!-- OBJECT PROPERTIES -->
2155 <dd style="display: none; ">
2156 <dl>
2157 <div>
2158 <div>
2159 </div>
2160 </div>
2161 </dl>
2162 </dd>
2163
2164 <!-- OBJECT METHODS -->
2165 <dd style="display: none; ">
2166 <div></div>
2167 </dd>
2168
2169 <!-- OBJECT EVENT FIELDS -->
2170 <dd style="display: none; ">
2171 <div></div>
2172 </dd>
2173
2174 <!-- FUNCTION PARAMETERS -->
2175 <dd style="display: none; ">
2176 <div></div>
2177 </dd>
2178
2179 </div>
2180 </div><div>
2181 <div>
2182 <dt>
2183 <var>statusLine</var>
2184 <em>
2185
2186 <!-- TYPE -->
2187 <div style="display:inline">
2188 (
2189 <span class="optional">optional</span>
2190 <span class="enum" style="display: none; ">enumerated</span>
2191 <span id="typeTemplate">
2192 <span style="display: none; ">
2193 <a> Type</a>
2194 </span>
2195 <span>
2196 <span style="display: none; ">
2197 array of <span><span></span></span>
2198 </span>
2199 <span>string</span>
2200 <span style="display: none; "></span>
2201 </span>
2202 </span>
2203 )
2204 </div>
2205
2206 </em>
2207 </dt>
2208 <dd class="todo" style="display: none; ">
2209 Undocumented.
2210 </dd>
2211 <dd>HTTP status line of the response</dd>
2212 <dd style="display: none; ">
2213 This parameter was added in version
2214 <b><span></span></b>.
2215 You must omit this parameter in earlier versions,
2216 and you may omit it in any version. If you require this
2217 parameter, the manifest key
2218 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2219 can ensure that your extension won't be run in an earlier browser ve rsion.
2220 </dd>
2221
2222 <!-- OBJECT PROPERTIES -->
2223 <dd style="display: none; ">
2224 <dl>
2225 <div>
2226 <div>
2227 </div>
2228 </div>
2229 </dl>
2230 </dd>
2231
2232 <!-- OBJECT METHODS -->
2233 <dd style="display: none; ">
2234 <div></div>
2235 </dd>
2236
2237 <!-- OBJECT EVENT FIELDS -->
2238 <dd style="display: none; ">
2239 <div></div>
2240 </dd>
2241
2242 <!-- FUNCTION PARAMETERS -->
2243 <dd style="display: none; ">
2244 <div></div>
2245 </dd>
2246
2247 </div>
2248 </div>
2249 </dl>
2250 </dd>
2251
2252 <!-- OBJECT METHODS -->
2253 <dd style="display: none; ">
2254 <div></div>
2255 </dd>
2256
2257 <!-- OBJECT EVENT FIELDS -->
2258 <dd style="display: none; ">
2259 <div></div>
2260 </dd>
2261
2262 <!-- FUNCTION PARAMETERS -->
2263 <dd style="display: none; ">
2264 <div></div>
2265 </dd>
2266
2267 </div>
2268 </div><div>
2269 <div>
2270 <dt>
2271 <var>callback</var>
2272 <em>
2273
2274 <!-- TYPE -->
2275 <div style="display:inline">
2276 (
2277 <span class="optional">optional</span>
2278 <span class="enum" style="display: none; ">enumerated</span>
2279 <span id="typeTemplate">
2280 <span style="display: none; ">
2281 <a> Type</a>
2282 </span>
2283 <span>
2284 <span style="display: none; ">
2285 array of <span><span></span></span>
2286 </span>
2287 <span>function</span>
2288 <span style="display: none; "></span>
2289 </span>
2290 </span>
2291 )
2292 </div>
2293
2294 </em>
2295 </dt>
2296 <dd class="todo">
2297 Undocumented.
2298 </dd>
2299 <dd style="display: none; ">
2300 Description of this parameter from the json schema.
2301 </dd>
2302 <dd style="display: none; ">
2303 This parameter was added in version
2304 <b><span></span></b>.
2305 You must omit this parameter in earlier versions,
2306 and you may omit it in any version. If you require this
2307 parameter, the manifest key
2308 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2309 can ensure that your extension won't be run in an earlier browser ve rsion.
2310 </dd>
2311
2312 <!-- OBJECT PROPERTIES -->
2313 <dd style="display: none; ">
2314 <dl>
2315 <div>
2316 <div>
2317 </div>
2318 </div>
2319 </dl>
2320 </dd>
2321
2322 <!-- OBJECT METHODS -->
2323 <dd style="display: none; ">
2324 <div></div>
2325 </dd>
2326
2327 <!-- OBJECT EVENT FIELDS -->
2328 <dd style="display: none; ">
2329 <div></div>
2330 </dd>
2331
2332 <!-- FUNCTION PARAMETERS -->
2333 <dd style="display: none; ">
2334 <div></div>
2335 </dd>
2336
2337 </div>
2338 </div>
2339 </dl>
2340 </div>
2341
2342 <!-- EXTRA PARAMETERS -->
2343 <div>
2344 <h4>Extra parameters to addListener</h4>
2345 <dl>
2346 <div>
2347 <div>
2348 <dt>
2349 <var>filter</var>
2350 <em>
2351
2352 <!-- TYPE -->
2353 <div style="display:inline">
2354 (
2355 <span class="optional">optional</span>
2356 <span class="enum" style="display: none; ">enumerated</span>
2357 <span id="typeTemplate">
2358 <span>
2359 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
2360 </span>
2361 <span style="display: none; ">
2362 <span>
2363 array of <span><span></span></span>
2364 </span>
2365 <span>paramType</span>
2366 <span></span>
2367 </span>
2368 </span>
2369 )
2370 </div>
2371
2372 </em>
2373 </dt>
2374 <dd class="todo" style="display: none; ">
2375 Undocumented.
2376 </dd>
2377 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
2378 <dd style="display: none; ">
2379 This parameter was added in version
2380 <b><span></span></b>.
2381 You must omit this parameter in earlier versions,
2382 and you may omit it in any version. If you require this
2383 parameter, the manifest key
2384 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2385 can ensure that your extension won't be run in an earlier browser ve rsion.
2386 </dd>
2387
2388 <!-- OBJECT PROPERTIES -->
2389 <dd style="display: none; ">
2390 <dl>
2391 <div>
2392 <div>
2393 </div>
2394 </div>
2395 </dl>
2396 </dd>
2397
2398 <!-- OBJECT METHODS -->
2399 <dd style="display: none; ">
2400 <div></div>
2401 </dd>
2402
2403 <!-- OBJECT EVENT FIELDS -->
2404 <dd style="display: none; ">
2405 <div></div>
2406 </dd>
2407
2408 <!-- FUNCTION PARAMETERS -->
2409 <dd style="display: none; ">
2410 <div></div>
2411 </dd>
2412
2413 </div>
2414 </div><div>
2415 <div>
2416 <dt>
2417 <var>extraInfoSpec</var>
2418 <em>
2419
2420 <!-- TYPE -->
2421 <div style="display:inline">
2422 (
2423 <span class="optional">optional</span>
2424 <span class="enum" style="display: none; ">enumerated</span>
2425 <span id="typeTemplate">
2426 <span style="display: none; ">
2427 <a> Type</a>
2428 </span>
2429 <span>
2430 <span>
2431 array of <span><span>
2432 <span style="display: none; ">
2433 <a> Type</a>
2434 </span>
2435 <span>
2436 <span style="display: none; ">
2437 array of <span><span></span></span>
2438 </span>
2439 <span>string</span>
2440 <span>["responseHeaders", "blocking", "asyncBlocking"]</ span>
2441 </span>
2442 </span></span>
2443 </span>
2444 <span style="display: none; ">paramType</span>
2445 <span style="display: none; "></span>
2446 </span>
2447 </span>
2448 )
2449 </div>
2450
2451 </em>
2452 </dt>
2453 <dd class="todo" style="display: none; ">
2454 Undocumented.
2455 </dd>
2456 <dd>Array of extra information that should be passed to the listener f unction.</dd>
2457 <dd style="display: none; ">
2458 This parameter was added in version
2459 <b><span></span></b>.
2460 You must omit this parameter in earlier versions,
2461 and you may omit it in any version. If you require this
2462 parameter, the manifest key
2463 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2464 can ensure that your extension won't be run in an earlier browser ve rsion.
2465 </dd>
2466
2467 <!-- OBJECT PROPERTIES -->
2468 <dd style="display: none; ">
2469 <dl>
2470 <div>
2471 <div>
2472 </div>
2473 </div>
2474 </dl>
2475 </dd>
2476
2477 <!-- OBJECT METHODS -->
2478 <dd style="display: none; ">
2479 <div></div>
2480 </dd>
2481
2482 <!-- OBJECT EVENT FIELDS -->
2483 <dd style="display: none; ">
2484 <div></div>
2485 </dd>
2486
2487 <!-- FUNCTION PARAMETERS -->
2488 <dd style="display: none; ">
2489 <div></div>
2490 </dd>
2491
2492 </div>
2493 </div>
2494 </dl>
2495 </div>
2496
2497 <!-- LISTENER RETURN VALUE -->
2498 <h4>Listener returns</h4>
2499 <dl>
2500 <div>
2501 <div>
2502 <dt>
2503 <var style="display: none; ">paramName</var>
2504 <em>
2505
2506 <!-- TYPE -->
2507 <div style="display:inline">
2508 (
2509 <span class="optional">optional</span>
2510 <span class="enum" style="display: none; ">enumerated</span>
2511 <span id="typeTemplate">
2512 <span>
2513 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a>
2514 </span>
2515 <span style="display: none; ">
2516 <span>
2517 array of <span><span></span></span>
2518 </span>
2519 <span>paramType</span>
2520 <span></span>
2521 </span>
2522 </span>
2523 )
2524 </div>
2525
2526 </em>
2527 </dt>
2528 <dd class="todo" style="display: none; ">
2529 Undocumented.
2530 </dd>
2531 <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the e vent listener should return an object of this type.</dd>
2532 <dd style="display: none; ">
2533 This parameter was added in version
2534 <b><span></span></b>.
2535 You must omit this parameter in earlier versions,
2536 and you may omit it in any version. If you require this
2537 parameter, the manifest key
2538 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2539 can ensure that your extension won't be run in an earlier browser ve rsion.
2540 </dd>
2541
2542 <!-- OBJECT PROPERTIES -->
2543 <dd style="display: none; ">
2544 <dl>
2545 <div>
2546 <div>
2547 </div>
2548 </div>
2549 </dl>
2550 </dd>
2551
2552 <!-- OBJECT METHODS -->
2553 <dd style="display: none; ">
2554 <div></div>
2555 </dd>
2556
2557 <!-- OBJECT EVENT FIELDS -->
2558 <dd style="display: none; ">
2559 <div></div>
2560 </dd>
2561
2562 <!-- FUNCTION PARAMETERS -->
2563 <dd style="display: none; ">
2564 <div></div>
2565 </dd>
2566
2567 </div>
2568 </div>
2569 </dl>
2570
2571 </div> <!-- /description -->
2572 </div><div class="apiItem">
2573 <a name="event-onBeforeRedirect"></a>
2574 <h4>onBeforeRedirect</h4>
2575
2576 <div class="summary">
2577 <!-- Note: intentionally longer 80 columns -->
2578 <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><span>, RequestFilter filter, array of string extraInfoSpec</span>);
2579 </div>
2580
2581 <div class="description">
2582 <p class="todo" style="display: none; ">Undocumented.</p>
2583 <p>Fired when a server initiated redirect is about to occur.</p>
2584
2585 <!-- LISTENER PARAMETERS -->
2586 <div>
2587 <h4>Listener parameters</h4>
2588 <dl>
2589 <div>
2590 <div>
2591 <dt>
2592 <var>details</var>
2593 <em>
2594
2595 <!-- TYPE -->
2596 <div style="display:inline">
2597 (
2598 <span class="optional" style="display: none; ">optional</spa n>
2599 <span class="enum" style="display: none; ">enumerated</span>
2600 <span id="typeTemplate">
2601 <span style="display: none; ">
2602 <a> Type</a>
2603 </span>
2604 <span>
2605 <span style="display: none; ">
2606 array of <span><span></span></span>
2607 </span>
2608 <span>object</span>
2609 <span style="display: none; "></span>
2610 </span>
2611 </span>
2612 )
2613 </div>
2614
2615 </em>
2616 </dt>
2617 <dd class="todo">
2618 Undocumented.
2619 </dd>
2620 <dd style="display: none; ">
2621 Description of this parameter from the json schema.
2622 </dd>
2623 <dd style="display: none; ">
2624 This parameter was added in version
2625 <b><span></span></b>.
2626 You must omit this parameter in earlier versions,
2627 and you may omit it in any version. If you require this
2628 parameter, the manifest key
2629 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2630 can ensure that your extension won't be run in an earlier browser ve rsion.
2631 </dd>
2632
2633 <!-- OBJECT PROPERTIES -->
2634 <dd>
2635 <dl>
2636 <div>
2637 <div>
2638 <dt>
2639 <var>requestId</var>
2640 <em>
2641
2642 <!-- TYPE -->
2643 <div style="display:inline">
2644 (
2645 <span class="optional" style="display: none; ">optional</spa n>
2646 <span class="enum" style="display: none; ">enumerated</span>
2647 <span id="typeTemplate">
2648 <span style="display: none; ">
2649 <a> Type</a>
2650 </span>
2651 <span>
2652 <span style="display: none; ">
2653 array of <span><span></span></span>
2654 </span>
2655 <span>string</span>
2656 <span style="display: none; "></span>
2657 </span>
2658 </span>
2659 )
2660 </div>
2661
2662 </em>
2663 </dt>
2664 <dd class="todo" style="display: none; ">
2665 Undocumented.
2666 </dd>
2667 <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>
2668 <dd style="display: none; ">
2669 This parameter was added in version
2670 <b><span></span></b>.
2671 You must omit this parameter in earlier versions,
2672 and you may omit it in any version. If you require this
2673 parameter, the manifest key
2674 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2675 can ensure that your extension won't be run in an earlier browser ve rsion.
2676 </dd>
2677
2678 <!-- OBJECT PROPERTIES -->
2679 <dd style="display: none; ">
2680 <dl>
2681 <div>
2682 <div>
2683 </div>
2684 </div>
2685 </dl>
2686 </dd>
2687
2688 <!-- OBJECT METHODS -->
2689 <dd style="display: none; ">
2690 <div></div>
2691 </dd>
2692
2693 <!-- OBJECT EVENT FIELDS -->
2694 <dd style="display: none; ">
2695 <div></div>
2696 </dd>
2697
2698 <!-- FUNCTION PARAMETERS -->
2699 <dd style="display: none; ">
2700 <div></div>
2701 </dd>
2702
2703 </div>
2704 </div><div>
2705 <div>
2706 <dt>
2707 <var>url</var>
2708 <em>
2709
2710 <!-- TYPE -->
2711 <div style="display:inline">
2712 (
2713 <span class="optional" style="display: none; ">optional</spa n>
2714 <span class="enum" style="display: none; ">enumerated</span>
2715 <span id="typeTemplate">
2716 <span style="display: none; ">
2717 <a> Type</a>
2718 </span>
2719 <span>
2720 <span style="display: none; ">
2721 array of <span><span></span></span>
2722 </span>
2723 <span>string</span>
2724 <span style="display: none; "></span>
2725 </span>
2726 </span>
2727 )
2728 </div>
2729
2730 </em>
2731 </dt>
2732 <dd class="todo">
2733 Undocumented.
2734 </dd>
2735 <dd style="display: none; ">
2736 Description of this parameter from the json schema.
2737 </dd>
2738 <dd style="display: none; ">
2739 This parameter was added in version
2740 <b><span></span></b>.
2741 You must omit this parameter in earlier versions,
2742 and you may omit it in any version. If you require this
2743 parameter, the manifest key
2744 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2745 can ensure that your extension won't be run in an earlier browser ve rsion.
2746 </dd>
2747
2748 <!-- OBJECT PROPERTIES -->
2749 <dd style="display: none; ">
2750 <dl>
2751 <div>
2752 <div>
2753 </div>
2754 </div>
2755 </dl>
2756 </dd>
2757
2758 <!-- OBJECT METHODS -->
2759 <dd style="display: none; ">
2760 <div></div>
2761 </dd>
2762
2763 <!-- OBJECT EVENT FIELDS -->
2764 <dd style="display: none; ">
2765 <div></div>
2766 </dd>
2767
2768 <!-- FUNCTION PARAMETERS -->
2769 <dd style="display: none; ">
2770 <div></div>
2771 </dd>
2772
2773 </div>
2774 </div><div>
2775 <div>
2776 <dt>
2777 <var>method</var>
2778 <em>
2779
2780 <!-- TYPE -->
2781 <div style="display:inline">
2782 (
2783 <span class="optional" style="display: none; ">optional</spa n>
2784 <span class="enum" style="display: none; ">enumerated</span>
2785 <span id="typeTemplate">
2786 <span style="display: none; ">
2787 <a> Type</a>
2788 </span>
2789 <span>
2790 <span style="display: none; ">
2791 array of <span><span></span></span>
2792 </span>
2793 <span>string</span>
2794 <span style="display: none; "></span>
2795 </span>
2796 </span>
2797 )
2798 </div>
2799
2800 </em>
2801 </dt>
2802 <dd class="todo" style="display: none; ">
2803 Undocumented.
2804 </dd>
2805 <dd>Standard HTTP method.</dd>
2806 <dd style="display: none; ">
2807 This parameter was added in version
2808 <b><span></span></b>.
2809 You must omit this parameter in earlier versions,
2810 and you may omit it in any version. If you require this
2811 parameter, the manifest key
2812 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2813 can ensure that your extension won't be run in an earlier browser ve rsion.
2814 </dd>
2815
2816 <!-- OBJECT PROPERTIES -->
2817 <dd style="display: none; ">
2818 <dl>
2819 <div>
2820 <div>
2821 </div>
2822 </div>
2823 </dl>
2824 </dd>
2825
2826 <!-- OBJECT METHODS -->
2827 <dd style="display: none; ">
2828 <div></div>
2829 </dd>
2830
2831 <!-- OBJECT EVENT FIELDS -->
2832 <dd style="display: none; ">
2833 <div></div>
2834 </dd>
2835
2836 <!-- FUNCTION PARAMETERS -->
2837 <dd style="display: none; ">
2838 <div></div>
2839 </dd>
2840
2841 </div>
2842 </div><div>
2843 <div>
2844 <dt>
2845 <var>frameId</var>
2846 <em>
2847
2848 <!-- TYPE -->
2849 <div style="display:inline">
2850 (
2851 <span class="optional" style="display: none; ">optional</spa n>
2852 <span class="enum" style="display: none; ">enumerated</span>
2853 <span id="typeTemplate">
2854 <span style="display: none; ">
2855 <a> Type</a>
2856 </span>
2857 <span>
2858 <span style="display: none; ">
2859 array of <span><span></span></span>
2860 </span>
2861 <span>integer</span>
2862 <span style="display: none; "></span>
2863 </span>
2864 </span>
2865 )
2866 </div>
2867
2868 </em>
2869 </dt>
2870 <dd class="todo" style="display: none; ">
2871 Undocumented.
2872 </dd>
2873 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
2874 <dd style="display: none; ">
2875 This parameter was added in version
2876 <b><span></span></b>.
2877 You must omit this parameter in earlier versions,
2878 and you may omit it in any version. If you require this
2879 parameter, the manifest key
2880 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2881 can ensure that your extension won't be run in an earlier browser ve rsion.
2882 </dd>
2883
2884 <!-- OBJECT PROPERTIES -->
2885 <dd style="display: none; ">
2886 <dl>
2887 <div>
2888 <div>
2889 </div>
2890 </div>
2891 </dl>
2892 </dd>
2893
2894 <!-- OBJECT METHODS -->
2895 <dd style="display: none; ">
2896 <div></div>
2897 </dd>
2898
2899 <!-- OBJECT EVENT FIELDS -->
2900 <dd style="display: none; ">
2901 <div></div>
2902 </dd>
2903
2904 <!-- FUNCTION PARAMETERS -->
2905 <dd style="display: none; ">
2906 <div></div>
2907 </dd>
2908
2909 </div>
2910 </div><div>
2911 <div>
2912 <dt>
2913 <var>parentFrameId</var>
2914 <em>
2915
2916 <!-- TYPE -->
2917 <div style="display:inline">
2918 (
2919 <span class="optional" style="display: none; ">optional</spa n>
2920 <span class="enum" style="display: none; ">enumerated</span>
2921 <span id="typeTemplate">
2922 <span style="display: none; ">
2923 <a> Type</a>
2924 </span>
2925 <span>
2926 <span style="display: none; ">
2927 array of <span><span></span></span>
2928 </span>
2929 <span>integer</span>
2930 <span style="display: none; "></span>
2931 </span>
2932 </span>
2933 )
2934 </div>
2935
2936 </em>
2937 </dt>
2938 <dd class="todo" style="display: none; ">
2939 Undocumented.
2940 </dd>
2941 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
2942 <dd style="display: none; ">
2943 This parameter was added in version
2944 <b><span></span></b>.
2945 You must omit this parameter in earlier versions,
2946 and you may omit it in any version. If you require this
2947 parameter, the manifest key
2948 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2949 can ensure that your extension won't be run in an earlier browser ve rsion.
2950 </dd>
2951
2952 <!-- OBJECT PROPERTIES -->
2953 <dd style="display: none; ">
2954 <dl>
2955 <div>
2956 <div>
2957 </div>
2958 </div>
2959 </dl>
2960 </dd>
2961
2962 <!-- OBJECT METHODS -->
2963 <dd style="display: none; ">
2964 <div></div>
2965 </dd>
2966
2967 <!-- OBJECT EVENT FIELDS -->
2968 <dd style="display: none; ">
2969 <div></div>
2970 </dd>
2971
2972 <!-- FUNCTION PARAMETERS -->
2973 <dd style="display: none; ">
2974 <div></div>
2975 </dd>
2976
2977 </div>
2978 </div><div>
2979 <div>
2980 <dt>
2981 <var>tabId</var>
2982 <em>
2983
2984 <!-- TYPE -->
2985 <div style="display:inline">
2986 (
2987 <span class="optional" style="display: none; ">optional</spa n>
2988 <span class="enum" style="display: none; ">enumerated</span>
2989 <span id="typeTemplate">
2990 <span style="display: none; ">
2991 <a> Type</a>
2992 </span>
2993 <span>
2994 <span style="display: none; ">
2995 array of <span><span></span></span>
2996 </span>
2997 <span>integer</span>
2998 <span style="display: none; "></span>
2999 </span>
3000 </span>
3001 )
3002 </div>
3003
3004 </em>
3005 </dt>
3006 <dd class="todo" style="display: none; ">
3007 Undocumented.
3008 </dd>
3009 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
3010 <dd style="display: none; ">
3011 This parameter was added in version
3012 <b><span></span></b>.
3013 You must omit this parameter in earlier versions,
3014 and you may omit it in any version. If you require this
3015 parameter, the manifest key
3016 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3017 can ensure that your extension won't be run in an earlier browser ve rsion.
3018 </dd>
3019
3020 <!-- OBJECT PROPERTIES -->
3021 <dd style="display: none; ">
3022 <dl>
3023 <div>
3024 <div>
3025 </div>
3026 </div>
3027 </dl>
3028 </dd>
3029
3030 <!-- OBJECT METHODS -->
3031 <dd style="display: none; ">
3032 <div></div>
3033 </dd>
3034
3035 <!-- OBJECT EVENT FIELDS -->
3036 <dd style="display: none; ">
3037 <div></div>
3038 </dd>
3039
3040 <!-- FUNCTION PARAMETERS -->
3041 <dd style="display: none; ">
3042 <div></div>
3043 </dd>
3044
3045 </div>
3046 </div><div>
3047 <div>
3048 <dt>
3049 <var>type</var>
3050 <em>
3051
3052 <!-- TYPE -->
3053 <div style="display:inline">
3054 (
3055 <span class="optional" style="display: none; ">optional</spa n>
3056 <span class="enum">enumerated</span>
3057 <span id="typeTemplate">
3058 <span style="display: none; ">
3059 <a> Type</a>
3060 </span>
3061 <span>
3062 <span style="display: none; ">
3063 array of <span><span></span></span>
3064 </span>
3065 <span>string</span>
3066 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
3067 </span>
3068 </span>
3069 )
3070 </div>
3071
3072 </em>
3073 </dt>
3074 <dd class="todo" style="display: none; ">
3075 Undocumented.
3076 </dd>
3077 <dd>How the requested resource will be used.</dd>
3078 <dd style="display: none; ">
3079 This parameter was added in version
3080 <b><span></span></b>.
3081 You must omit this parameter in earlier versions,
3082 and you may omit it in any version. If you require this
3083 parameter, the manifest key
3084 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3085 can ensure that your extension won't be run in an earlier browser ve rsion.
3086 </dd>
3087
3088 <!-- OBJECT PROPERTIES -->
3089 <dd style="display: none; ">
3090 <dl>
3091 <div>
3092 <div>
3093 </div>
3094 </div>
3095 </dl>
3096 </dd>
3097
3098 <!-- OBJECT METHODS -->
3099 <dd style="display: none; ">
3100 <div></div>
3101 </dd>
3102
3103 <!-- OBJECT EVENT FIELDS -->
3104 <dd style="display: none; ">
3105 <div></div>
3106 </dd>
3107
3108 <!-- FUNCTION PARAMETERS -->
3109 <dd style="display: none; ">
3110 <div></div>
3111 </dd>
3112
3113 </div>
3114 </div><div>
3115 <div>
3116 <dt>
3117 <var>timeStamp</var>
3118 <em>
3119
3120 <!-- TYPE -->
3121 <div style="display:inline">
3122 (
3123 <span class="optional" style="display: none; ">optional</spa n>
3124 <span class="enum" style="display: none; ">enumerated</span>
3125 <span id="typeTemplate">
3126 <span style="display: none; ">
3127 <a> Type</a>
3128 </span>
3129 <span>
3130 <span style="display: none; ">
3131 array of <span><span></span></span>
3132 </span>
3133 <span>number</span>
3134 <span style="display: none; "></span>
3135 </span>
3136 </span>
3137 )
3138 </div>
3139
3140 </em>
3141 </dt>
3142 <dd class="todo" style="display: none; ">
3143 Undocumented.
3144 </dd>
3145 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
3146 <dd style="display: none; ">
3147 This parameter was added in version
3148 <b><span></span></b>.
3149 You must omit this parameter in earlier versions,
3150 and you may omit it in any version. If you require this
3151 parameter, the manifest key
3152 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3153 can ensure that your extension won't be run in an earlier browser ve rsion.
3154 </dd>
3155
3156 <!-- OBJECT PROPERTIES -->
3157 <dd style="display: none; ">
3158 <dl>
3159 <div>
3160 <div>
3161 </div>
3162 </div>
3163 </dl>
3164 </dd>
3165
3166 <!-- OBJECT METHODS -->
3167 <dd style="display: none; ">
3168 <div></div>
3169 </dd>
3170
3171 <!-- OBJECT EVENT FIELDS -->
3172 <dd style="display: none; ">
3173 <div></div>
3174 </dd>
3175
3176 <!-- FUNCTION PARAMETERS -->
3177 <dd style="display: none; ">
3178 <div></div>
3179 </dd>
3180
3181 </div>
3182 </div><div>
3183 <div>
3184 <dt>
3185 <var>ip</var>
3186 <em>
3187
3188 <!-- TYPE -->
3189 <div style="display:inline">
3190 (
3191 <span class="optional">optional</span>
3192 <span class="enum" style="display: none; ">enumerated</span>
3193 <span id="typeTemplate">
3194 <span style="display: none; ">
3195 <a> Type</a>
3196 </span>
3197 <span>
3198 <span style="display: none; ">
3199 array of <span><span></span></span>
3200 </span>
3201 <span>string</span>
3202 <span style="display: none; "></span>
3203 </span>
3204 </span>
3205 )
3206 </div>
3207
3208 </em>
3209 </dt>
3210 <dd class="todo" style="display: none; ">
3211 Undocumented.
3212 </dd>
3213 <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
3214 <dd style="display: none; ">
3215 This parameter was added in version
3216 <b><span></span></b>.
3217 You must omit this parameter in earlier versions,
3218 and you may omit it in any version. If you require this
3219 parameter, the manifest key
3220 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3221 can ensure that your extension won't be run in an earlier browser ve rsion.
3222 </dd>
3223
3224 <!-- OBJECT PROPERTIES -->
3225 <dd style="display: none; ">
3226 <dl>
3227 <div>
3228 <div>
3229 </div>
3230 </div>
3231 </dl>
3232 </dd>
3233
3234 <!-- OBJECT METHODS -->
3235 <dd style="display: none; ">
3236 <div></div>
3237 </dd>
3238
3239 <!-- OBJECT EVENT FIELDS -->
3240 <dd style="display: none; ">
3241 <div></div>
3242 </dd>
3243
3244 <!-- FUNCTION PARAMETERS -->
3245 <dd style="display: none; ">
3246 <div></div>
3247 </dd>
3248
3249 </div>
3250 </div><div>
3251 <div>
3252 <dt>
3253 <var>fromCache</var>
3254 <em>
3255
3256 <!-- TYPE -->
3257 <div style="display:inline">
3258 (
3259 <span class="optional" style="display: none; ">optional</spa n>
3260 <span class="enum" style="display: none; ">enumerated</span>
3261 <span id="typeTemplate">
3262 <span style="display: none; ">
3263 <a> Type</a>
3264 </span>
3265 <span>
3266 <span style="display: none; ">
3267 array of <span><span></span></span>
3268 </span>
3269 <span>boolean</span>
3270 <span style="display: none; "></span>
3271 </span>
3272 </span>
3273 )
3274 </div>
3275
3276 </em>
3277 </dt>
3278 <dd class="todo" style="display: none; ">
3279 Undocumented.
3280 </dd>
3281 <dd>Indicates if this response was fetched from disk cache.</dd>
3282 <dd style="display: none; ">
3283 This parameter was added in version
3284 <b><span></span></b>.
3285 You must omit this parameter in earlier versions,
3286 and you may omit it in any version. If you require this
3287 parameter, the manifest key
3288 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3289 can ensure that your extension won't be run in an earlier browser ve rsion.
3290 </dd>
3291
3292 <!-- OBJECT PROPERTIES -->
3293 <dd style="display: none; ">
3294 <dl>
3295 <div>
3296 <div>
3297 </div>
3298 </div>
3299 </dl>
3300 </dd>
3301
3302 <!-- OBJECT METHODS -->
3303 <dd style="display: none; ">
3304 <div></div>
3305 </dd>
3306
3307 <!-- OBJECT EVENT FIELDS -->
3308 <dd style="display: none; ">
3309 <div></div>
3310 </dd>
3311
3312 <!-- FUNCTION PARAMETERS -->
3313 <dd style="display: none; ">
3314 <div></div>
3315 </dd>
3316
3317 </div>
3318 </div><div>
3319 <div>
3320 <dt>
3321 <var>statusCode</var>
3322 <em>
3323
3324 <!-- TYPE -->
3325 <div style="display:inline">
3326 (
3327 <span class="optional" style="display: none; ">optional</spa n>
3328 <span class="enum" style="display: none; ">enumerated</span>
3329 <span id="typeTemplate">
3330 <span style="display: none; ">
3331 <a> Type</a>
3332 </span>
3333 <span>
3334 <span style="display: none; ">
3335 array of <span><span></span></span>
3336 </span>
3337 <span>integer</span>
3338 <span style="display: none; "></span>
3339 </span>
3340 </span>
3341 )
3342 </div>
3343
3344 </em>
3345 </dt>
3346 <dd class="todo" style="display: none; ">
3347 Undocumented.
3348 </dd>
3349 <dd>Standard HTTP status code returned by the server.</dd>
3350 <dd style="display: none; ">
3351 This parameter was added in version
3352 <b><span></span></b>.
3353 You must omit this parameter in earlier versions,
3354 and you may omit it in any version. If you require this
3355 parameter, the manifest key
3356 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3357 can ensure that your extension won't be run in an earlier browser ve rsion.
3358 </dd>
3359
3360 <!-- OBJECT PROPERTIES -->
3361 <dd style="display: none; ">
3362 <dl>
3363 <div>
3364 <div>
3365 </div>
3366 </div>
3367 </dl>
3368 </dd>
3369
3370 <!-- OBJECT METHODS -->
3371 <dd style="display: none; ">
3372 <div></div>
3373 </dd>
3374
3375 <!-- OBJECT EVENT FIELDS -->
3376 <dd style="display: none; ">
3377 <div></div>
3378 </dd>
3379
3380 <!-- FUNCTION PARAMETERS -->
3381 <dd style="display: none; ">
3382 <div></div>
3383 </dd>
3384
3385 </div>
3386 </div><div>
3387 <div>
3388 <dt>
3389 <var>redirectUrl</var>
3390 <em>
3391
3392 <!-- TYPE -->
3393 <div style="display:inline">
3394 (
3395 <span class="optional" style="display: none; ">optional</spa n>
3396 <span class="enum" style="display: none; ">enumerated</span>
3397 <span id="typeTemplate">
3398 <span style="display: none; ">
3399 <a> Type</a>
3400 </span>
3401 <span>
3402 <span style="display: none; ">
3403 array of <span><span></span></span>
3404 </span>
3405 <span>string</span>
3406 <span style="display: none; "></span>
3407 </span>
3408 </span>
3409 )
3410 </div>
3411
3412 </em>
3413 </dt>
3414 <dd class="todo" style="display: none; ">
3415 Undocumented.
3416 </dd>
3417 <dd>The new URL.</dd>
3418 <dd style="display: none; ">
3419 This parameter was added in version
3420 <b><span></span></b>.
3421 You must omit this parameter in earlier versions,
3422 and you may omit it in any version. If you require this
3423 parameter, the manifest key
3424 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3425 can ensure that your extension won't be run in an earlier browser ve rsion.
3426 </dd>
3427
3428 <!-- OBJECT PROPERTIES -->
3429 <dd style="display: none; ">
3430 <dl>
3431 <div>
3432 <div>
3433 </div>
3434 </div>
3435 </dl>
3436 </dd>
3437
3438 <!-- OBJECT METHODS -->
3439 <dd style="display: none; ">
3440 <div></div>
3441 </dd>
3442
3443 <!-- OBJECT EVENT FIELDS -->
3444 <dd style="display: none; ">
3445 <div></div>
3446 </dd>
3447
3448 <!-- FUNCTION PARAMETERS -->
3449 <dd style="display: none; ">
3450 <div></div>
3451 </dd>
3452
3453 </div>
3454 </div><div>
3455 <div>
3456 <dt>
3457 <var>responseHeaders</var>
3458 <em>
3459
3460 <!-- TYPE -->
3461 <div style="display:inline">
3462 (
3463 <span class="optional">optional</span>
3464 <span class="enum" style="display: none; ">enumerated</span>
3465 <span id="typeTemplate">
3466 <span>
3467 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
3468 </span>
3469 <span style="display: none; ">
3470 <span>
3471 array of <span><span></span></span>
3472 </span>
3473 <span>paramType</span>
3474 <span></span>
3475 </span>
3476 </span>
3477 )
3478 </div>
3479
3480 </em>
3481 </dt>
3482 <dd class="todo" style="display: none; ">
3483 Undocumented.
3484 </dd>
3485 <dd>The HTTP response headers that were received along with this redir ect.</dd>
3486 <dd style="display: none; ">
3487 This parameter was added in version
3488 <b><span></span></b>.
3489 You must omit this parameter in earlier versions,
3490 and you may omit it in any version. If you require this
3491 parameter, the manifest key
3492 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3493 can ensure that your extension won't be run in an earlier browser ve rsion.
3494 </dd>
3495
3496 <!-- OBJECT PROPERTIES -->
3497 <dd style="display: none; ">
3498 <dl>
3499 <div>
3500 <div>
3501 </div>
3502 </div>
3503 </dl>
3504 </dd>
3505
3506 <!-- OBJECT METHODS -->
3507 <dd style="display: none; ">
3508 <div></div>
3509 </dd>
3510
3511 <!-- OBJECT EVENT FIELDS -->
3512 <dd style="display: none; ">
3513 <div></div>
3514 </dd>
3515
3516 <!-- FUNCTION PARAMETERS -->
3517 <dd style="display: none; ">
3518 <div></div>
3519 </dd>
3520
3521 </div>
3522 </div><div>
3523 <div>
3524 <dt>
3525 <var>statusLine</var>
3526 <em>
3527
3528 <!-- TYPE -->
3529 <div style="display:inline">
3530 (
3531 <span class="optional">optional</span>
3532 <span class="enum" style="display: none; ">enumerated</span>
3533 <span id="typeTemplate">
3534 <span style="display: none; ">
3535 <a> Type</a>
3536 </span>
3537 <span>
3538 <span style="display: none; ">
3539 array of <span><span></span></span>
3540 </span>
3541 <span>string</span>
3542 <span style="display: none; "></span>
3543 </span>
3544 </span>
3545 )
3546 </div>
3547
3548 </em>
3549 </dt>
3550 <dd class="todo" style="display: none; ">
3551 Undocumented.
3552 </dd>
3553 <dd>HTTP status line of the response</dd>
3554 <dd style="display: none; ">
3555 This parameter was added in version
3556 <b><span></span></b>.
3557 You must omit this parameter in earlier versions,
3558 and you may omit it in any version. If you require this
3559 parameter, the manifest key
3560 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3561 can ensure that your extension won't be run in an earlier browser ve rsion.
3562 </dd>
3563
3564 <!-- OBJECT PROPERTIES -->
3565 <dd style="display: none; ">
3566 <dl>
3567 <div>
3568 <div>
3569 </div>
3570 </div>
3571 </dl>
3572 </dd>
3573
3574 <!-- OBJECT METHODS -->
3575 <dd style="display: none; ">
3576 <div></div>
3577 </dd>
3578
3579 <!-- OBJECT EVENT FIELDS -->
3580 <dd style="display: none; ">
3581 <div></div>
3582 </dd>
3583
3584 <!-- FUNCTION PARAMETERS -->
3585 <dd style="display: none; ">
3586 <div></div>
3587 </dd>
3588
3589 </div>
3590 </div>
3591 </dl>
3592 </dd>
3593
3594 <!-- OBJECT METHODS -->
3595 <dd style="display: none; ">
3596 <div></div>
3597 </dd>
3598
3599 <!-- OBJECT EVENT FIELDS -->
3600 <dd style="display: none; ">
3601 <div></div>
3602 </dd>
3603
3604 <!-- FUNCTION PARAMETERS -->
3605 <dd style="display: none; ">
3606 <div></div>
3607 </dd>
3608
3609 </div>
3610 </div>
3611 </dl>
3612 </div>
3613
3614 <!-- EXTRA PARAMETERS -->
3615 <div>
3616 <h4>Extra parameters to addListener</h4>
3617 <dl>
3618 <div>
3619 <div>
3620 <dt>
3621 <var>filter</var>
3622 <em>
3623
3624 <!-- TYPE -->
3625 <div style="display:inline">
3626 (
3627 <span class="optional">optional</span>
3628 <span class="enum" style="display: none; ">enumerated</span>
3629 <span id="typeTemplate">
3630 <span>
3631 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
3632 </span>
3633 <span style="display: none; ">
3634 <span>
3635 array of <span><span></span></span>
3636 </span>
3637 <span>paramType</span>
3638 <span></span>
3639 </span>
3640 </span>
3641 )
3642 </div>
3643
3644 </em>
3645 </dt>
3646 <dd class="todo" style="display: none; ">
3647 Undocumented.
3648 </dd>
3649 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
3650 <dd style="display: none; ">
3651 This parameter was added in version
3652 <b><span></span></b>.
3653 You must omit this parameter in earlier versions,
3654 and you may omit it in any version. If you require this
3655 parameter, the manifest key
3656 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3657 can ensure that your extension won't be run in an earlier browser ve rsion.
3658 </dd>
3659
3660 <!-- OBJECT PROPERTIES -->
3661 <dd style="display: none; ">
3662 <dl>
3663 <div>
3664 <div>
3665 </div>
3666 </div>
3667 </dl>
3668 </dd>
3669
3670 <!-- OBJECT METHODS -->
3671 <dd style="display: none; ">
3672 <div></div>
3673 </dd>
3674
3675 <!-- OBJECT EVENT FIELDS -->
3676 <dd style="display: none; ">
3677 <div></div>
3678 </dd>
3679
3680 <!-- FUNCTION PARAMETERS -->
3681 <dd style="display: none; ">
3682 <div></div>
3683 </dd>
3684
3685 </div>
3686 </div><div>
3687 <div>
3688 <dt>
3689 <var>extraInfoSpec</var>
3690 <em>
3691
3692 <!-- TYPE -->
3693 <div style="display:inline">
3694 (
3695 <span class="optional">optional</span>
3696 <span class="enum" style="display: none; ">enumerated</span>
3697 <span id="typeTemplate">
3698 <span style="display: none; ">
3699 <a> Type</a>
3700 </span>
3701 <span>
3702 <span>
3703 array of <span><span>
3704 <span style="display: none; ">
3705 <a> Type</a>
3706 </span>
3707 <span>
3708 <span style="display: none; ">
3709 array of <span><span></span></span>
3710 </span>
3711 <span>string</span>
3712 <span>["responseHeaders"]</span>
3713 </span>
3714 </span></span>
3715 </span>
3716 <span style="display: none; ">paramType</span>
3717 <span style="display: none; "></span>
3718 </span>
3719 </span>
3720 )
3721 </div>
3722
3723 </em>
3724 </dt>
3725 <dd class="todo" style="display: none; ">
3726 Undocumented.
3727 </dd>
3728 <dd>Array of extra information that should be passed to the listener f unction.</dd>
3729 <dd style="display: none; ">
3730 This parameter was added in version
3731 <b><span></span></b>.
3732 You must omit this parameter in earlier versions,
3733 and you may omit it in any version. If you require this
3734 parameter, the manifest key
3735 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3736 can ensure that your extension won't be run in an earlier browser ve rsion.
3737 </dd>
3738
3739 <!-- OBJECT PROPERTIES -->
3740 <dd style="display: none; ">
3741 <dl>
3742 <div>
3743 <div>
3744 </div>
3745 </div>
3746 </dl>
3747 </dd>
3748
3749 <!-- OBJECT METHODS -->
3750 <dd style="display: none; ">
3751 <div></div>
3752 </dd>
3753
3754 <!-- OBJECT EVENT FIELDS -->
3755 <dd style="display: none; ">
3756 <div></div>
3757 </dd>
3758
3759 <!-- FUNCTION PARAMETERS -->
3760 <dd style="display: none; ">
3761 <div></div>
3762 </dd>
3763
3764 </div>
3765 </div>
3766 </dl>
3767 </div>
3768
3769 <!-- LISTENER RETURN VALUE -->
3770 <h4 style="display: none; ">Listener returns</h4>
3771 <dl>
3772 <div style="display: none; ">
3773 <div>
3774 </div>
3775 </div>
3776 </dl>
3777
3778 </div> <!-- /description -->
3779 </div><div class="apiItem">
3780 <a name="event-onBeforeRequest"></a>
3781 <h4>onBeforeRequest</h4>
3782
3783 <div class="summary">
3784 <!-- Note: intentionally longer 80 columns -->
3785 <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><span>, RequestFilter filter, array of string extraInfoSpec</span>);
3786 </div>
3787
3788 <div class="description">
3789 <p class="todo" style="display: none; ">Undocumented.</p>
3790 <p>Fired when a request is about to occur.</p>
3791
3792 <!-- LISTENER PARAMETERS -->
3793 <div>
3794 <h4>Listener parameters</h4>
3795 <dl>
3796 <div>
3797 <div>
3798 <dt>
3799 <var>details</var>
3800 <em>
3801
3802 <!-- TYPE -->
3803 <div style="display:inline">
3804 (
3805 <span class="optional" style="display: none; ">optional</spa n>
3806 <span class="enum" style="display: none; ">enumerated</span>
3807 <span id="typeTemplate">
3808 <span style="display: none; ">
3809 <a> Type</a>
3810 </span>
3811 <span>
3812 <span style="display: none; ">
3813 array of <span><span></span></span>
3814 </span>
3815 <span>object</span>
3816 <span style="display: none; "></span>
3817 </span>
3818 </span>
3819 )
3820 </div>
3821
3822 </em>
3823 </dt>
3824 <dd class="todo">
3825 Undocumented.
3826 </dd>
3827 <dd style="display: none; ">
3828 Description of this parameter from the json schema.
3829 </dd>
3830 <dd style="display: none; ">
3831 This parameter was added in version
3832 <b><span></span></b>.
3833 You must omit this parameter in earlier versions,
3834 and you may omit it in any version. If you require this
3835 parameter, the manifest key
3836 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3837 can ensure that your extension won't be run in an earlier browser ve rsion.
3838 </dd>
3839
3840 <!-- OBJECT PROPERTIES -->
3841 <dd>
3842 <dl>
3843 <div>
3844 <div>
3845 <dt>
3846 <var>requestId</var>
3847 <em>
3848
3849 <!-- TYPE -->
3850 <div style="display:inline">
3851 (
3852 <span class="optional" style="display: none; ">optional</spa n>
3853 <span class="enum" style="display: none; ">enumerated</span>
3854 <span id="typeTemplate">
3855 <span style="display: none; ">
3856 <a> Type</a>
3857 </span>
3858 <span>
3859 <span style="display: none; ">
3860 array of <span><span></span></span>
3861 </span>
3862 <span>string</span>
3863 <span style="display: none; "></span>
3864 </span>
3865 </span>
3866 )
3867 </div>
3868
3869 </em>
3870 </dt>
3871 <dd class="todo" style="display: none; ">
3872 Undocumented.
3873 </dd>
3874 <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>
3875 <dd style="display: none; ">
3876 This parameter was added in version
3877 <b><span></span></b>.
3878 You must omit this parameter in earlier versions,
3879 and you may omit it in any version. If you require this
3880 parameter, the manifest key
3881 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3882 can ensure that your extension won't be run in an earlier browser ve rsion.
3883 </dd>
3884
3885 <!-- OBJECT PROPERTIES -->
3886 <dd style="display: none; ">
3887 <dl>
3888 <div>
3889 <div>
3890 </div>
3891 </div>
3892 </dl>
3893 </dd>
3894
3895 <!-- OBJECT METHODS -->
3896 <dd style="display: none; ">
3897 <div></div>
3898 </dd>
3899
3900 <!-- OBJECT EVENT FIELDS -->
3901 <dd style="display: none; ">
3902 <div></div>
3903 </dd>
3904
3905 <!-- FUNCTION PARAMETERS -->
3906 <dd style="display: none; ">
3907 <div></div>
3908 </dd>
3909
3910 </div>
3911 </div><div>
3912 <div>
3913 <dt>
3914 <var>url</var>
3915 <em>
3916
3917 <!-- TYPE -->
3918 <div style="display:inline">
3919 (
3920 <span class="optional" style="display: none; ">optional</spa n>
3921 <span class="enum" style="display: none; ">enumerated</span>
3922 <span id="typeTemplate">
3923 <span style="display: none; ">
3924 <a> Type</a>
3925 </span>
3926 <span>
3927 <span style="display: none; ">
3928 array of <span><span></span></span>
3929 </span>
3930 <span>string</span>
3931 <span style="display: none; "></span>
3932 </span>
3933 </span>
3934 )
3935 </div>
3936
3937 </em>
3938 </dt>
3939 <dd class="todo">
3940 Undocumented.
3941 </dd>
3942 <dd style="display: none; ">
3943 Description of this parameter from the json schema.
3944 </dd>
3945 <dd style="display: none; ">
3946 This parameter was added in version
3947 <b><span></span></b>.
3948 You must omit this parameter in earlier versions,
3949 and you may omit it in any version. If you require this
3950 parameter, the manifest key
3951 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
3952 can ensure that your extension won't be run in an earlier browser ve rsion.
3953 </dd>
3954
3955 <!-- OBJECT PROPERTIES -->
3956 <dd style="display: none; ">
3957 <dl>
3958 <div>
3959 <div>
3960 </div>
3961 </div>
3962 </dl>
3963 </dd>
3964
3965 <!-- OBJECT METHODS -->
3966 <dd style="display: none; ">
3967 <div></div>
3968 </dd>
3969
3970 <!-- OBJECT EVENT FIELDS -->
3971 <dd style="display: none; ">
3972 <div></div>
3973 </dd>
3974
3975 <!-- FUNCTION PARAMETERS -->
3976 <dd style="display: none; ">
3977 <div></div>
3978 </dd>
3979
3980 </div>
3981 </div><div>
3982 <div>
3983 <dt>
3984 <var>method</var>
3985 <em>
3986
3987 <!-- TYPE -->
3988 <div style="display:inline">
3989 (
3990 <span class="optional" style="display: none; ">optional</spa n>
3991 <span class="enum" style="display: none; ">enumerated</span>
3992 <span id="typeTemplate">
3993 <span style="display: none; ">
3994 <a> Type</a>
3995 </span>
3996 <span>
3997 <span style="display: none; ">
3998 array of <span><span></span></span>
3999 </span>
4000 <span>string</span>
4001 <span style="display: none; "></span>
4002 </span>
4003 </span>
4004 )
4005 </div>
4006
4007 </em>
4008 </dt>
4009 <dd class="todo" style="display: none; ">
4010 Undocumented.
4011 </dd>
4012 <dd>Standard HTTP method.</dd>
4013 <dd style="display: none; ">
4014 This parameter was added in version
4015 <b><span></span></b>.
4016 You must omit this parameter in earlier versions,
4017 and you may omit it in any version. If you require this
4018 parameter, the manifest key
4019 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4020 can ensure that your extension won't be run in an earlier browser ve rsion.
4021 </dd>
4022
4023 <!-- OBJECT PROPERTIES -->
4024 <dd style="display: none; ">
4025 <dl>
4026 <div>
4027 <div>
4028 </div>
4029 </div>
4030 </dl>
4031 </dd>
4032
4033 <!-- OBJECT METHODS -->
4034 <dd style="display: none; ">
4035 <div></div>
4036 </dd>
4037
4038 <!-- OBJECT EVENT FIELDS -->
4039 <dd style="display: none; ">
4040 <div></div>
4041 </dd>
4042
4043 <!-- FUNCTION PARAMETERS -->
4044 <dd style="display: none; ">
4045 <div></div>
4046 </dd>
4047
4048 </div>
4049 </div><div>
4050 <div>
4051 <dt>
4052 <var>frameId</var>
4053 <em>
4054
4055 <!-- TYPE -->
4056 <div style="display:inline">
4057 (
4058 <span class="optional" style="display: none; ">optional</spa n>
4059 <span class="enum" style="display: none; ">enumerated</span>
4060 <span id="typeTemplate">
4061 <span style="display: none; ">
4062 <a> Type</a>
4063 </span>
4064 <span>
4065 <span style="display: none; ">
4066 array of <span><span></span></span>
4067 </span>
4068 <span>integer</span>
4069 <span style="display: none; "></span>
4070 </span>
4071 </span>
4072 )
4073 </div>
4074
4075 </em>
4076 </dt>
4077 <dd class="todo" style="display: none; ">
4078 Undocumented.
4079 </dd>
4080 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
4081 <dd style="display: none; ">
4082 This parameter was added in version
4083 <b><span></span></b>.
4084 You must omit this parameter in earlier versions,
4085 and you may omit it in any version. If you require this
4086 parameter, the manifest key
4087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4088 can ensure that your extension won't be run in an earlier browser ve rsion.
4089 </dd>
4090
4091 <!-- OBJECT PROPERTIES -->
4092 <dd style="display: none; ">
4093 <dl>
4094 <div>
4095 <div>
4096 </div>
4097 </div>
4098 </dl>
4099 </dd>
4100
4101 <!-- OBJECT METHODS -->
4102 <dd style="display: none; ">
4103 <div></div>
4104 </dd>
4105
4106 <!-- OBJECT EVENT FIELDS -->
4107 <dd style="display: none; ">
4108 <div></div>
4109 </dd>
4110
4111 <!-- FUNCTION PARAMETERS -->
4112 <dd style="display: none; ">
4113 <div></div>
4114 </dd>
4115
4116 </div>
4117 </div><div>
4118 <div>
4119 <dt>
4120 <var>parentFrameId</var>
4121 <em>
4122
4123 <!-- TYPE -->
4124 <div style="display:inline">
4125 (
4126 <span class="optional" style="display: none; ">optional</spa n>
4127 <span class="enum" style="display: none; ">enumerated</span>
4128 <span id="typeTemplate">
4129 <span style="display: none; ">
4130 <a> Type</a>
4131 </span>
4132 <span>
4133 <span style="display: none; ">
4134 array of <span><span></span></span>
4135 </span>
4136 <span>integer</span>
4137 <span style="display: none; "></span>
4138 </span>
4139 </span>
4140 )
4141 </div>
4142
4143 </em>
4144 </dt>
4145 <dd class="todo" style="display: none; ">
4146 Undocumented.
4147 </dd>
4148 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
4149 <dd style="display: none; ">
4150 This parameter was added in version
4151 <b><span></span></b>.
4152 You must omit this parameter in earlier versions,
4153 and you may omit it in any version. If you require this
4154 parameter, the manifest key
4155 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4156 can ensure that your extension won't be run in an earlier browser ve rsion.
4157 </dd>
4158
4159 <!-- OBJECT PROPERTIES -->
4160 <dd style="display: none; ">
4161 <dl>
4162 <div>
4163 <div>
4164 </div>
4165 </div>
4166 </dl>
4167 </dd>
4168
4169 <!-- OBJECT METHODS -->
4170 <dd style="display: none; ">
4171 <div></div>
4172 </dd>
4173
4174 <!-- OBJECT EVENT FIELDS -->
4175 <dd style="display: none; ">
4176 <div></div>
4177 </dd>
4178
4179 <!-- FUNCTION PARAMETERS -->
4180 <dd style="display: none; ">
4181 <div></div>
4182 </dd>
4183
4184 </div>
4185 </div><div>
4186 <div>
4187 <dt>
4188 <var>tabId</var>
4189 <em>
4190
4191 <!-- TYPE -->
4192 <div style="display:inline">
4193 (
4194 <span class="optional" style="display: none; ">optional</spa n>
4195 <span class="enum" style="display: none; ">enumerated</span>
4196 <span id="typeTemplate">
4197 <span style="display: none; ">
4198 <a> Type</a>
4199 </span>
4200 <span>
4201 <span style="display: none; ">
4202 array of <span><span></span></span>
4203 </span>
4204 <span>integer</span>
4205 <span style="display: none; "></span>
4206 </span>
4207 </span>
4208 )
4209 </div>
4210
4211 </em>
4212 </dt>
4213 <dd class="todo" style="display: none; ">
4214 Undocumented.
4215 </dd>
4216 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
4217 <dd style="display: none; ">
4218 This parameter was added in version
4219 <b><span></span></b>.
4220 You must omit this parameter in earlier versions,
4221 and you may omit it in any version. If you require this
4222 parameter, the manifest key
4223 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4224 can ensure that your extension won't be run in an earlier browser ve rsion.
4225 </dd>
4226
4227 <!-- OBJECT PROPERTIES -->
4228 <dd style="display: none; ">
4229 <dl>
4230 <div>
4231 <div>
4232 </div>
4233 </div>
4234 </dl>
4235 </dd>
4236
4237 <!-- OBJECT METHODS -->
4238 <dd style="display: none; ">
4239 <div></div>
4240 </dd>
4241
4242 <!-- OBJECT EVENT FIELDS -->
4243 <dd style="display: none; ">
4244 <div></div>
4245 </dd>
4246
4247 <!-- FUNCTION PARAMETERS -->
4248 <dd style="display: none; ">
4249 <div></div>
4250 </dd>
4251
4252 </div>
4253 </div><div>
4254 <div>
4255 <dt>
4256 <var>type</var>
4257 <em>
4258
4259 <!-- TYPE -->
4260 <div style="display:inline">
4261 (
4262 <span class="optional" style="display: none; ">optional</spa n>
4263 <span class="enum">enumerated</span>
4264 <span id="typeTemplate">
4265 <span style="display: none; ">
4266 <a> Type</a>
4267 </span>
4268 <span>
4269 <span style="display: none; ">
4270 array of <span><span></span></span>
4271 </span>
4272 <span>string</span>
4273 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
4274 </span>
4275 </span>
4276 )
4277 </div>
4278
4279 </em>
4280 </dt>
4281 <dd class="todo" style="display: none; ">
4282 Undocumented.
4283 </dd>
4284 <dd>How the requested resource will be used.</dd>
4285 <dd style="display: none; ">
4286 This parameter was added in version
4287 <b><span></span></b>.
4288 You must omit this parameter in earlier versions,
4289 and you may omit it in any version. If you require this
4290 parameter, the manifest key
4291 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4292 can ensure that your extension won't be run in an earlier browser ve rsion.
4293 </dd>
4294
4295 <!-- OBJECT PROPERTIES -->
4296 <dd style="display: none; ">
4297 <dl>
4298 <div>
4299 <div>
4300 </div>
4301 </div>
4302 </dl>
4303 </dd>
4304
4305 <!-- OBJECT METHODS -->
4306 <dd style="display: none; ">
4307 <div></div>
4308 </dd>
4309
4310 <!-- OBJECT EVENT FIELDS -->
4311 <dd style="display: none; ">
4312 <div></div>
4313 </dd>
4314
4315 <!-- FUNCTION PARAMETERS -->
4316 <dd style="display: none; ">
4317 <div></div>
4318 </dd>
4319
4320 </div>
4321 </div><div>
4322 <div>
4323 <dt>
4324 <var>timeStamp</var>
4325 <em>
4326
4327 <!-- TYPE -->
4328 <div style="display:inline">
4329 (
4330 <span class="optional" style="display: none; ">optional</spa n>
4331 <span class="enum" style="display: none; ">enumerated</span>
4332 <span id="typeTemplate">
4333 <span style="display: none; ">
4334 <a> Type</a>
4335 </span>
4336 <span>
4337 <span style="display: none; ">
4338 array of <span><span></span></span>
4339 </span>
4340 <span>number</span>
4341 <span style="display: none; "></span>
4342 </span>
4343 </span>
4344 )
4345 </div>
4346
4347 </em>
4348 </dt>
4349 <dd class="todo" style="display: none; ">
4350 Undocumented.
4351 </dd>
4352 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
4353 <dd style="display: none; ">
4354 This parameter was added in version
4355 <b><span></span></b>.
4356 You must omit this parameter in earlier versions,
4357 and you may omit it in any version. If you require this
4358 parameter, the manifest key
4359 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4360 can ensure that your extension won't be run in an earlier browser ve rsion.
4361 </dd>
4362
4363 <!-- OBJECT PROPERTIES -->
4364 <dd style="display: none; ">
4365 <dl>
4366 <div>
4367 <div>
4368 </div>
4369 </div>
4370 </dl>
4371 </dd>
4372
4373 <!-- OBJECT METHODS -->
4374 <dd style="display: none; ">
4375 <div></div>
4376 </dd>
4377
4378 <!-- OBJECT EVENT FIELDS -->
4379 <dd style="display: none; ">
4380 <div></div>
4381 </dd>
4382
4383 <!-- FUNCTION PARAMETERS -->
4384 <dd style="display: none; ">
4385 <div></div>
4386 </dd>
4387
4388 </div>
4389 </div>
4390 </dl>
4391 </dd>
4392
4393 <!-- OBJECT METHODS -->
4394 <dd style="display: none; ">
4395 <div></div>
4396 </dd>
4397
4398 <!-- OBJECT EVENT FIELDS -->
4399 <dd style="display: none; ">
4400 <div></div>
4401 </dd>
4402
4403 <!-- FUNCTION PARAMETERS -->
4404 <dd style="display: none; ">
4405 <div></div>
4406 </dd>
4407
4408 </div>
4409 </div>
4410 </dl>
4411 </div>
4412
4413 <!-- EXTRA PARAMETERS -->
4414 <div>
4415 <h4>Extra parameters to addListener</h4>
4416 <dl>
4417 <div>
4418 <div>
4419 <dt>
4420 <var>filter</var>
4421 <em>
4422
4423 <!-- TYPE -->
4424 <div style="display:inline">
4425 (
4426 <span class="optional">optional</span>
4427 <span class="enum" style="display: none; ">enumerated</span>
4428 <span id="typeTemplate">
4429 <span>
4430 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
4431 </span>
4432 <span style="display: none; ">
4433 <span>
4434 array of <span><span></span></span>
4435 </span>
4436 <span>paramType</span>
4437 <span></span>
4438 </span>
4439 </span>
4440 )
4441 </div>
4442
4443 </em>
4444 </dt>
4445 <dd class="todo" style="display: none; ">
4446 Undocumented.
4447 </dd>
4448 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
4449 <dd style="display: none; ">
4450 This parameter was added in version
4451 <b><span></span></b>.
4452 You must omit this parameter in earlier versions,
4453 and you may omit it in any version. If you require this
4454 parameter, the manifest key
4455 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4456 can ensure that your extension won't be run in an earlier browser ve rsion.
4457 </dd>
4458
4459 <!-- OBJECT PROPERTIES -->
4460 <dd style="display: none; ">
4461 <dl>
4462 <div>
4463 <div>
4464 </div>
4465 </div>
4466 </dl>
4467 </dd>
4468
4469 <!-- OBJECT METHODS -->
4470 <dd style="display: none; ">
4471 <div></div>
4472 </dd>
4473
4474 <!-- OBJECT EVENT FIELDS -->
4475 <dd style="display: none; ">
4476 <div></div>
4477 </dd>
4478
4479 <!-- FUNCTION PARAMETERS -->
4480 <dd style="display: none; ">
4481 <div></div>
4482 </dd>
4483
4484 </div>
4485 </div><div>
4486 <div>
4487 <dt>
4488 <var>extraInfoSpec</var>
4489 <em>
4490
4491 <!-- TYPE -->
4492 <div style="display:inline">
4493 (
4494 <span class="optional">optional</span>
4495 <span class="enum" style="display: none; ">enumerated</span>
4496 <span id="typeTemplate">
4497 <span style="display: none; ">
4498 <a> Type</a>
4499 </span>
4500 <span>
4501 <span>
4502 array of <span><span>
4503 <span style="display: none; ">
4504 <a> Type</a>
4505 </span>
4506 <span>
4507 <span style="display: none; ">
4508 array of <span><span></span></span>
4509 </span>
4510 <span>string</span>
4511 <span>["blocking"]</span>
4512 </span>
4513 </span></span>
4514 </span>
4515 <span style="display: none; ">paramType</span>
4516 <span style="display: none; "></span>
4517 </span>
4518 </span>
4519 )
4520 </div>
4521
4522 </em>
4523 </dt>
4524 <dd class="todo" style="display: none; ">
4525 Undocumented.
4526 </dd>
4527 <dd>Array of extra information that should be passed to the listener f unction.</dd>
4528 <dd style="display: none; ">
4529 This parameter was added in version
4530 <b><span></span></b>.
4531 You must omit this parameter in earlier versions,
4532 and you may omit it in any version. If you require this
4533 parameter, the manifest key
4534 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4535 can ensure that your extension won't be run in an earlier browser ve rsion.
4536 </dd>
4537
4538 <!-- OBJECT PROPERTIES -->
4539 <dd style="display: none; ">
4540 <dl>
4541 <div>
4542 <div>
4543 </div>
4544 </div>
4545 </dl>
4546 </dd>
4547
4548 <!-- OBJECT METHODS -->
4549 <dd style="display: none; ">
4550 <div></div>
4551 </dd>
4552
4553 <!-- OBJECT EVENT FIELDS -->
4554 <dd style="display: none; ">
4555 <div></div>
4556 </dd>
4557
4558 <!-- FUNCTION PARAMETERS -->
4559 <dd style="display: none; ">
4560 <div></div>
4561 </dd>
4562
4563 </div>
4564 </div>
4565 </dl>
4566 </div>
4567
4568 <!-- LISTENER RETURN VALUE -->
4569 <h4>Listener returns</h4>
4570 <dl>
4571 <div>
4572 <div>
4573 <dt>
4574 <var style="display: none; ">paramName</var>
4575 <em>
4576
4577 <!-- TYPE -->
4578 <div style="display:inline">
4579 (
4580 <span class="optional">optional</span>
4581 <span class="enum" style="display: none; ">enumerated</span>
4582 <span id="typeTemplate">
4583 <span>
4584 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a>
4585 </span>
4586 <span style="display: none; ">
4587 <span>
4588 array of <span><span></span></span>
4589 </span>
4590 <span>paramType</span>
4591 <span></span>
4592 </span>
4593 </span>
4594 )
4595 </div>
4596
4597 </em>
4598 </dt>
4599 <dd class="todo" style="display: none; ">
4600 Undocumented.
4601 </dd>
4602 <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the e vent listener should return an object of this type.</dd>
4603 <dd style="display: none; ">
4604 This parameter was added in version
4605 <b><span></span></b>.
4606 You must omit this parameter in earlier versions,
4607 and you may omit it in any version. If you require this
4608 parameter, the manifest key
4609 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4610 can ensure that your extension won't be run in an earlier browser ve rsion.
4611 </dd>
4612
4613 <!-- OBJECT PROPERTIES -->
4614 <dd style="display: none; ">
4615 <dl>
4616 <div>
4617 <div>
4618 </div>
4619 </div>
4620 </dl>
4621 </dd>
4622
4623 <!-- OBJECT METHODS -->
4624 <dd style="display: none; ">
4625 <div></div>
4626 </dd>
4627
4628 <!-- OBJECT EVENT FIELDS -->
4629 <dd style="display: none; ">
4630 <div></div>
4631 </dd>
4632
4633 <!-- FUNCTION PARAMETERS -->
4634 <dd style="display: none; ">
4635 <div></div>
4636 </dd>
4637
4638 </div>
4639 </div>
4640 </dl>
4641
4642 </div> <!-- /description -->
4643 </div><div class="apiItem">
4644 <a name="event-onBeforeSendHeaders"></a>
4645 <h4>onBeforeSendHeaders</h4>
4646
4647 <div class="summary">
4648 <!-- Note: intentionally longer 80 columns -->
4649 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeSendHeaders</span><span class="subdued">.addListener</span>(function(< span>object details</span>) <span class="subdued">{...}</span><span>, RequestFil ter filter, array of string extraInfoSpec</span>);
4650 </div>
4651
4652 <div class="description">
4653 <p class="todo" style="display: none; ">Undocumented.</p>
4654 <p>Fired before sending an HTTP request, once the request header s are available. This may occur after a TCP connection is made to the server, bu t before any HTTP data is sent. </p>
4655
4656 <!-- LISTENER PARAMETERS -->
4657 <div>
4658 <h4>Listener parameters</h4>
4659 <dl>
4660 <div>
4661 <div>
4662 <dt>
4663 <var>details</var>
4664 <em>
4665
4666 <!-- TYPE -->
4667 <div style="display:inline">
4668 (
4669 <span class="optional" style="display: none; ">optional</spa n>
4670 <span class="enum" style="display: none; ">enumerated</span>
4671 <span id="typeTemplate">
4672 <span style="display: none; ">
4673 <a> Type</a>
4674 </span>
4675 <span>
4676 <span style="display: none; ">
4677 array of <span><span></span></span>
4678 </span>
4679 <span>object</span>
4680 <span style="display: none; "></span>
4681 </span>
4682 </span>
4683 )
4684 </div>
4685
4686 </em>
4687 </dt>
4688 <dd class="todo">
4689 Undocumented.
4690 </dd>
4691 <dd style="display: none; ">
4692 Description of this parameter from the json schema.
4693 </dd>
4694 <dd style="display: none; ">
4695 This parameter was added in version
4696 <b><span></span></b>.
4697 You must omit this parameter in earlier versions,
4698 and you may omit it in any version. If you require this
4699 parameter, the manifest key
4700 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4701 can ensure that your extension won't be run in an earlier browser ve rsion.
4702 </dd>
4703
4704 <!-- OBJECT PROPERTIES -->
4705 <dd>
4706 <dl>
4707 <div>
4708 <div>
4709 <dt>
4710 <var>requestId</var>
4711 <em>
4712
4713 <!-- TYPE -->
4714 <div style="display:inline">
4715 (
4716 <span class="optional" style="display: none; ">optional</spa n>
4717 <span class="enum" style="display: none; ">enumerated</span>
4718 <span id="typeTemplate">
4719 <span style="display: none; ">
4720 <a> Type</a>
4721 </span>
4722 <span>
4723 <span style="display: none; ">
4724 array of <span><span></span></span>
4725 </span>
4726 <span>string</span>
4727 <span style="display: none; "></span>
4728 </span>
4729 </span>
4730 )
4731 </div>
4732
4733 </em>
4734 </dt>
4735 <dd class="todo" style="display: none; ">
4736 Undocumented.
4737 </dd>
4738 <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>
4739 <dd style="display: none; ">
4740 This parameter was added in version
4741 <b><span></span></b>.
4742 You must omit this parameter in earlier versions,
4743 and you may omit it in any version. If you require this
4744 parameter, the manifest key
4745 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4746 can ensure that your extension won't be run in an earlier browser ve rsion.
4747 </dd>
4748
4749 <!-- OBJECT PROPERTIES -->
4750 <dd style="display: none; ">
4751 <dl>
4752 <div>
4753 <div>
4754 </div>
4755 </div>
4756 </dl>
4757 </dd>
4758
4759 <!-- OBJECT METHODS -->
4760 <dd style="display: none; ">
4761 <div></div>
4762 </dd>
4763
4764 <!-- OBJECT EVENT FIELDS -->
4765 <dd style="display: none; ">
4766 <div></div>
4767 </dd>
4768
4769 <!-- FUNCTION PARAMETERS -->
4770 <dd style="display: none; ">
4771 <div></div>
4772 </dd>
4773
4774 </div>
4775 </div><div>
4776 <div>
4777 <dt>
4778 <var>url</var>
4779 <em>
4780
4781 <!-- TYPE -->
4782 <div style="display:inline">
4783 (
4784 <span class="optional" style="display: none; ">optional</spa n>
4785 <span class="enum" style="display: none; ">enumerated</span>
4786 <span id="typeTemplate">
4787 <span style="display: none; ">
4788 <a> Type</a>
4789 </span>
4790 <span>
4791 <span style="display: none; ">
4792 array of <span><span></span></span>
4793 </span>
4794 <span>string</span>
4795 <span style="display: none; "></span>
4796 </span>
4797 </span>
4798 )
4799 </div>
4800
4801 </em>
4802 </dt>
4803 <dd class="todo">
4804 Undocumented.
4805 </dd>
4806 <dd style="display: none; ">
4807 Description of this parameter from the json schema.
4808 </dd>
4809 <dd style="display: none; ">
4810 This parameter was added in version
4811 <b><span></span></b>.
4812 You must omit this parameter in earlier versions,
4813 and you may omit it in any version. If you require this
4814 parameter, the manifest key
4815 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4816 can ensure that your extension won't be run in an earlier browser ve rsion.
4817 </dd>
4818
4819 <!-- OBJECT PROPERTIES -->
4820 <dd style="display: none; ">
4821 <dl>
4822 <div>
4823 <div>
4824 </div>
4825 </div>
4826 </dl>
4827 </dd>
4828
4829 <!-- OBJECT METHODS -->
4830 <dd style="display: none; ">
4831 <div></div>
4832 </dd>
4833
4834 <!-- OBJECT EVENT FIELDS -->
4835 <dd style="display: none; ">
4836 <div></div>
4837 </dd>
4838
4839 <!-- FUNCTION PARAMETERS -->
4840 <dd style="display: none; ">
4841 <div></div>
4842 </dd>
4843
4844 </div>
4845 </div><div>
4846 <div>
4847 <dt>
4848 <var>method</var>
4849 <em>
4850
4851 <!-- TYPE -->
4852 <div style="display:inline">
4853 (
4854 <span class="optional" style="display: none; ">optional</spa n>
4855 <span class="enum" style="display: none; ">enumerated</span>
4856 <span id="typeTemplate">
4857 <span style="display: none; ">
4858 <a> Type</a>
4859 </span>
4860 <span>
4861 <span style="display: none; ">
4862 array of <span><span></span></span>
4863 </span>
4864 <span>string</span>
4865 <span style="display: none; "></span>
4866 </span>
4867 </span>
4868 )
4869 </div>
4870
4871 </em>
4872 </dt>
4873 <dd class="todo" style="display: none; ">
4874 Undocumented.
4875 </dd>
4876 <dd>Standard HTTP method.</dd>
4877 <dd style="display: none; ">
4878 This parameter was added in version
4879 <b><span></span></b>.
4880 You must omit this parameter in earlier versions,
4881 and you may omit it in any version. If you require this
4882 parameter, the manifest key
4883 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4884 can ensure that your extension won't be run in an earlier browser ve rsion.
4885 </dd>
4886
4887 <!-- OBJECT PROPERTIES -->
4888 <dd style="display: none; ">
4889 <dl>
4890 <div>
4891 <div>
4892 </div>
4893 </div>
4894 </dl>
4895 </dd>
4896
4897 <!-- OBJECT METHODS -->
4898 <dd style="display: none; ">
4899 <div></div>
4900 </dd>
4901
4902 <!-- OBJECT EVENT FIELDS -->
4903 <dd style="display: none; ">
4904 <div></div>
4905 </dd>
4906
4907 <!-- FUNCTION PARAMETERS -->
4908 <dd style="display: none; ">
4909 <div></div>
4910 </dd>
4911
4912 </div>
4913 </div><div>
4914 <div>
4915 <dt>
4916 <var>frameId</var>
4917 <em>
4918
4919 <!-- TYPE -->
4920 <div style="display:inline">
4921 (
4922 <span class="optional" style="display: none; ">optional</spa n>
4923 <span class="enum" style="display: none; ">enumerated</span>
4924 <span id="typeTemplate">
4925 <span style="display: none; ">
4926 <a> Type</a>
4927 </span>
4928 <span>
4929 <span style="display: none; ">
4930 array of <span><span></span></span>
4931 </span>
4932 <span>integer</span>
4933 <span style="display: none; "></span>
4934 </span>
4935 </span>
4936 )
4937 </div>
4938
4939 </em>
4940 </dt>
4941 <dd class="todo" style="display: none; ">
4942 Undocumented.
4943 </dd>
4944 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
4945 <dd style="display: none; ">
4946 This parameter was added in version
4947 <b><span></span></b>.
4948 You must omit this parameter in earlier versions,
4949 and you may omit it in any version. If you require this
4950 parameter, the manifest key
4951 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
4952 can ensure that your extension won't be run in an earlier browser ve rsion.
4953 </dd>
4954
4955 <!-- OBJECT PROPERTIES -->
4956 <dd style="display: none; ">
4957 <dl>
4958 <div>
4959 <div>
4960 </div>
4961 </div>
4962 </dl>
4963 </dd>
4964
4965 <!-- OBJECT METHODS -->
4966 <dd style="display: none; ">
4967 <div></div>
4968 </dd>
4969
4970 <!-- OBJECT EVENT FIELDS -->
4971 <dd style="display: none; ">
4972 <div></div>
4973 </dd>
4974
4975 <!-- FUNCTION PARAMETERS -->
4976 <dd style="display: none; ">
4977 <div></div>
4978 </dd>
4979
4980 </div>
4981 </div><div>
4982 <div>
4983 <dt>
4984 <var>parentFrameId</var>
4985 <em>
4986
4987 <!-- TYPE -->
4988 <div style="display:inline">
4989 (
4990 <span class="optional" style="display: none; ">optional</spa n>
4991 <span class="enum" style="display: none; ">enumerated</span>
4992 <span id="typeTemplate">
4993 <span style="display: none; ">
4994 <a> Type</a>
4995 </span>
4996 <span>
4997 <span style="display: none; ">
4998 array of <span><span></span></span>
4999 </span>
5000 <span>integer</span>
5001 <span style="display: none; "></span>
5002 </span>
5003 </span>
5004 )
5005 </div>
5006
5007 </em>
5008 </dt>
5009 <dd class="todo" style="display: none; ">
5010 Undocumented.
5011 </dd>
5012 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
5013 <dd style="display: none; ">
5014 This parameter was added in version
5015 <b><span></span></b>.
5016 You must omit this parameter in earlier versions,
5017 and you may omit it in any version. If you require this
5018 parameter, the manifest key
5019 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5020 can ensure that your extension won't be run in an earlier browser ve rsion.
5021 </dd>
5022
5023 <!-- OBJECT PROPERTIES -->
5024 <dd style="display: none; ">
5025 <dl>
5026 <div>
5027 <div>
5028 </div>
5029 </div>
5030 </dl>
5031 </dd>
5032
5033 <!-- OBJECT METHODS -->
5034 <dd style="display: none; ">
5035 <div></div>
5036 </dd>
5037
5038 <!-- OBJECT EVENT FIELDS -->
5039 <dd style="display: none; ">
5040 <div></div>
5041 </dd>
5042
5043 <!-- FUNCTION PARAMETERS -->
5044 <dd style="display: none; ">
5045 <div></div>
5046 </dd>
5047
5048 </div>
5049 </div><div>
5050 <div>
5051 <dt>
5052 <var>tabId</var>
5053 <em>
5054
5055 <!-- TYPE -->
5056 <div style="display:inline">
5057 (
5058 <span class="optional" style="display: none; ">optional</spa n>
5059 <span class="enum" style="display: none; ">enumerated</span>
5060 <span id="typeTemplate">
5061 <span style="display: none; ">
5062 <a> Type</a>
5063 </span>
5064 <span>
5065 <span style="display: none; ">
5066 array of <span><span></span></span>
5067 </span>
5068 <span>integer</span>
5069 <span style="display: none; "></span>
5070 </span>
5071 </span>
5072 )
5073 </div>
5074
5075 </em>
5076 </dt>
5077 <dd class="todo" style="display: none; ">
5078 Undocumented.
5079 </dd>
5080 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
5081 <dd style="display: none; ">
5082 This parameter was added in version
5083 <b><span></span></b>.
5084 You must omit this parameter in earlier versions,
5085 and you may omit it in any version. If you require this
5086 parameter, the manifest key
5087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5088 can ensure that your extension won't be run in an earlier browser ve rsion.
5089 </dd>
5090
5091 <!-- OBJECT PROPERTIES -->
5092 <dd style="display: none; ">
5093 <dl>
5094 <div>
5095 <div>
5096 </div>
5097 </div>
5098 </dl>
5099 </dd>
5100
5101 <!-- OBJECT METHODS -->
5102 <dd style="display: none; ">
5103 <div></div>
5104 </dd>
5105
5106 <!-- OBJECT EVENT FIELDS -->
5107 <dd style="display: none; ">
5108 <div></div>
5109 </dd>
5110
5111 <!-- FUNCTION PARAMETERS -->
5112 <dd style="display: none; ">
5113 <div></div>
5114 </dd>
5115
5116 </div>
5117 </div><div>
5118 <div>
5119 <dt>
5120 <var>type</var>
5121 <em>
5122
5123 <!-- TYPE -->
5124 <div style="display:inline">
5125 (
5126 <span class="optional" style="display: none; ">optional</spa n>
5127 <span class="enum">enumerated</span>
5128 <span id="typeTemplate">
5129 <span style="display: none; ">
5130 <a> Type</a>
5131 </span>
5132 <span>
5133 <span style="display: none; ">
5134 array of <span><span></span></span>
5135 </span>
5136 <span>string</span>
5137 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
5138 </span>
5139 </span>
5140 )
5141 </div>
5142
5143 </em>
5144 </dt>
5145 <dd class="todo" style="display: none; ">
5146 Undocumented.
5147 </dd>
5148 <dd>How the requested resource will be used.</dd>
5149 <dd style="display: none; ">
5150 This parameter was added in version
5151 <b><span></span></b>.
5152 You must omit this parameter in earlier versions,
5153 and you may omit it in any version. If you require this
5154 parameter, the manifest key
5155 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5156 can ensure that your extension won't be run in an earlier browser ve rsion.
5157 </dd>
5158
5159 <!-- OBJECT PROPERTIES -->
5160 <dd style="display: none; ">
5161 <dl>
5162 <div>
5163 <div>
5164 </div>
5165 </div>
5166 </dl>
5167 </dd>
5168
5169 <!-- OBJECT METHODS -->
5170 <dd style="display: none; ">
5171 <div></div>
5172 </dd>
5173
5174 <!-- OBJECT EVENT FIELDS -->
5175 <dd style="display: none; ">
5176 <div></div>
5177 </dd>
5178
5179 <!-- FUNCTION PARAMETERS -->
5180 <dd style="display: none; ">
5181 <div></div>
5182 </dd>
5183
5184 </div>
5185 </div><div>
5186 <div>
5187 <dt>
5188 <var>timeStamp</var>
5189 <em>
5190
5191 <!-- TYPE -->
5192 <div style="display:inline">
5193 (
5194 <span class="optional" style="display: none; ">optional</spa n>
5195 <span class="enum" style="display: none; ">enumerated</span>
5196 <span id="typeTemplate">
5197 <span style="display: none; ">
5198 <a> Type</a>
5199 </span>
5200 <span>
5201 <span style="display: none; ">
5202 array of <span><span></span></span>
5203 </span>
5204 <span>number</span>
5205 <span style="display: none; "></span>
5206 </span>
5207 </span>
5208 )
5209 </div>
5210
5211 </em>
5212 </dt>
5213 <dd class="todo" style="display: none; ">
5214 Undocumented.
5215 </dd>
5216 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
5217 <dd style="display: none; ">
5218 This parameter was added in version
5219 <b><span></span></b>.
5220 You must omit this parameter in earlier versions,
5221 and you may omit it in any version. If you require this
5222 parameter, the manifest key
5223 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5224 can ensure that your extension won't be run in an earlier browser ve rsion.
5225 </dd>
5226
5227 <!-- OBJECT PROPERTIES -->
5228 <dd style="display: none; ">
5229 <dl>
5230 <div>
5231 <div>
5232 </div>
5233 </div>
5234 </dl>
5235 </dd>
5236
5237 <!-- OBJECT METHODS -->
5238 <dd style="display: none; ">
5239 <div></div>
5240 </dd>
5241
5242 <!-- OBJECT EVENT FIELDS -->
5243 <dd style="display: none; ">
5244 <div></div>
5245 </dd>
5246
5247 <!-- FUNCTION PARAMETERS -->
5248 <dd style="display: none; ">
5249 <div></div>
5250 </dd>
5251
5252 </div>
5253 </div><div>
5254 <div>
5255 <dt>
5256 <var>requestHeaders</var>
5257 <em>
5258
5259 <!-- TYPE -->
5260 <div style="display:inline">
5261 (
5262 <span class="optional">optional</span>
5263 <span class="enum" style="display: none; ">enumerated</span>
5264 <span id="typeTemplate">
5265 <span>
5266 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
5267 </span>
5268 <span style="display: none; ">
5269 <span>
5270 array of <span><span></span></span>
5271 </span>
5272 <span>paramType</span>
5273 <span></span>
5274 </span>
5275 </span>
5276 )
5277 </div>
5278
5279 </em>
5280 </dt>
5281 <dd class="todo" style="display: none; ">
5282 Undocumented.
5283 </dd>
5284 <dd>The HTTP request headers that are going to be sent out with this r equest.</dd>
5285 <dd style="display: none; ">
5286 This parameter was added in version
5287 <b><span></span></b>.
5288 You must omit this parameter in earlier versions,
5289 and you may omit it in any version. If you require this
5290 parameter, the manifest key
5291 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5292 can ensure that your extension won't be run in an earlier browser ve rsion.
5293 </dd>
5294
5295 <!-- OBJECT PROPERTIES -->
5296 <dd style="display: none; ">
5297 <dl>
5298 <div>
5299 <div>
5300 </div>
5301 </div>
5302 </dl>
5303 </dd>
5304
5305 <!-- OBJECT METHODS -->
5306 <dd style="display: none; ">
5307 <div></div>
5308 </dd>
5309
5310 <!-- OBJECT EVENT FIELDS -->
5311 <dd style="display: none; ">
5312 <div></div>
5313 </dd>
5314
5315 <!-- FUNCTION PARAMETERS -->
5316 <dd style="display: none; ">
5317 <div></div>
5318 </dd>
5319
5320 </div>
5321 </div>
5322 </dl>
5323 </dd>
5324
5325 <!-- OBJECT METHODS -->
5326 <dd style="display: none; ">
5327 <div></div>
5328 </dd>
5329
5330 <!-- OBJECT EVENT FIELDS -->
5331 <dd style="display: none; ">
5332 <div></div>
5333 </dd>
5334
5335 <!-- FUNCTION PARAMETERS -->
5336 <dd style="display: none; ">
5337 <div></div>
5338 </dd>
5339
5340 </div>
5341 </div>
5342 </dl>
5343 </div>
5344
5345 <!-- EXTRA PARAMETERS -->
5346 <div>
5347 <h4>Extra parameters to addListener</h4>
5348 <dl>
5349 <div>
5350 <div>
5351 <dt>
5352 <var>filter</var>
5353 <em>
5354
5355 <!-- TYPE -->
5356 <div style="display:inline">
5357 (
5358 <span class="optional">optional</span>
5359 <span class="enum" style="display: none; ">enumerated</span>
5360 <span id="typeTemplate">
5361 <span>
5362 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
5363 </span>
5364 <span style="display: none; ">
5365 <span>
5366 array of <span><span></span></span>
5367 </span>
5368 <span>paramType</span>
5369 <span></span>
5370 </span>
5371 </span>
5372 )
5373 </div>
5374
5375 </em>
5376 </dt>
5377 <dd class="todo" style="display: none; ">
5378 Undocumented.
5379 </dd>
5380 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
5381 <dd style="display: none; ">
5382 This parameter was added in version
5383 <b><span></span></b>.
5384 You must omit this parameter in earlier versions,
5385 and you may omit it in any version. If you require this
5386 parameter, the manifest key
5387 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5388 can ensure that your extension won't be run in an earlier browser ve rsion.
5389 </dd>
5390
5391 <!-- OBJECT PROPERTIES -->
5392 <dd style="display: none; ">
5393 <dl>
5394 <div>
5395 <div>
5396 </div>
5397 </div>
5398 </dl>
5399 </dd>
5400
5401 <!-- OBJECT METHODS -->
5402 <dd style="display: none; ">
5403 <div></div>
5404 </dd>
5405
5406 <!-- OBJECT EVENT FIELDS -->
5407 <dd style="display: none; ">
5408 <div></div>
5409 </dd>
5410
5411 <!-- FUNCTION PARAMETERS -->
5412 <dd style="display: none; ">
5413 <div></div>
5414 </dd>
5415
5416 </div>
5417 </div><div>
5418 <div>
5419 <dt>
5420 <var>extraInfoSpec</var>
5421 <em>
5422
5423 <!-- TYPE -->
5424 <div style="display:inline">
5425 (
5426 <span class="optional">optional</span>
5427 <span class="enum" style="display: none; ">enumerated</span>
5428 <span id="typeTemplate">
5429 <span style="display: none; ">
5430 <a> Type</a>
5431 </span>
5432 <span>
5433 <span>
5434 array of <span><span>
5435 <span style="display: none; ">
5436 <a> Type</a>
5437 </span>
5438 <span>
5439 <span style="display: none; ">
5440 array of <span><span></span></span>
5441 </span>
5442 <span>string</span>
5443 <span>["requestHeaders", "blocking"]</span>
5444 </span>
5445 </span></span>
5446 </span>
5447 <span style="display: none; ">paramType</span>
5448 <span style="display: none; "></span>
5449 </span>
5450 </span>
5451 )
5452 </div>
5453
5454 </em>
5455 </dt>
5456 <dd class="todo" style="display: none; ">
5457 Undocumented.
5458 </dd>
5459 <dd>Array of extra information that should be passed to the listener f unction.</dd>
5460 <dd style="display: none; ">
5461 This parameter was added in version
5462 <b><span></span></b>.
5463 You must omit this parameter in earlier versions,
5464 and you may omit it in any version. If you require this
5465 parameter, the manifest key
5466 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5467 can ensure that your extension won't be run in an earlier browser ve rsion.
5468 </dd>
5469
5470 <!-- OBJECT PROPERTIES -->
5471 <dd style="display: none; ">
5472 <dl>
5473 <div>
5474 <div>
5475 </div>
5476 </div>
5477 </dl>
5478 </dd>
5479
5480 <!-- OBJECT METHODS -->
5481 <dd style="display: none; ">
5482 <div></div>
5483 </dd>
5484
5485 <!-- OBJECT EVENT FIELDS -->
5486 <dd style="display: none; ">
5487 <div></div>
5488 </dd>
5489
5490 <!-- FUNCTION PARAMETERS -->
5491 <dd style="display: none; ">
5492 <div></div>
5493 </dd>
5494
5495 </div>
5496 </div>
5497 </dl>
5498 </div>
5499
5500 <!-- LISTENER RETURN VALUE -->
5501 <h4>Listener returns</h4>
5502 <dl>
5503 <div>
5504 <div>
5505 <dt>
5506 <var style="display: none; ">paramName</var>
5507 <em>
5508
5509 <!-- TYPE -->
5510 <div style="display:inline">
5511 (
5512 <span class="optional">optional</span>
5513 <span class="enum" style="display: none; ">enumerated</span>
5514 <span id="typeTemplate">
5515 <span>
5516 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a>
5517 </span>
5518 <span style="display: none; ">
5519 <span>
5520 array of <span><span></span></span>
5521 </span>
5522 <span>paramType</span>
5523 <span></span>
5524 </span>
5525 </span>
5526 )
5527 </div>
5528
5529 </em>
5530 </dt>
5531 <dd class="todo" style="display: none; ">
5532 Undocumented.
5533 </dd>
5534 <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the e vent listener should return an object of this type.</dd>
5535 <dd style="display: none; ">
5536 This parameter was added in version
5537 <b><span></span></b>.
5538 You must omit this parameter in earlier versions,
5539 and you may omit it in any version. If you require this
5540 parameter, the manifest key
5541 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5542 can ensure that your extension won't be run in an earlier browser ve rsion.
5543 </dd>
5544
5545 <!-- OBJECT PROPERTIES -->
5546 <dd style="display: none; ">
5547 <dl>
5548 <div>
5549 <div>
5550 </div>
5551 </div>
5552 </dl>
5553 </dd>
5554
5555 <!-- OBJECT METHODS -->
5556 <dd style="display: none; ">
5557 <div></div>
5558 </dd>
5559
5560 <!-- OBJECT EVENT FIELDS -->
5561 <dd style="display: none; ">
5562 <div></div>
5563 </dd>
5564
5565 <!-- FUNCTION PARAMETERS -->
5566 <dd style="display: none; ">
5567 <div></div>
5568 </dd>
5569
5570 </div>
5571 </div>
5572 </dl>
5573
5574 </div> <!-- /description -->
5575 </div><div class="apiItem">
5576 <a name="event-onCompleted"></a>
5577 <h4>onCompleted</h4>
5578
5579 <div class="summary">
5580 <!-- Note: intentionally longer 80 columns -->
5581 <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><span>, RequestFilter filt er, array of string extraInfoSpec</span>);
5582 </div>
5583
5584 <div class="description">
5585 <p class="todo" style="display: none; ">Undocumented.</p>
5586 <p>Fired when a request is completed.</p>
5587
5588 <!-- LISTENER PARAMETERS -->
5589 <div>
5590 <h4>Listener parameters</h4>
5591 <dl>
5592 <div>
5593 <div>
5594 <dt>
5595 <var>details</var>
5596 <em>
5597
5598 <!-- TYPE -->
5599 <div style="display:inline">
5600 (
5601 <span class="optional" style="display: none; ">optional</spa n>
5602 <span class="enum" style="display: none; ">enumerated</span>
5603 <span id="typeTemplate">
5604 <span style="display: none; ">
5605 <a> Type</a>
5606 </span>
5607 <span>
5608 <span style="display: none; ">
5609 array of <span><span></span></span>
5610 </span>
5611 <span>object</span>
5612 <span style="display: none; "></span>
5613 </span>
5614 </span>
5615 )
5616 </div>
5617
5618 </em>
5619 </dt>
5620 <dd class="todo">
5621 Undocumented.
5622 </dd>
5623 <dd style="display: none; ">
5624 Description of this parameter from the json schema.
5625 </dd>
5626 <dd style="display: none; ">
5627 This parameter was added in version
5628 <b><span></span></b>.
5629 You must omit this parameter in earlier versions,
5630 and you may omit it in any version. If you require this
5631 parameter, the manifest key
5632 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5633 can ensure that your extension won't be run in an earlier browser ve rsion.
5634 </dd>
5635
5636 <!-- OBJECT PROPERTIES -->
5637 <dd>
5638 <dl>
5639 <div>
5640 <div>
5641 <dt>
5642 <var>requestId</var>
5643 <em>
5644
5645 <!-- TYPE -->
5646 <div style="display:inline">
5647 (
5648 <span class="optional" style="display: none; ">optional</spa n>
5649 <span class="enum" style="display: none; ">enumerated</span>
5650 <span id="typeTemplate">
5651 <span style="display: none; ">
5652 <a> Type</a>
5653 </span>
5654 <span>
5655 <span style="display: none; ">
5656 array of <span><span></span></span>
5657 </span>
5658 <span>string</span>
5659 <span style="display: none; "></span>
5660 </span>
5661 </span>
5662 )
5663 </div>
5664
5665 </em>
5666 </dt>
5667 <dd class="todo" style="display: none; ">
5668 Undocumented.
5669 </dd>
5670 <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>
5671 <dd style="display: none; ">
5672 This parameter was added in version
5673 <b><span></span></b>.
5674 You must omit this parameter in earlier versions,
5675 and you may omit it in any version. If you require this
5676 parameter, the manifest key
5677 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5678 can ensure that your extension won't be run in an earlier browser ve rsion.
5679 </dd>
5680
5681 <!-- OBJECT PROPERTIES -->
5682 <dd style="display: none; ">
5683 <dl>
5684 <div>
5685 <div>
5686 </div>
5687 </div>
5688 </dl>
5689 </dd>
5690
5691 <!-- OBJECT METHODS -->
5692 <dd style="display: none; ">
5693 <div></div>
5694 </dd>
5695
5696 <!-- OBJECT EVENT FIELDS -->
5697 <dd style="display: none; ">
5698 <div></div>
5699 </dd>
5700
5701 <!-- FUNCTION PARAMETERS -->
5702 <dd style="display: none; ">
5703 <div></div>
5704 </dd>
5705
5706 </div>
5707 </div><div>
5708 <div>
5709 <dt>
5710 <var>url</var>
5711 <em>
5712
5713 <!-- TYPE -->
5714 <div style="display:inline">
5715 (
5716 <span class="optional" style="display: none; ">optional</spa n>
5717 <span class="enum" style="display: none; ">enumerated</span>
5718 <span id="typeTemplate">
5719 <span style="display: none; ">
5720 <a> Type</a>
5721 </span>
5722 <span>
5723 <span style="display: none; ">
5724 array of <span><span></span></span>
5725 </span>
5726 <span>string</span>
5727 <span style="display: none; "></span>
5728 </span>
5729 </span>
5730 )
5731 </div>
5732
5733 </em>
5734 </dt>
5735 <dd class="todo">
5736 Undocumented.
5737 </dd>
5738 <dd style="display: none; ">
5739 Description of this parameter from the json schema.
5740 </dd>
5741 <dd style="display: none; ">
5742 This parameter was added in version
5743 <b><span></span></b>.
5744 You must omit this parameter in earlier versions,
5745 and you may omit it in any version. If you require this
5746 parameter, the manifest key
5747 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5748 can ensure that your extension won't be run in an earlier browser ve rsion.
5749 </dd>
5750
5751 <!-- OBJECT PROPERTIES -->
5752 <dd style="display: none; ">
5753 <dl>
5754 <div>
5755 <div>
5756 </div>
5757 </div>
5758 </dl>
5759 </dd>
5760
5761 <!-- OBJECT METHODS -->
5762 <dd style="display: none; ">
5763 <div></div>
5764 </dd>
5765
5766 <!-- OBJECT EVENT FIELDS -->
5767 <dd style="display: none; ">
5768 <div></div>
5769 </dd>
5770
5771 <!-- FUNCTION PARAMETERS -->
5772 <dd style="display: none; ">
5773 <div></div>
5774 </dd>
5775
5776 </div>
5777 </div><div>
5778 <div>
5779 <dt>
5780 <var>method</var>
5781 <em>
5782
5783 <!-- TYPE -->
5784 <div style="display:inline">
5785 (
5786 <span class="optional" style="display: none; ">optional</spa n>
5787 <span class="enum" style="display: none; ">enumerated</span>
5788 <span id="typeTemplate">
5789 <span style="display: none; ">
5790 <a> Type</a>
5791 </span>
5792 <span>
5793 <span style="display: none; ">
5794 array of <span><span></span></span>
5795 </span>
5796 <span>string</span>
5797 <span style="display: none; "></span>
5798 </span>
5799 </span>
5800 )
5801 </div>
5802
5803 </em>
5804 </dt>
5805 <dd class="todo" style="display: none; ">
5806 Undocumented.
5807 </dd>
5808 <dd>Standard HTTP method.</dd>
5809 <dd style="display: none; ">
5810 This parameter was added in version
5811 <b><span></span></b>.
5812 You must omit this parameter in earlier versions,
5813 and you may omit it in any version. If you require this
5814 parameter, the manifest key
5815 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5816 can ensure that your extension won't be run in an earlier browser ve rsion.
5817 </dd>
5818
5819 <!-- OBJECT PROPERTIES -->
5820 <dd style="display: none; ">
5821 <dl>
5822 <div>
5823 <div>
5824 </div>
5825 </div>
5826 </dl>
5827 </dd>
5828
5829 <!-- OBJECT METHODS -->
5830 <dd style="display: none; ">
5831 <div></div>
5832 </dd>
5833
5834 <!-- OBJECT EVENT FIELDS -->
5835 <dd style="display: none; ">
5836 <div></div>
5837 </dd>
5838
5839 <!-- FUNCTION PARAMETERS -->
5840 <dd style="display: none; ">
5841 <div></div>
5842 </dd>
5843
5844 </div>
5845 </div><div>
5846 <div>
5847 <dt>
5848 <var>frameId</var>
5849 <em>
5850
5851 <!-- TYPE -->
5852 <div style="display:inline">
5853 (
5854 <span class="optional" style="display: none; ">optional</spa n>
5855 <span class="enum" style="display: none; ">enumerated</span>
5856 <span id="typeTemplate">
5857 <span style="display: none; ">
5858 <a> Type</a>
5859 </span>
5860 <span>
5861 <span style="display: none; ">
5862 array of <span><span></span></span>
5863 </span>
5864 <span>integer</span>
5865 <span style="display: none; "></span>
5866 </span>
5867 </span>
5868 )
5869 </div>
5870
5871 </em>
5872 </dt>
5873 <dd class="todo" style="display: none; ">
5874 Undocumented.
5875 </dd>
5876 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
5877 <dd style="display: none; ">
5878 This parameter was added in version
5879 <b><span></span></b>.
5880 You must omit this parameter in earlier versions,
5881 and you may omit it in any version. If you require this
5882 parameter, the manifest key
5883 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5884 can ensure that your extension won't be run in an earlier browser ve rsion.
5885 </dd>
5886
5887 <!-- OBJECT PROPERTIES -->
5888 <dd style="display: none; ">
5889 <dl>
5890 <div>
5891 <div>
5892 </div>
5893 </div>
5894 </dl>
5895 </dd>
5896
5897 <!-- OBJECT METHODS -->
5898 <dd style="display: none; ">
5899 <div></div>
5900 </dd>
5901
5902 <!-- OBJECT EVENT FIELDS -->
5903 <dd style="display: none; ">
5904 <div></div>
5905 </dd>
5906
5907 <!-- FUNCTION PARAMETERS -->
5908 <dd style="display: none; ">
5909 <div></div>
5910 </dd>
5911
5912 </div>
5913 </div><div>
5914 <div>
5915 <dt>
5916 <var>parentFrameId</var>
5917 <em>
5918
5919 <!-- TYPE -->
5920 <div style="display:inline">
5921 (
5922 <span class="optional" style="display: none; ">optional</spa n>
5923 <span class="enum" style="display: none; ">enumerated</span>
5924 <span id="typeTemplate">
5925 <span style="display: none; ">
5926 <a> Type</a>
5927 </span>
5928 <span>
5929 <span style="display: none; ">
5930 array of <span><span></span></span>
5931 </span>
5932 <span>integer</span>
5933 <span style="display: none; "></span>
5934 </span>
5935 </span>
5936 )
5937 </div>
5938
5939 </em>
5940 </dt>
5941 <dd class="todo" style="display: none; ">
5942 Undocumented.
5943 </dd>
5944 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
5945 <dd style="display: none; ">
5946 This parameter was added in version
5947 <b><span></span></b>.
5948 You must omit this parameter in earlier versions,
5949 and you may omit it in any version. If you require this
5950 parameter, the manifest key
5951 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
5952 can ensure that your extension won't be run in an earlier browser ve rsion.
5953 </dd>
5954
5955 <!-- OBJECT PROPERTIES -->
5956 <dd style="display: none; ">
5957 <dl>
5958 <div>
5959 <div>
5960 </div>
5961 </div>
5962 </dl>
5963 </dd>
5964
5965 <!-- OBJECT METHODS -->
5966 <dd style="display: none; ">
5967 <div></div>
5968 </dd>
5969
5970 <!-- OBJECT EVENT FIELDS -->
5971 <dd style="display: none; ">
5972 <div></div>
5973 </dd>
5974
5975 <!-- FUNCTION PARAMETERS -->
5976 <dd style="display: none; ">
5977 <div></div>
5978 </dd>
5979
5980 </div>
5981 </div><div>
5982 <div>
5983 <dt>
5984 <var>tabId</var>
5985 <em>
5986
5987 <!-- TYPE -->
5988 <div style="display:inline">
5989 (
5990 <span class="optional" style="display: none; ">optional</spa n>
5991 <span class="enum" style="display: none; ">enumerated</span>
5992 <span id="typeTemplate">
5993 <span style="display: none; ">
5994 <a> Type</a>
5995 </span>
5996 <span>
5997 <span style="display: none; ">
5998 array of <span><span></span></span>
5999 </span>
6000 <span>integer</span>
6001 <span style="display: none; "></span>
6002 </span>
6003 </span>
6004 )
6005 </div>
6006
6007 </em>
6008 </dt>
6009 <dd class="todo" style="display: none; ">
6010 Undocumented.
6011 </dd>
6012 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
6013 <dd style="display: none; ">
6014 This parameter was added in version
6015 <b><span></span></b>.
6016 You must omit this parameter in earlier versions,
6017 and you may omit it in any version. If you require this
6018 parameter, the manifest key
6019 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6020 can ensure that your extension won't be run in an earlier browser ve rsion.
6021 </dd>
6022
6023 <!-- OBJECT PROPERTIES -->
6024 <dd style="display: none; ">
6025 <dl>
6026 <div>
6027 <div>
6028 </div>
6029 </div>
6030 </dl>
6031 </dd>
6032
6033 <!-- OBJECT METHODS -->
6034 <dd style="display: none; ">
6035 <div></div>
6036 </dd>
6037
6038 <!-- OBJECT EVENT FIELDS -->
6039 <dd style="display: none; ">
6040 <div></div>
6041 </dd>
6042
6043 <!-- FUNCTION PARAMETERS -->
6044 <dd style="display: none; ">
6045 <div></div>
6046 </dd>
6047
6048 </div>
6049 </div><div>
6050 <div>
6051 <dt>
6052 <var>type</var>
6053 <em>
6054
6055 <!-- TYPE -->
6056 <div style="display:inline">
6057 (
6058 <span class="optional" style="display: none; ">optional</spa n>
6059 <span class="enum">enumerated</span>
6060 <span id="typeTemplate">
6061 <span style="display: none; ">
6062 <a> Type</a>
6063 </span>
6064 <span>
6065 <span style="display: none; ">
6066 array of <span><span></span></span>
6067 </span>
6068 <span>string</span>
6069 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
6070 </span>
6071 </span>
6072 )
6073 </div>
6074
6075 </em>
6076 </dt>
6077 <dd class="todo" style="display: none; ">
6078 Undocumented.
6079 </dd>
6080 <dd>How the requested resource will be used.</dd>
6081 <dd style="display: none; ">
6082 This parameter was added in version
6083 <b><span></span></b>.
6084 You must omit this parameter in earlier versions,
6085 and you may omit it in any version. If you require this
6086 parameter, the manifest key
6087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6088 can ensure that your extension won't be run in an earlier browser ve rsion.
6089 </dd>
6090
6091 <!-- OBJECT PROPERTIES -->
6092 <dd style="display: none; ">
6093 <dl>
6094 <div>
6095 <div>
6096 </div>
6097 </div>
6098 </dl>
6099 </dd>
6100
6101 <!-- OBJECT METHODS -->
6102 <dd style="display: none; ">
6103 <div></div>
6104 </dd>
6105
6106 <!-- OBJECT EVENT FIELDS -->
6107 <dd style="display: none; ">
6108 <div></div>
6109 </dd>
6110
6111 <!-- FUNCTION PARAMETERS -->
6112 <dd style="display: none; ">
6113 <div></div>
6114 </dd>
6115
6116 </div>
6117 </div><div>
6118 <div>
6119 <dt>
6120 <var>timeStamp</var>
6121 <em>
6122
6123 <!-- TYPE -->
6124 <div style="display:inline">
6125 (
6126 <span class="optional" style="display: none; ">optional</spa n>
6127 <span class="enum" style="display: none; ">enumerated</span>
6128 <span id="typeTemplate">
6129 <span style="display: none; ">
6130 <a> Type</a>
6131 </span>
6132 <span>
6133 <span style="display: none; ">
6134 array of <span><span></span></span>
6135 </span>
6136 <span>number</span>
6137 <span style="display: none; "></span>
6138 </span>
6139 </span>
6140 )
6141 </div>
6142
6143 </em>
6144 </dt>
6145 <dd class="todo" style="display: none; ">
6146 Undocumented.
6147 </dd>
6148 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
6149 <dd style="display: none; ">
6150 This parameter was added in version
6151 <b><span></span></b>.
6152 You must omit this parameter in earlier versions,
6153 and you may omit it in any version. If you require this
6154 parameter, the manifest key
6155 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6156 can ensure that your extension won't be run in an earlier browser ve rsion.
6157 </dd>
6158
6159 <!-- OBJECT PROPERTIES -->
6160 <dd style="display: none; ">
6161 <dl>
6162 <div>
6163 <div>
6164 </div>
6165 </div>
6166 </dl>
6167 </dd>
6168
6169 <!-- OBJECT METHODS -->
6170 <dd style="display: none; ">
6171 <div></div>
6172 </dd>
6173
6174 <!-- OBJECT EVENT FIELDS -->
6175 <dd style="display: none; ">
6176 <div></div>
6177 </dd>
6178
6179 <!-- FUNCTION PARAMETERS -->
6180 <dd style="display: none; ">
6181 <div></div>
6182 </dd>
6183
6184 </div>
6185 </div><div>
6186 <div>
6187 <dt>
6188 <var>ip</var>
6189 <em>
6190
6191 <!-- TYPE -->
6192 <div style="display:inline">
6193 (
6194 <span class="optional">optional</span>
6195 <span class="enum" style="display: none; ">enumerated</span>
6196 <span id="typeTemplate">
6197 <span style="display: none; ">
6198 <a> Type</a>
6199 </span>
6200 <span>
6201 <span style="display: none; ">
6202 array of <span><span></span></span>
6203 </span>
6204 <span>string</span>
6205 <span style="display: none; "></span>
6206 </span>
6207 </span>
6208 )
6209 </div>
6210
6211 </em>
6212 </dt>
6213 <dd class="todo" style="display: none; ">
6214 Undocumented.
6215 </dd>
6216 <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
6217 <dd style="display: none; ">
6218 This parameter was added in version
6219 <b><span></span></b>.
6220 You must omit this parameter in earlier versions,
6221 and you may omit it in any version. If you require this
6222 parameter, the manifest key
6223 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6224 can ensure that your extension won't be run in an earlier browser ve rsion.
6225 </dd>
6226
6227 <!-- OBJECT PROPERTIES -->
6228 <dd style="display: none; ">
6229 <dl>
6230 <div>
6231 <div>
6232 </div>
6233 </div>
6234 </dl>
6235 </dd>
6236
6237 <!-- OBJECT METHODS -->
6238 <dd style="display: none; ">
6239 <div></div>
6240 </dd>
6241
6242 <!-- OBJECT EVENT FIELDS -->
6243 <dd style="display: none; ">
6244 <div></div>
6245 </dd>
6246
6247 <!-- FUNCTION PARAMETERS -->
6248 <dd style="display: none; ">
6249 <div></div>
6250 </dd>
6251
6252 </div>
6253 </div><div>
6254 <div>
6255 <dt>
6256 <var>fromCache</var>
6257 <em>
6258
6259 <!-- TYPE -->
6260 <div style="display:inline">
6261 (
6262 <span class="optional" style="display: none; ">optional</spa n>
6263 <span class="enum" style="display: none; ">enumerated</span>
6264 <span id="typeTemplate">
6265 <span style="display: none; ">
6266 <a> Type</a>
6267 </span>
6268 <span>
6269 <span style="display: none; ">
6270 array of <span><span></span></span>
6271 </span>
6272 <span>boolean</span>
6273 <span style="display: none; "></span>
6274 </span>
6275 </span>
6276 )
6277 </div>
6278
6279 </em>
6280 </dt>
6281 <dd class="todo" style="display: none; ">
6282 Undocumented.
6283 </dd>
6284 <dd>Indicates if this response was fetched from disk cache.</dd>
6285 <dd style="display: none; ">
6286 This parameter was added in version
6287 <b><span></span></b>.
6288 You must omit this parameter in earlier versions,
6289 and you may omit it in any version. If you require this
6290 parameter, the manifest key
6291 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6292 can ensure that your extension won't be run in an earlier browser ve rsion.
6293 </dd>
6294
6295 <!-- OBJECT PROPERTIES -->
6296 <dd style="display: none; ">
6297 <dl>
6298 <div>
6299 <div>
6300 </div>
6301 </div>
6302 </dl>
6303 </dd>
6304
6305 <!-- OBJECT METHODS -->
6306 <dd style="display: none; ">
6307 <div></div>
6308 </dd>
6309
6310 <!-- OBJECT EVENT FIELDS -->
6311 <dd style="display: none; ">
6312 <div></div>
6313 </dd>
6314
6315 <!-- FUNCTION PARAMETERS -->
6316 <dd style="display: none; ">
6317 <div></div>
6318 </dd>
6319
6320 </div>
6321 </div><div>
6322 <div>
6323 <dt>
6324 <var>statusCode</var>
6325 <em>
6326
6327 <!-- TYPE -->
6328 <div style="display:inline">
6329 (
6330 <span class="optional" style="display: none; ">optional</spa n>
6331 <span class="enum" style="display: none; ">enumerated</span>
6332 <span id="typeTemplate">
6333 <span style="display: none; ">
6334 <a> Type</a>
6335 </span>
6336 <span>
6337 <span style="display: none; ">
6338 array of <span><span></span></span>
6339 </span>
6340 <span>integer</span>
6341 <span style="display: none; "></span>
6342 </span>
6343 </span>
6344 )
6345 </div>
6346
6347 </em>
6348 </dt>
6349 <dd class="todo" style="display: none; ">
6350 Undocumented.
6351 </dd>
6352 <dd>Standard HTTP status code returned by the server.</dd>
6353 <dd style="display: none; ">
6354 This parameter was added in version
6355 <b><span></span></b>.
6356 You must omit this parameter in earlier versions,
6357 and you may omit it in any version. If you require this
6358 parameter, the manifest key
6359 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6360 can ensure that your extension won't be run in an earlier browser ve rsion.
6361 </dd>
6362
6363 <!-- OBJECT PROPERTIES -->
6364 <dd style="display: none; ">
6365 <dl>
6366 <div>
6367 <div>
6368 </div>
6369 </div>
6370 </dl>
6371 </dd>
6372
6373 <!-- OBJECT METHODS -->
6374 <dd style="display: none; ">
6375 <div></div>
6376 </dd>
6377
6378 <!-- OBJECT EVENT FIELDS -->
6379 <dd style="display: none; ">
6380 <div></div>
6381 </dd>
6382
6383 <!-- FUNCTION PARAMETERS -->
6384 <dd style="display: none; ">
6385 <div></div>
6386 </dd>
6387
6388 </div>
6389 </div><div>
6390 <div>
6391 <dt>
6392 <var>responseHeaders</var>
6393 <em>
6394
6395 <!-- TYPE -->
6396 <div style="display:inline">
6397 (
6398 <span class="optional">optional</span>
6399 <span class="enum" style="display: none; ">enumerated</span>
6400 <span id="typeTemplate">
6401 <span>
6402 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
6403 </span>
6404 <span style="display: none; ">
6405 <span>
6406 array of <span><span></span></span>
6407 </span>
6408 <span>paramType</span>
6409 <span></span>
6410 </span>
6411 </span>
6412 )
6413 </div>
6414
6415 </em>
6416 </dt>
6417 <dd class="todo" style="display: none; ">
6418 Undocumented.
6419 </dd>
6420 <dd>The HTTP response headers that were received along with this respo nse.</dd>
6421 <dd style="display: none; ">
6422 This parameter was added in version
6423 <b><span></span></b>.
6424 You must omit this parameter in earlier versions,
6425 and you may omit it in any version. If you require this
6426 parameter, the manifest key
6427 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6428 can ensure that your extension won't be run in an earlier browser ve rsion.
6429 </dd>
6430
6431 <!-- OBJECT PROPERTIES -->
6432 <dd style="display: none; ">
6433 <dl>
6434 <div>
6435 <div>
6436 </div>
6437 </div>
6438 </dl>
6439 </dd>
6440
6441 <!-- OBJECT METHODS -->
6442 <dd style="display: none; ">
6443 <div></div>
6444 </dd>
6445
6446 <!-- OBJECT EVENT FIELDS -->
6447 <dd style="display: none; ">
6448 <div></div>
6449 </dd>
6450
6451 <!-- FUNCTION PARAMETERS -->
6452 <dd style="display: none; ">
6453 <div></div>
6454 </dd>
6455
6456 </div>
6457 </div><div>
6458 <div>
6459 <dt>
6460 <var>statusLine</var>
6461 <em>
6462
6463 <!-- TYPE -->
6464 <div style="display:inline">
6465 (
6466 <span class="optional">optional</span>
6467 <span class="enum" style="display: none; ">enumerated</span>
6468 <span id="typeTemplate">
6469 <span style="display: none; ">
6470 <a> Type</a>
6471 </span>
6472 <span>
6473 <span style="display: none; ">
6474 array of <span><span></span></span>
6475 </span>
6476 <span>string</span>
6477 <span style="display: none; "></span>
6478 </span>
6479 </span>
6480 )
6481 </div>
6482
6483 </em>
6484 </dt>
6485 <dd class="todo" style="display: none; ">
6486 Undocumented.
6487 </dd>
6488 <dd>HTTP status line of the response</dd>
6489 <dd style="display: none; ">
6490 This parameter was added in version
6491 <b><span></span></b>.
6492 You must omit this parameter in earlier versions,
6493 and you may omit it in any version. If you require this
6494 parameter, the manifest key
6495 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6496 can ensure that your extension won't be run in an earlier browser ve rsion.
6497 </dd>
6498
6499 <!-- OBJECT PROPERTIES -->
6500 <dd style="display: none; ">
6501 <dl>
6502 <div>
6503 <div>
6504 </div>
6505 </div>
6506 </dl>
6507 </dd>
6508
6509 <!-- OBJECT METHODS -->
6510 <dd style="display: none; ">
6511 <div></div>
6512 </dd>
6513
6514 <!-- OBJECT EVENT FIELDS -->
6515 <dd style="display: none; ">
6516 <div></div>
6517 </dd>
6518
6519 <!-- FUNCTION PARAMETERS -->
6520 <dd style="display: none; ">
6521 <div></div>
6522 </dd>
6523
6524 </div>
6525 </div>
6526 </dl>
6527 </dd>
6528
6529 <!-- OBJECT METHODS -->
6530 <dd style="display: none; ">
6531 <div></div>
6532 </dd>
6533
6534 <!-- OBJECT EVENT FIELDS -->
6535 <dd style="display: none; ">
6536 <div></div>
6537 </dd>
6538
6539 <!-- FUNCTION PARAMETERS -->
6540 <dd style="display: none; ">
6541 <div></div>
6542 </dd>
6543
6544 </div>
6545 </div>
6546 </dl>
6547 </div>
6548
6549 <!-- EXTRA PARAMETERS -->
6550 <div>
6551 <h4>Extra parameters to addListener</h4>
6552 <dl>
6553 <div>
6554 <div>
6555 <dt>
6556 <var>filter</var>
6557 <em>
6558
6559 <!-- TYPE -->
6560 <div style="display:inline">
6561 (
6562 <span class="optional">optional</span>
6563 <span class="enum" style="display: none; ">enumerated</span>
6564 <span id="typeTemplate">
6565 <span>
6566 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
6567 </span>
6568 <span style="display: none; ">
6569 <span>
6570 array of <span><span></span></span>
6571 </span>
6572 <span>paramType</span>
6573 <span></span>
6574 </span>
6575 </span>
6576 )
6577 </div>
6578
6579 </em>
6580 </dt>
6581 <dd class="todo" style="display: none; ">
6582 Undocumented.
6583 </dd>
6584 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
6585 <dd style="display: none; ">
6586 This parameter was added in version
6587 <b><span></span></b>.
6588 You must omit this parameter in earlier versions,
6589 and you may omit it in any version. If you require this
6590 parameter, the manifest key
6591 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6592 can ensure that your extension won't be run in an earlier browser ve rsion.
6593 </dd>
6594
6595 <!-- OBJECT PROPERTIES -->
6596 <dd style="display: none; ">
6597 <dl>
6598 <div>
6599 <div>
6600 </div>
6601 </div>
6602 </dl>
6603 </dd>
6604
6605 <!-- OBJECT METHODS -->
6606 <dd style="display: none; ">
6607 <div></div>
6608 </dd>
6609
6610 <!-- OBJECT EVENT FIELDS -->
6611 <dd style="display: none; ">
6612 <div></div>
6613 </dd>
6614
6615 <!-- FUNCTION PARAMETERS -->
6616 <dd style="display: none; ">
6617 <div></div>
6618 </dd>
6619
6620 </div>
6621 </div><div>
6622 <div>
6623 <dt>
6624 <var>extraInfoSpec</var>
6625 <em>
6626
6627 <!-- TYPE -->
6628 <div style="display:inline">
6629 (
6630 <span class="optional">optional</span>
6631 <span class="enum" style="display: none; ">enumerated</span>
6632 <span id="typeTemplate">
6633 <span style="display: none; ">
6634 <a> Type</a>
6635 </span>
6636 <span>
6637 <span>
6638 array of <span><span>
6639 <span style="display: none; ">
6640 <a> Type</a>
6641 </span>
6642 <span>
6643 <span style="display: none; ">
6644 array of <span><span></span></span>
6645 </span>
6646 <span>string</span>
6647 <span>["responseHeaders"]</span>
6648 </span>
6649 </span></span>
6650 </span>
6651 <span style="display: none; ">paramType</span>
6652 <span style="display: none; "></span>
6653 </span>
6654 </span>
6655 )
6656 </div>
6657
6658 </em>
6659 </dt>
6660 <dd class="todo" style="display: none; ">
6661 Undocumented.
6662 </dd>
6663 <dd>Array of extra information that should be passed to the listener f unction.</dd>
6664 <dd style="display: none; ">
6665 This parameter was added in version
6666 <b><span></span></b>.
6667 You must omit this parameter in earlier versions,
6668 and you may omit it in any version. If you require this
6669 parameter, the manifest key
6670 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6671 can ensure that your extension won't be run in an earlier browser ve rsion.
6672 </dd>
6673
6674 <!-- OBJECT PROPERTIES -->
6675 <dd style="display: none; ">
6676 <dl>
6677 <div>
6678 <div>
6679 </div>
6680 </div>
6681 </dl>
6682 </dd>
6683
6684 <!-- OBJECT METHODS -->
6685 <dd style="display: none; ">
6686 <div></div>
6687 </dd>
6688
6689 <!-- OBJECT EVENT FIELDS -->
6690 <dd style="display: none; ">
6691 <div></div>
6692 </dd>
6693
6694 <!-- FUNCTION PARAMETERS -->
6695 <dd style="display: none; ">
6696 <div></div>
6697 </dd>
6698
6699 </div>
6700 </div>
6701 </dl>
6702 </div>
6703
6704 <!-- LISTENER RETURN VALUE -->
6705 <h4 style="display: none; ">Listener returns</h4>
6706 <dl>
6707 <div style="display: none; ">
6708 <div>
6709 </div>
6710 </div>
6711 </dl>
6712
6713 </div> <!-- /description -->
6714 </div><div class="apiItem">
6715 <a name="event-onErrorOccurred"></a>
6716 <h4>onErrorOccurred</h4>
6717
6718 <div class="summary">
6719 <!-- Note: intentionally longer 80 columns -->
6720 <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><span>, RequestFilter filter</span>);
6721 </div>
6722
6723 <div class="description">
6724 <p class="todo" style="display: none; ">Undocumented.</p>
6725 <p>Fired when an error occurs.</p>
6726
6727 <!-- LISTENER PARAMETERS -->
6728 <div>
6729 <h4>Listener parameters</h4>
6730 <dl>
6731 <div>
6732 <div>
6733 <dt>
6734 <var>details</var>
6735 <em>
6736
6737 <!-- TYPE -->
6738 <div style="display:inline">
6739 (
6740 <span class="optional" style="display: none; ">optional</spa n>
6741 <span class="enum" style="display: none; ">enumerated</span>
6742 <span id="typeTemplate">
6743 <span style="display: none; ">
6744 <a> Type</a>
6745 </span>
6746 <span>
6747 <span style="display: none; ">
6748 array of <span><span></span></span>
6749 </span>
6750 <span>object</span>
6751 <span style="display: none; "></span>
6752 </span>
6753 </span>
6754 )
6755 </div>
6756
6757 </em>
6758 </dt>
6759 <dd class="todo">
6760 Undocumented.
6761 </dd>
6762 <dd style="display: none; ">
6763 Description of this parameter from the json schema.
6764 </dd>
6765 <dd style="display: none; ">
6766 This parameter was added in version
6767 <b><span></span></b>.
6768 You must omit this parameter in earlier versions,
6769 and you may omit it in any version. If you require this
6770 parameter, the manifest key
6771 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6772 can ensure that your extension won't be run in an earlier browser ve rsion.
6773 </dd>
6774
6775 <!-- OBJECT PROPERTIES -->
6776 <dd>
6777 <dl>
6778 <div>
6779 <div>
6780 <dt>
6781 <var>requestId</var>
6782 <em>
6783
6784 <!-- TYPE -->
6785 <div style="display:inline">
6786 (
6787 <span class="optional" style="display: none; ">optional</spa n>
6788 <span class="enum" style="display: none; ">enumerated</span>
6789 <span id="typeTemplate">
6790 <span style="display: none; ">
6791 <a> Type</a>
6792 </span>
6793 <span>
6794 <span style="display: none; ">
6795 array of <span><span></span></span>
6796 </span>
6797 <span>string</span>
6798 <span style="display: none; "></span>
6799 </span>
6800 </span>
6801 )
6802 </div>
6803
6804 </em>
6805 </dt>
6806 <dd class="todo" style="display: none; ">
6807 Undocumented.
6808 </dd>
6809 <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>
6810 <dd style="display: none; ">
6811 This parameter was added in version
6812 <b><span></span></b>.
6813 You must omit this parameter in earlier versions,
6814 and you may omit it in any version. If you require this
6815 parameter, the manifest key
6816 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6817 can ensure that your extension won't be run in an earlier browser ve rsion.
6818 </dd>
6819
6820 <!-- OBJECT PROPERTIES -->
6821 <dd style="display: none; ">
6822 <dl>
6823 <div>
6824 <div>
6825 </div>
6826 </div>
6827 </dl>
6828 </dd>
6829
6830 <!-- OBJECT METHODS -->
6831 <dd style="display: none; ">
6832 <div></div>
6833 </dd>
6834
6835 <!-- OBJECT EVENT FIELDS -->
6836 <dd style="display: none; ">
6837 <div></div>
6838 </dd>
6839
6840 <!-- FUNCTION PARAMETERS -->
6841 <dd style="display: none; ">
6842 <div></div>
6843 </dd>
6844
6845 </div>
6846 </div><div>
6847 <div>
6848 <dt>
6849 <var>url</var>
6850 <em>
6851
6852 <!-- TYPE -->
6853 <div style="display:inline">
6854 (
6855 <span class="optional" style="display: none; ">optional</spa n>
6856 <span class="enum" style="display: none; ">enumerated</span>
6857 <span id="typeTemplate">
6858 <span style="display: none; ">
6859 <a> Type</a>
6860 </span>
6861 <span>
6862 <span style="display: none; ">
6863 array of <span><span></span></span>
6864 </span>
6865 <span>string</span>
6866 <span style="display: none; "></span>
6867 </span>
6868 </span>
6869 )
6870 </div>
6871
6872 </em>
6873 </dt>
6874 <dd class="todo">
6875 Undocumented.
6876 </dd>
6877 <dd style="display: none; ">
6878 Description of this parameter from the json schema.
6879 </dd>
6880 <dd style="display: none; ">
6881 This parameter was added in version
6882 <b><span></span></b>.
6883 You must omit this parameter in earlier versions,
6884 and you may omit it in any version. If you require this
6885 parameter, the manifest key
6886 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6887 can ensure that your extension won't be run in an earlier browser ve rsion.
6888 </dd>
6889
6890 <!-- OBJECT PROPERTIES -->
6891 <dd style="display: none; ">
6892 <dl>
6893 <div>
6894 <div>
6895 </div>
6896 </div>
6897 </dl>
6898 </dd>
6899
6900 <!-- OBJECT METHODS -->
6901 <dd style="display: none; ">
6902 <div></div>
6903 </dd>
6904
6905 <!-- OBJECT EVENT FIELDS -->
6906 <dd style="display: none; ">
6907 <div></div>
6908 </dd>
6909
6910 <!-- FUNCTION PARAMETERS -->
6911 <dd style="display: none; ">
6912 <div></div>
6913 </dd>
6914
6915 </div>
6916 </div><div>
6917 <div>
6918 <dt>
6919 <var>method</var>
6920 <em>
6921
6922 <!-- TYPE -->
6923 <div style="display:inline">
6924 (
6925 <span class="optional" style="display: none; ">optional</spa n>
6926 <span class="enum" style="display: none; ">enumerated</span>
6927 <span id="typeTemplate">
6928 <span style="display: none; ">
6929 <a> Type</a>
6930 </span>
6931 <span>
6932 <span style="display: none; ">
6933 array of <span><span></span></span>
6934 </span>
6935 <span>string</span>
6936 <span style="display: none; "></span>
6937 </span>
6938 </span>
6939 )
6940 </div>
6941
6942 </em>
6943 </dt>
6944 <dd class="todo" style="display: none; ">
6945 Undocumented.
6946 </dd>
6947 <dd>Standard HTTP method.</dd>
6948 <dd style="display: none; ">
6949 This parameter was added in version
6950 <b><span></span></b>.
6951 You must omit this parameter in earlier versions,
6952 and you may omit it in any version. If you require this
6953 parameter, the manifest key
6954 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
6955 can ensure that your extension won't be run in an earlier browser ve rsion.
6956 </dd>
6957
6958 <!-- OBJECT PROPERTIES -->
6959 <dd style="display: none; ">
6960 <dl>
6961 <div>
6962 <div>
6963 </div>
6964 </div>
6965 </dl>
6966 </dd>
6967
6968 <!-- OBJECT METHODS -->
6969 <dd style="display: none; ">
6970 <div></div>
6971 </dd>
6972
6973 <!-- OBJECT EVENT FIELDS -->
6974 <dd style="display: none; ">
6975 <div></div>
6976 </dd>
6977
6978 <!-- FUNCTION PARAMETERS -->
6979 <dd style="display: none; ">
6980 <div></div>
6981 </dd>
6982
6983 </div>
6984 </div><div>
6985 <div>
6986 <dt>
6987 <var>frameId</var>
6988 <em>
6989
6990 <!-- TYPE -->
6991 <div style="display:inline">
6992 (
6993 <span class="optional" style="display: none; ">optional</spa n>
6994 <span class="enum" style="display: none; ">enumerated</span>
6995 <span id="typeTemplate">
6996 <span style="display: none; ">
6997 <a> Type</a>
6998 </span>
6999 <span>
7000 <span style="display: none; ">
7001 array of <span><span></span></span>
7002 </span>
7003 <span>integer</span>
7004 <span style="display: none; "></span>
7005 </span>
7006 </span>
7007 )
7008 </div>
7009
7010 </em>
7011 </dt>
7012 <dd class="todo" style="display: none; ">
7013 Undocumented.
7014 </dd>
7015 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
7016 <dd style="display: none; ">
7017 This parameter was added in version
7018 <b><span></span></b>.
7019 You must omit this parameter in earlier versions,
7020 and you may omit it in any version. If you require this
7021 parameter, the manifest key
7022 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7023 can ensure that your extension won't be run in an earlier browser ve rsion.
7024 </dd>
7025
7026 <!-- OBJECT PROPERTIES -->
7027 <dd style="display: none; ">
7028 <dl>
7029 <div>
7030 <div>
7031 </div>
7032 </div>
7033 </dl>
7034 </dd>
7035
7036 <!-- OBJECT METHODS -->
7037 <dd style="display: none; ">
7038 <div></div>
7039 </dd>
7040
7041 <!-- OBJECT EVENT FIELDS -->
7042 <dd style="display: none; ">
7043 <div></div>
7044 </dd>
7045
7046 <!-- FUNCTION PARAMETERS -->
7047 <dd style="display: none; ">
7048 <div></div>
7049 </dd>
7050
7051 </div>
7052 </div><div>
7053 <div>
7054 <dt>
7055 <var>parentFrameId</var>
7056 <em>
7057
7058 <!-- TYPE -->
7059 <div style="display:inline">
7060 (
7061 <span class="optional" style="display: none; ">optional</spa n>
7062 <span class="enum" style="display: none; ">enumerated</span>
7063 <span id="typeTemplate">
7064 <span style="display: none; ">
7065 <a> Type</a>
7066 </span>
7067 <span>
7068 <span style="display: none; ">
7069 array of <span><span></span></span>
7070 </span>
7071 <span>integer</span>
7072 <span style="display: none; "></span>
7073 </span>
7074 </span>
7075 )
7076 </div>
7077
7078 </em>
7079 </dt>
7080 <dd class="todo" style="display: none; ">
7081 Undocumented.
7082 </dd>
7083 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
7084 <dd style="display: none; ">
7085 This parameter was added in version
7086 <b><span></span></b>.
7087 You must omit this parameter in earlier versions,
7088 and you may omit it in any version. If you require this
7089 parameter, the manifest key
7090 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7091 can ensure that your extension won't be run in an earlier browser ve rsion.
7092 </dd>
7093
7094 <!-- OBJECT PROPERTIES -->
7095 <dd style="display: none; ">
7096 <dl>
7097 <div>
7098 <div>
7099 </div>
7100 </div>
7101 </dl>
7102 </dd>
7103
7104 <!-- OBJECT METHODS -->
7105 <dd style="display: none; ">
7106 <div></div>
7107 </dd>
7108
7109 <!-- OBJECT EVENT FIELDS -->
7110 <dd style="display: none; ">
7111 <div></div>
7112 </dd>
7113
7114 <!-- FUNCTION PARAMETERS -->
7115 <dd style="display: none; ">
7116 <div></div>
7117 </dd>
7118
7119 </div>
7120 </div><div>
7121 <div>
7122 <dt>
7123 <var>tabId</var>
7124 <em>
7125
7126 <!-- TYPE -->
7127 <div style="display:inline">
7128 (
7129 <span class="optional" style="display: none; ">optional</spa n>
7130 <span class="enum" style="display: none; ">enumerated</span>
7131 <span id="typeTemplate">
7132 <span style="display: none; ">
7133 <a> Type</a>
7134 </span>
7135 <span>
7136 <span style="display: none; ">
7137 array of <span><span></span></span>
7138 </span>
7139 <span>integer</span>
7140 <span style="display: none; "></span>
7141 </span>
7142 </span>
7143 )
7144 </div>
7145
7146 </em>
7147 </dt>
7148 <dd class="todo" style="display: none; ">
7149 Undocumented.
7150 </dd>
7151 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
7152 <dd style="display: none; ">
7153 This parameter was added in version
7154 <b><span></span></b>.
7155 You must omit this parameter in earlier versions,
7156 and you may omit it in any version. If you require this
7157 parameter, the manifest key
7158 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7159 can ensure that your extension won't be run in an earlier browser ve rsion.
7160 </dd>
7161
7162 <!-- OBJECT PROPERTIES -->
7163 <dd style="display: none; ">
7164 <dl>
7165 <div>
7166 <div>
7167 </div>
7168 </div>
7169 </dl>
7170 </dd>
7171
7172 <!-- OBJECT METHODS -->
7173 <dd style="display: none; ">
7174 <div></div>
7175 </dd>
7176
7177 <!-- OBJECT EVENT FIELDS -->
7178 <dd style="display: none; ">
7179 <div></div>
7180 </dd>
7181
7182 <!-- FUNCTION PARAMETERS -->
7183 <dd style="display: none; ">
7184 <div></div>
7185 </dd>
7186
7187 </div>
7188 </div><div>
7189 <div>
7190 <dt>
7191 <var>type</var>
7192 <em>
7193
7194 <!-- TYPE -->
7195 <div style="display:inline">
7196 (
7197 <span class="optional" style="display: none; ">optional</spa n>
7198 <span class="enum">enumerated</span>
7199 <span id="typeTemplate">
7200 <span style="display: none; ">
7201 <a> Type</a>
7202 </span>
7203 <span>
7204 <span style="display: none; ">
7205 array of <span><span></span></span>
7206 </span>
7207 <span>string</span>
7208 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
7209 </span>
7210 </span>
7211 )
7212 </div>
7213
7214 </em>
7215 </dt>
7216 <dd class="todo" style="display: none; ">
7217 Undocumented.
7218 </dd>
7219 <dd>How the requested resource will be used.</dd>
7220 <dd style="display: none; ">
7221 This parameter was added in version
7222 <b><span></span></b>.
7223 You must omit this parameter in earlier versions,
7224 and you may omit it in any version. If you require this
7225 parameter, the manifest key
7226 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7227 can ensure that your extension won't be run in an earlier browser ve rsion.
7228 </dd>
7229
7230 <!-- OBJECT PROPERTIES -->
7231 <dd style="display: none; ">
7232 <dl>
7233 <div>
7234 <div>
7235 </div>
7236 </div>
7237 </dl>
7238 </dd>
7239
7240 <!-- OBJECT METHODS -->
7241 <dd style="display: none; ">
7242 <div></div>
7243 </dd>
7244
7245 <!-- OBJECT EVENT FIELDS -->
7246 <dd style="display: none; ">
7247 <div></div>
7248 </dd>
7249
7250 <!-- FUNCTION PARAMETERS -->
7251 <dd style="display: none; ">
7252 <div></div>
7253 </dd>
7254
7255 </div>
7256 </div><div>
7257 <div>
7258 <dt>
7259 <var>timeStamp</var>
7260 <em>
7261
7262 <!-- TYPE -->
7263 <div style="display:inline">
7264 (
7265 <span class="optional" style="display: none; ">optional</spa n>
7266 <span class="enum" style="display: none; ">enumerated</span>
7267 <span id="typeTemplate">
7268 <span style="display: none; ">
7269 <a> Type</a>
7270 </span>
7271 <span>
7272 <span style="display: none; ">
7273 array of <span><span></span></span>
7274 </span>
7275 <span>number</span>
7276 <span style="display: none; "></span>
7277 </span>
7278 </span>
7279 )
7280 </div>
7281
7282 </em>
7283 </dt>
7284 <dd class="todo" style="display: none; ">
7285 Undocumented.
7286 </dd>
7287 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
7288 <dd style="display: none; ">
7289 This parameter was added in version
7290 <b><span></span></b>.
7291 You must omit this parameter in earlier versions,
7292 and you may omit it in any version. If you require this
7293 parameter, the manifest key
7294 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7295 can ensure that your extension won't be run in an earlier browser ve rsion.
7296 </dd>
7297
7298 <!-- OBJECT PROPERTIES -->
7299 <dd style="display: none; ">
7300 <dl>
7301 <div>
7302 <div>
7303 </div>
7304 </div>
7305 </dl>
7306 </dd>
7307
7308 <!-- OBJECT METHODS -->
7309 <dd style="display: none; ">
7310 <div></div>
7311 </dd>
7312
7313 <!-- OBJECT EVENT FIELDS -->
7314 <dd style="display: none; ">
7315 <div></div>
7316 </dd>
7317
7318 <!-- FUNCTION PARAMETERS -->
7319 <dd style="display: none; ">
7320 <div></div>
7321 </dd>
7322
7323 </div>
7324 </div><div>
7325 <div>
7326 <dt>
7327 <var>ip</var>
7328 <em>
7329
7330 <!-- TYPE -->
7331 <div style="display:inline">
7332 (
7333 <span class="optional">optional</span>
7334 <span class="enum" style="display: none; ">enumerated</span>
7335 <span id="typeTemplate">
7336 <span style="display: none; ">
7337 <a> Type</a>
7338 </span>
7339 <span>
7340 <span style="display: none; ">
7341 array of <span><span></span></span>
7342 </span>
7343 <span>string</span>
7344 <span style="display: none; "></span>
7345 </span>
7346 </span>
7347 )
7348 </div>
7349
7350 </em>
7351 </dt>
7352 <dd class="todo" style="display: none; ">
7353 Undocumented.
7354 </dd>
7355 <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
7356 <dd style="display: none; ">
7357 This parameter was added in version
7358 <b><span></span></b>.
7359 You must omit this parameter in earlier versions,
7360 and you may omit it in any version. If you require this
7361 parameter, the manifest key
7362 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7363 can ensure that your extension won't be run in an earlier browser ve rsion.
7364 </dd>
7365
7366 <!-- OBJECT PROPERTIES -->
7367 <dd style="display: none; ">
7368 <dl>
7369 <div>
7370 <div>
7371 </div>
7372 </div>
7373 </dl>
7374 </dd>
7375
7376 <!-- OBJECT METHODS -->
7377 <dd style="display: none; ">
7378 <div></div>
7379 </dd>
7380
7381 <!-- OBJECT EVENT FIELDS -->
7382 <dd style="display: none; ">
7383 <div></div>
7384 </dd>
7385
7386 <!-- FUNCTION PARAMETERS -->
7387 <dd style="display: none; ">
7388 <div></div>
7389 </dd>
7390
7391 </div>
7392 </div><div>
7393 <div>
7394 <dt>
7395 <var>fromCache</var>
7396 <em>
7397
7398 <!-- TYPE -->
7399 <div style="display:inline">
7400 (
7401 <span class="optional" style="display: none; ">optional</spa n>
7402 <span class="enum" style="display: none; ">enumerated</span>
7403 <span id="typeTemplate">
7404 <span style="display: none; ">
7405 <a> Type</a>
7406 </span>
7407 <span>
7408 <span style="display: none; ">
7409 array of <span><span></span></span>
7410 </span>
7411 <span>boolean</span>
7412 <span style="display: none; "></span>
7413 </span>
7414 </span>
7415 )
7416 </div>
7417
7418 </em>
7419 </dt>
7420 <dd class="todo" style="display: none; ">
7421 Undocumented.
7422 </dd>
7423 <dd>Indicates if this response was fetched from disk cache.</dd>
7424 <dd style="display: none; ">
7425 This parameter was added in version
7426 <b><span></span></b>.
7427 You must omit this parameter in earlier versions,
7428 and you may omit it in any version. If you require this
7429 parameter, the manifest key
7430 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7431 can ensure that your extension won't be run in an earlier browser ve rsion.
7432 </dd>
7433
7434 <!-- OBJECT PROPERTIES -->
7435 <dd style="display: none; ">
7436 <dl>
7437 <div>
7438 <div>
7439 </div>
7440 </div>
7441 </dl>
7442 </dd>
7443
7444 <!-- OBJECT METHODS -->
7445 <dd style="display: none; ">
7446 <div></div>
7447 </dd>
7448
7449 <!-- OBJECT EVENT FIELDS -->
7450 <dd style="display: none; ">
7451 <div></div>
7452 </dd>
7453
7454 <!-- FUNCTION PARAMETERS -->
7455 <dd style="display: none; ">
7456 <div></div>
7457 </dd>
7458
7459 </div>
7460 </div><div>
7461 <div>
7462 <dt>
7463 <var>error</var>
7464 <em>
7465
7466 <!-- TYPE -->
7467 <div style="display:inline">
7468 (
7469 <span class="optional" style="display: none; ">optional</spa n>
7470 <span class="enum" style="display: none; ">enumerated</span>
7471 <span id="typeTemplate">
7472 <span style="display: none; ">
7473 <a> Type</a>
7474 </span>
7475 <span>
7476 <span style="display: none; ">
7477 array of <span><span></span></span>
7478 </span>
7479 <span>string</span>
7480 <span style="display: none; "></span>
7481 </span>
7482 </span>
7483 )
7484 </div>
7485
7486 </em>
7487 </dt>
7488 <dd class="todo" style="display: none; ">
7489 Undocumented.
7490 </dd>
7491 <dd>The error description. This string is <em>not</em> guaranteed to r emain backwards compatible between releases. You must not parse and act based up on its content.</dd>
7492 <dd style="display: none; ">
7493 This parameter was added in version
7494 <b><span></span></b>.
7495 You must omit this parameter in earlier versions,
7496 and you may omit it in any version. If you require this
7497 parameter, the manifest key
7498 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7499 can ensure that your extension won't be run in an earlier browser ve rsion.
7500 </dd>
7501
7502 <!-- OBJECT PROPERTIES -->
7503 <dd style="display: none; ">
7504 <dl>
7505 <div>
7506 <div>
7507 </div>
7508 </div>
7509 </dl>
7510 </dd>
7511
7512 <!-- OBJECT METHODS -->
7513 <dd style="display: none; ">
7514 <div></div>
7515 </dd>
7516
7517 <!-- OBJECT EVENT FIELDS -->
7518 <dd style="display: none; ">
7519 <div></div>
7520 </dd>
7521
7522 <!-- FUNCTION PARAMETERS -->
7523 <dd style="display: none; ">
7524 <div></div>
7525 </dd>
7526
7527 </div>
7528 </div>
7529 </dl>
7530 </dd>
7531
7532 <!-- OBJECT METHODS -->
7533 <dd style="display: none; ">
7534 <div></div>
7535 </dd>
7536
7537 <!-- OBJECT EVENT FIELDS -->
7538 <dd style="display: none; ">
7539 <div></div>
7540 </dd>
7541
7542 <!-- FUNCTION PARAMETERS -->
7543 <dd style="display: none; ">
7544 <div></div>
7545 </dd>
7546
7547 </div>
7548 </div>
7549 </dl>
7550 </div>
7551
7552 <!-- EXTRA PARAMETERS -->
7553 <div>
7554 <h4>Extra parameters to addListener</h4>
7555 <dl>
7556 <div>
7557 <div>
7558 <dt>
7559 <var>filter</var>
7560 <em>
7561
7562 <!-- TYPE -->
7563 <div style="display:inline">
7564 (
7565 <span class="optional">optional</span>
7566 <span class="enum" style="display: none; ">enumerated</span>
7567 <span id="typeTemplate">
7568 <span>
7569 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
7570 </span>
7571 <span style="display: none; ">
7572 <span>
7573 array of <span><span></span></span>
7574 </span>
7575 <span>paramType</span>
7576 <span></span>
7577 </span>
7578 </span>
7579 )
7580 </div>
7581
7582 </em>
7583 </dt>
7584 <dd class="todo" style="display: none; ">
7585 Undocumented.
7586 </dd>
7587 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
7588 <dd style="display: none; ">
7589 This parameter was added in version
7590 <b><span></span></b>.
7591 You must omit this parameter in earlier versions,
7592 and you may omit it in any version. If you require this
7593 parameter, the manifest key
7594 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7595 can ensure that your extension won't be run in an earlier browser ve rsion.
7596 </dd>
7597
7598 <!-- OBJECT PROPERTIES -->
7599 <dd style="display: none; ">
7600 <dl>
7601 <div>
7602 <div>
7603 </div>
7604 </div>
7605 </dl>
7606 </dd>
7607
7608 <!-- OBJECT METHODS -->
7609 <dd style="display: none; ">
7610 <div></div>
7611 </dd>
7612
7613 <!-- OBJECT EVENT FIELDS -->
7614 <dd style="display: none; ">
7615 <div></div>
7616 </dd>
7617
7618 <!-- FUNCTION PARAMETERS -->
7619 <dd style="display: none; ">
7620 <div></div>
7621 </dd>
7622
7623 </div>
7624 </div>
7625 </dl>
7626 </div>
7627
7628 <!-- LISTENER RETURN VALUE -->
7629 <h4 style="display: none; ">Listener returns</h4>
7630 <dl>
7631 <div style="display: none; ">
7632 <div>
7633 </div>
7634 </div>
7635 </dl>
7636
7637 </div> <!-- /description -->
7638 </div><div class="apiItem">
7639 <a name="event-onHeadersReceived"></a>
7640 <h4>onHeadersReceived</h4>
7641
7642 <div class="summary">
7643 <!-- Note: intentionally longer 80 columns -->
7644 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onHeadersReceived</span><span class="subdued">.addListener</span>(function(<sp an>object deails</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>);
7645 </div>
7646
7647 <div class="description">
7648 <p class="todo" style="display: none; ">Undocumented.</p>
7649 <p>Fired when HTTP response headers of a request have been recei ved</p>
7650
7651 <!-- LISTENER PARAMETERS -->
7652 <div>
7653 <h4>Listener parameters</h4>
7654 <dl>
7655 <div>
7656 <div>
7657 <dt>
7658 <var>deails</var>
7659 <em>
7660
7661 <!-- TYPE -->
7662 <div style="display:inline">
7663 (
7664 <span class="optional" style="display: none; ">optional</spa n>
7665 <span class="enum" style="display: none; ">enumerated</span>
7666 <span id="typeTemplate">
7667 <span style="display: none; ">
7668 <a> Type</a>
7669 </span>
7670 <span>
7671 <span style="display: none; ">
7672 array of <span><span></span></span>
7673 </span>
7674 <span>object</span>
7675 <span style="display: none; "></span>
7676 </span>
7677 </span>
7678 )
7679 </div>
7680
7681 </em>
7682 </dt>
7683 <dd class="todo">
7684 Undocumented.
7685 </dd>
7686 <dd style="display: none; ">
7687 Description of this parameter from the json schema.
7688 </dd>
7689 <dd style="display: none; ">
7690 This parameter was added in version
7691 <b><span></span></b>.
7692 You must omit this parameter in earlier versions,
7693 and you may omit it in any version. If you require this
7694 parameter, the manifest key
7695 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7696 can ensure that your extension won't be run in an earlier browser ve rsion.
7697 </dd>
7698
7699 <!-- OBJECT PROPERTIES -->
7700 <dd>
7701 <dl>
7702 <div>
7703 <div>
7704 <dt>
7705 <var>requestId</var>
7706 <em>
7707
7708 <!-- TYPE -->
7709 <div style="display:inline">
7710 (
7711 <span class="optional" style="display: none; ">optional</spa n>
7712 <span class="enum" style="display: none; ">enumerated</span>
7713 <span id="typeTemplate">
7714 <span style="display: none; ">
7715 <a> Type</a>
7716 </span>
7717 <span>
7718 <span style="display: none; ">
7719 array of <span><span></span></span>
7720 </span>
7721 <span>string</span>
7722 <span style="display: none; "></span>
7723 </span>
7724 </span>
7725 )
7726 </div>
7727
7728 </em>
7729 </dt>
7730 <dd class="todo" style="display: none; ">
7731 Undocumented.
7732 </dd>
7733 <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>
7734 <dd style="display: none; ">
7735 This parameter was added in version
7736 <b><span></span></b>.
7737 You must omit this parameter in earlier versions,
7738 and you may omit it in any version. If you require this
7739 parameter, the manifest key
7740 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7741 can ensure that your extension won't be run in an earlier browser ve rsion.
7742 </dd>
7743
7744 <!-- OBJECT PROPERTIES -->
7745 <dd style="display: none; ">
7746 <dl>
7747 <div>
7748 <div>
7749 </div>
7750 </div>
7751 </dl>
7752 </dd>
7753
7754 <!-- OBJECT METHODS -->
7755 <dd style="display: none; ">
7756 <div></div>
7757 </dd>
7758
7759 <!-- OBJECT EVENT FIELDS -->
7760 <dd style="display: none; ">
7761 <div></div>
7762 </dd>
7763
7764 <!-- FUNCTION PARAMETERS -->
7765 <dd style="display: none; ">
7766 <div></div>
7767 </dd>
7768
7769 </div>
7770 </div><div>
7771 <div>
7772 <dt>
7773 <var>url</var>
7774 <em>
7775
7776 <!-- TYPE -->
7777 <div style="display:inline">
7778 (
7779 <span class="optional" style="display: none; ">optional</spa n>
7780 <span class="enum" style="display: none; ">enumerated</span>
7781 <span id="typeTemplate">
7782 <span style="display: none; ">
7783 <a> Type</a>
7784 </span>
7785 <span>
7786 <span style="display: none; ">
7787 array of <span><span></span></span>
7788 </span>
7789 <span>string</span>
7790 <span style="display: none; "></span>
7791 </span>
7792 </span>
7793 )
7794 </div>
7795
7796 </em>
7797 </dt>
7798 <dd class="todo">
7799 Undocumented.
7800 </dd>
7801 <dd style="display: none; ">
7802 Description of this parameter from the json schema.
7803 </dd>
7804 <dd style="display: none; ">
7805 This parameter was added in version
7806 <b><span></span></b>.
7807 You must omit this parameter in earlier versions,
7808 and you may omit it in any version. If you require this
7809 parameter, the manifest key
7810 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7811 can ensure that your extension won't be run in an earlier browser ve rsion.
7812 </dd>
7813
7814 <!-- OBJECT PROPERTIES -->
7815 <dd style="display: none; ">
7816 <dl>
7817 <div>
7818 <div>
7819 </div>
7820 </div>
7821 </dl>
7822 </dd>
7823
7824 <!-- OBJECT METHODS -->
7825 <dd style="display: none; ">
7826 <div></div>
7827 </dd>
7828
7829 <!-- OBJECT EVENT FIELDS -->
7830 <dd style="display: none; ">
7831 <div></div>
7832 </dd>
7833
7834 <!-- FUNCTION PARAMETERS -->
7835 <dd style="display: none; ">
7836 <div></div>
7837 </dd>
7838
7839 </div>
7840 </div><div>
7841 <div>
7842 <dt>
7843 <var>method</var>
7844 <em>
7845
7846 <!-- TYPE -->
7847 <div style="display:inline">
7848 (
7849 <span class="optional" style="display: none; ">optional</spa n>
7850 <span class="enum" style="display: none; ">enumerated</span>
7851 <span id="typeTemplate">
7852 <span style="display: none; ">
7853 <a> Type</a>
7854 </span>
7855 <span>
7856 <span style="display: none; ">
7857 array of <span><span></span></span>
7858 </span>
7859 <span>string</span>
7860 <span style="display: none; "></span>
7861 </span>
7862 </span>
7863 )
7864 </div>
7865
7866 </em>
7867 </dt>
7868 <dd class="todo" style="display: none; ">
7869 Undocumented.
7870 </dd>
7871 <dd>Standard HTTP method.</dd>
7872 <dd style="display: none; ">
7873 This parameter was added in version
7874 <b><span></span></b>.
7875 You must omit this parameter in earlier versions,
7876 and you may omit it in any version. If you require this
7877 parameter, the manifest key
7878 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7879 can ensure that your extension won't be run in an earlier browser ve rsion.
7880 </dd>
7881
7882 <!-- OBJECT PROPERTIES -->
7883 <dd style="display: none; ">
7884 <dl>
7885 <div>
7886 <div>
7887 </div>
7888 </div>
7889 </dl>
7890 </dd>
7891
7892 <!-- OBJECT METHODS -->
7893 <dd style="display: none; ">
7894 <div></div>
7895 </dd>
7896
7897 <!-- OBJECT EVENT FIELDS -->
7898 <dd style="display: none; ">
7899 <div></div>
7900 </dd>
7901
7902 <!-- FUNCTION PARAMETERS -->
7903 <dd style="display: none; ">
7904 <div></div>
7905 </dd>
7906
7907 </div>
7908 </div><div>
7909 <div>
7910 <dt>
7911 <var>frameId</var>
7912 <em>
7913
7914 <!-- TYPE -->
7915 <div style="display:inline">
7916 (
7917 <span class="optional" style="display: none; ">optional</spa n>
7918 <span class="enum" style="display: none; ">enumerated</span>
7919 <span id="typeTemplate">
7920 <span style="display: none; ">
7921 <a> Type</a>
7922 </span>
7923 <span>
7924 <span style="display: none; ">
7925 array of <span><span></span></span>
7926 </span>
7927 <span>integer</span>
7928 <span style="display: none; "></span>
7929 </span>
7930 </span>
7931 )
7932 </div>
7933
7934 </em>
7935 </dt>
7936 <dd class="todo" style="display: none; ">
7937 Undocumented.
7938 </dd>
7939 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
7940 <dd style="display: none; ">
7941 This parameter was added in version
7942 <b><span></span></b>.
7943 You must omit this parameter in earlier versions,
7944 and you may omit it in any version. If you require this
7945 parameter, the manifest key
7946 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
7947 can ensure that your extension won't be run in an earlier browser ve rsion.
7948 </dd>
7949
7950 <!-- OBJECT PROPERTIES -->
7951 <dd style="display: none; ">
7952 <dl>
7953 <div>
7954 <div>
7955 </div>
7956 </div>
7957 </dl>
7958 </dd>
7959
7960 <!-- OBJECT METHODS -->
7961 <dd style="display: none; ">
7962 <div></div>
7963 </dd>
7964
7965 <!-- OBJECT EVENT FIELDS -->
7966 <dd style="display: none; ">
7967 <div></div>
7968 </dd>
7969
7970 <!-- FUNCTION PARAMETERS -->
7971 <dd style="display: none; ">
7972 <div></div>
7973 </dd>
7974
7975 </div>
7976 </div><div>
7977 <div>
7978 <dt>
7979 <var>parentFrameId</var>
7980 <em>
7981
7982 <!-- TYPE -->
7983 <div style="display:inline">
7984 (
7985 <span class="optional" style="display: none; ">optional</spa n>
7986 <span class="enum" style="display: none; ">enumerated</span>
7987 <span id="typeTemplate">
7988 <span style="display: none; ">
7989 <a> Type</a>
7990 </span>
7991 <span>
7992 <span style="display: none; ">
7993 array of <span><span></span></span>
7994 </span>
7995 <span>integer</span>
7996 <span style="display: none; "></span>
7997 </span>
7998 </span>
7999 )
8000 </div>
8001
8002 </em>
8003 </dt>
8004 <dd class="todo" style="display: none; ">
8005 Undocumented.
8006 </dd>
8007 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
8008 <dd style="display: none; ">
8009 This parameter was added in version
8010 <b><span></span></b>.
8011 You must omit this parameter in earlier versions,
8012 and you may omit it in any version. If you require this
8013 parameter, the manifest key
8014 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8015 can ensure that your extension won't be run in an earlier browser ve rsion.
8016 </dd>
8017
8018 <!-- OBJECT PROPERTIES -->
8019 <dd style="display: none; ">
8020 <dl>
8021 <div>
8022 <div>
8023 </div>
8024 </div>
8025 </dl>
8026 </dd>
8027
8028 <!-- OBJECT METHODS -->
8029 <dd style="display: none; ">
8030 <div></div>
8031 </dd>
8032
8033 <!-- OBJECT EVENT FIELDS -->
8034 <dd style="display: none; ">
8035 <div></div>
8036 </dd>
8037
8038 <!-- FUNCTION PARAMETERS -->
8039 <dd style="display: none; ">
8040 <div></div>
8041 </dd>
8042
8043 </div>
8044 </div><div>
8045 <div>
8046 <dt>
8047 <var>tabId</var>
8048 <em>
8049
8050 <!-- TYPE -->
8051 <div style="display:inline">
8052 (
8053 <span class="optional" style="display: none; ">optional</spa n>
8054 <span class="enum" style="display: none; ">enumerated</span>
8055 <span id="typeTemplate">
8056 <span style="display: none; ">
8057 <a> Type</a>
8058 </span>
8059 <span>
8060 <span style="display: none; ">
8061 array of <span><span></span></span>
8062 </span>
8063 <span>integer</span>
8064 <span style="display: none; "></span>
8065 </span>
8066 </span>
8067 )
8068 </div>
8069
8070 </em>
8071 </dt>
8072 <dd class="todo" style="display: none; ">
8073 Undocumented.
8074 </dd>
8075 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
8076 <dd style="display: none; ">
8077 This parameter was added in version
8078 <b><span></span></b>.
8079 You must omit this parameter in earlier versions,
8080 and you may omit it in any version. If you require this
8081 parameter, the manifest key
8082 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8083 can ensure that your extension won't be run in an earlier browser ve rsion.
8084 </dd>
8085
8086 <!-- OBJECT PROPERTIES -->
8087 <dd style="display: none; ">
8088 <dl>
8089 <div>
8090 <div>
8091 </div>
8092 </div>
8093 </dl>
8094 </dd>
8095
8096 <!-- OBJECT METHODS -->
8097 <dd style="display: none; ">
8098 <div></div>
8099 </dd>
8100
8101 <!-- OBJECT EVENT FIELDS -->
8102 <dd style="display: none; ">
8103 <div></div>
8104 </dd>
8105
8106 <!-- FUNCTION PARAMETERS -->
8107 <dd style="display: none; ">
8108 <div></div>
8109 </dd>
8110
8111 </div>
8112 </div><div>
8113 <div>
8114 <dt>
8115 <var>type</var>
8116 <em>
8117
8118 <!-- TYPE -->
8119 <div style="display:inline">
8120 (
8121 <span class="optional" style="display: none; ">optional</spa n>
8122 <span class="enum">enumerated</span>
8123 <span id="typeTemplate">
8124 <span style="display: none; ">
8125 <a> Type</a>
8126 </span>
8127 <span>
8128 <span style="display: none; ">
8129 array of <span><span></span></span>
8130 </span>
8131 <span>string</span>
8132 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
8133 </span>
8134 </span>
8135 )
8136 </div>
8137
8138 </em>
8139 </dt>
8140 <dd class="todo" style="display: none; ">
8141 Undocumented.
8142 </dd>
8143 <dd>How the requested resource will be used.</dd>
8144 <dd style="display: none; ">
8145 This parameter was added in version
8146 <b><span></span></b>.
8147 You must omit this parameter in earlier versions,
8148 and you may omit it in any version. If you require this
8149 parameter, the manifest key
8150 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8151 can ensure that your extension won't be run in an earlier browser ve rsion.
8152 </dd>
8153
8154 <!-- OBJECT PROPERTIES -->
8155 <dd style="display: none; ">
8156 <dl>
8157 <div>
8158 <div>
8159 </div>
8160 </div>
8161 </dl>
8162 </dd>
8163
8164 <!-- OBJECT METHODS -->
8165 <dd style="display: none; ">
8166 <div></div>
8167 </dd>
8168
8169 <!-- OBJECT EVENT FIELDS -->
8170 <dd style="display: none; ">
8171 <div></div>
8172 </dd>
8173
8174 <!-- FUNCTION PARAMETERS -->
8175 <dd style="display: none; ">
8176 <div></div>
8177 </dd>
8178
8179 </div>
8180 </div><div>
8181 <div>
8182 <dt>
8183 <var>timeStamp</var>
8184 <em>
8185
8186 <!-- TYPE -->
8187 <div style="display:inline">
8188 (
8189 <span class="optional" style="display: none; ">optional</spa n>
8190 <span class="enum" style="display: none; ">enumerated</span>
8191 <span id="typeTemplate">
8192 <span style="display: none; ">
8193 <a> Type</a>
8194 </span>
8195 <span>
8196 <span style="display: none; ">
8197 array of <span><span></span></span>
8198 </span>
8199 <span>number</span>
8200 <span style="display: none; "></span>
8201 </span>
8202 </span>
8203 )
8204 </div>
8205
8206 </em>
8207 </dt>
8208 <dd class="todo" style="display: none; ">
8209 Undocumented.
8210 </dd>
8211 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
8212 <dd style="display: none; ">
8213 This parameter was added in version
8214 <b><span></span></b>.
8215 You must omit this parameter in earlier versions,
8216 and you may omit it in any version. If you require this
8217 parameter, the manifest key
8218 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8219 can ensure that your extension won't be run in an earlier browser ve rsion.
8220 </dd>
8221
8222 <!-- OBJECT PROPERTIES -->
8223 <dd style="display: none; ">
8224 <dl>
8225 <div>
8226 <div>
8227 </div>
8228 </div>
8229 </dl>
8230 </dd>
8231
8232 <!-- OBJECT METHODS -->
8233 <dd style="display: none; ">
8234 <div></div>
8235 </dd>
8236
8237 <!-- OBJECT EVENT FIELDS -->
8238 <dd style="display: none; ">
8239 <div></div>
8240 </dd>
8241
8242 <!-- FUNCTION PARAMETERS -->
8243 <dd style="display: none; ">
8244 <div></div>
8245 </dd>
8246
8247 </div>
8248 </div><div>
8249 <div>
8250 <dt>
8251 <var>statusLine</var>
8252 <em>
8253
8254 <!-- TYPE -->
8255 <div style="display:inline">
8256 (
8257 <span class="optional">optional</span>
8258 <span class="enum" style="display: none; ">enumerated</span>
8259 <span id="typeTemplate">
8260 <span style="display: none; ">
8261 <a> Type</a>
8262 </span>
8263 <span>
8264 <span style="display: none; ">
8265 array of <span><span></span></span>
8266 </span>
8267 <span>string</span>
8268 <span style="display: none; "></span>
8269 </span>
8270 </span>
8271 )
8272 </div>
8273
8274 </em>
8275 </dt>
8276 <dd class="todo" style="display: none; ">
8277 Undocumented.
8278 </dd>
8279 <dd>HTTP status line of the response</dd>
8280 <dd style="display: none; ">
8281 This parameter was added in version
8282 <b><span></span></b>.
8283 You must omit this parameter in earlier versions,
8284 and you may omit it in any version. If you require this
8285 parameter, the manifest key
8286 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8287 can ensure that your extension won't be run in an earlier browser ve rsion.
8288 </dd>
8289
8290 <!-- OBJECT PROPERTIES -->
8291 <dd style="display: none; ">
8292 <dl>
8293 <div>
8294 <div>
8295 </div>
8296 </div>
8297 </dl>
8298 </dd>
8299
8300 <!-- OBJECT METHODS -->
8301 <dd style="display: none; ">
8302 <div></div>
8303 </dd>
8304
8305 <!-- OBJECT EVENT FIELDS -->
8306 <dd style="display: none; ">
8307 <div></div>
8308 </dd>
8309
8310 <!-- FUNCTION PARAMETERS -->
8311 <dd style="display: none; ">
8312 <div></div>
8313 </dd>
8314
8315 </div>
8316 </div><div>
8317 <div>
8318 <dt>
8319 <var>responseHeaders</var>
8320 <em>
8321
8322 <!-- TYPE -->
8323 <div style="display:inline">
8324 (
8325 <span class="optional">optional</span>
8326 <span class="enum" style="display: none; ">enumerated</span>
8327 <span id="typeTemplate">
8328 <span>
8329 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
8330 </span>
8331 <span style="display: none; ">
8332 <span>
8333 array of <span><span></span></span>
8334 </span>
8335 <span>paramType</span>
8336 <span></span>
8337 </span>
8338 </span>
8339 )
8340 </div>
8341
8342 </em>
8343 </dt>
8344 <dd class="todo" style="display: none; ">
8345 Undocumented.
8346 </dd>
8347 <dd>The HTTP response headers that have been received with this respon se.</dd>
8348 <dd style="display: none; ">
8349 This parameter was added in version
8350 <b><span></span></b>.
8351 You must omit this parameter in earlier versions,
8352 and you may omit it in any version. If you require this
8353 parameter, the manifest key
8354 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8355 can ensure that your extension won't be run in an earlier browser ve rsion.
8356 </dd>
8357
8358 <!-- OBJECT PROPERTIES -->
8359 <dd style="display: none; ">
8360 <dl>
8361 <div>
8362 <div>
8363 </div>
8364 </div>
8365 </dl>
8366 </dd>
8367
8368 <!-- OBJECT METHODS -->
8369 <dd style="display: none; ">
8370 <div></div>
8371 </dd>
8372
8373 <!-- OBJECT EVENT FIELDS -->
8374 <dd style="display: none; ">
8375 <div></div>
8376 </dd>
8377
8378 <!-- FUNCTION PARAMETERS -->
8379 <dd style="display: none; ">
8380 <div></div>
8381 </dd>
8382
8383 </div>
8384 </div>
8385 </dl>
8386 </dd>
8387
8388 <!-- OBJECT METHODS -->
8389 <dd style="display: none; ">
8390 <div></div>
8391 </dd>
8392
8393 <!-- OBJECT EVENT FIELDS -->
8394 <dd style="display: none; ">
8395 <div></div>
8396 </dd>
8397
8398 <!-- FUNCTION PARAMETERS -->
8399 <dd style="display: none; ">
8400 <div></div>
8401 </dd>
8402
8403 </div>
8404 </div>
8405 </dl>
8406 </div>
8407
8408 <!-- EXTRA PARAMETERS -->
8409 <div>
8410 <h4>Extra parameters to addListener</h4>
8411 <dl>
8412 <div>
8413 <div>
8414 <dt>
8415 <var>filter</var>
8416 <em>
8417
8418 <!-- TYPE -->
8419 <div style="display:inline">
8420 (
8421 <span class="optional">optional</span>
8422 <span class="enum" style="display: none; ">enumerated</span>
8423 <span id="typeTemplate">
8424 <span>
8425 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
8426 </span>
8427 <span style="display: none; ">
8428 <span>
8429 array of <span><span></span></span>
8430 </span>
8431 <span>paramType</span>
8432 <span></span>
8433 </span>
8434 </span>
8435 )
8436 </div>
8437
8438 </em>
8439 </dt>
8440 <dd class="todo" style="display: none; ">
8441 Undocumented.
8442 </dd>
8443 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
8444 <dd style="display: none; ">
8445 This parameter was added in version
8446 <b><span></span></b>.
8447 You must omit this parameter in earlier versions,
8448 and you may omit it in any version. If you require this
8449 parameter, the manifest key
8450 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8451 can ensure that your extension won't be run in an earlier browser ve rsion.
8452 </dd>
8453
8454 <!-- OBJECT PROPERTIES -->
8455 <dd style="display: none; ">
8456 <dl>
8457 <div>
8458 <div>
8459 </div>
8460 </div>
8461 </dl>
8462 </dd>
8463
8464 <!-- OBJECT METHODS -->
8465 <dd style="display: none; ">
8466 <div></div>
8467 </dd>
8468
8469 <!-- OBJECT EVENT FIELDS -->
8470 <dd style="display: none; ">
8471 <div></div>
8472 </dd>
8473
8474 <!-- FUNCTION PARAMETERS -->
8475 <dd style="display: none; ">
8476 <div></div>
8477 </dd>
8478
8479 </div>
8480 </div><div>
8481 <div>
8482 <dt>
8483 <var>extraInfoSpec</var>
8484 <em>
8485
8486 <!-- TYPE -->
8487 <div style="display:inline">
8488 (
8489 <span class="optional">optional</span>
8490 <span class="enum" style="display: none; ">enumerated</span>
8491 <span id="typeTemplate">
8492 <span style="display: none; ">
8493 <a> Type</a>
8494 </span>
8495 <span>
8496 <span>
8497 array of <span><span>
8498 <span style="display: none; ">
8499 <a> Type</a>
8500 </span>
8501 <span>
8502 <span style="display: none; ">
8503 array of <span><span></span></span>
8504 </span>
8505 <span>string</span>
8506 <span>["blocking", "responseHeaders"]</span>
8507 </span>
8508 </span></span>
8509 </span>
8510 <span style="display: none; ">paramType</span>
8511 <span style="display: none; "></span>
8512 </span>
8513 </span>
8514 )
8515 </div>
8516
8517 </em>
8518 </dt>
8519 <dd class="todo" style="display: none; ">
8520 Undocumented.
8521 </dd>
8522 <dd>Array of extra information that should be passed to the listener f unction.</dd>
8523 <dd style="display: none; ">
8524 This parameter was added in version
8525 <b><span></span></b>.
8526 You must omit this parameter in earlier versions,
8527 and you may omit it in any version. If you require this
8528 parameter, the manifest key
8529 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8530 can ensure that your extension won't be run in an earlier browser ve rsion.
8531 </dd>
8532
8533 <!-- OBJECT PROPERTIES -->
8534 <dd style="display: none; ">
8535 <dl>
8536 <div>
8537 <div>
8538 </div>
8539 </div>
8540 </dl>
8541 </dd>
8542
8543 <!-- OBJECT METHODS -->
8544 <dd style="display: none; ">
8545 <div></div>
8546 </dd>
8547
8548 <!-- OBJECT EVENT FIELDS -->
8549 <dd style="display: none; ">
8550 <div></div>
8551 </dd>
8552
8553 <!-- FUNCTION PARAMETERS -->
8554 <dd style="display: none; ">
8555 <div></div>
8556 </dd>
8557
8558 </div>
8559 </div>
8560 </dl>
8561 </div>
8562
8563 <!-- LISTENER RETURN VALUE -->
8564 <h4>Listener returns</h4>
8565 <dl>
8566 <div>
8567 <div>
8568 <dt>
8569 <var style="display: none; ">paramName</var>
8570 <em>
8571
8572 <!-- TYPE -->
8573 <div style="display:inline">
8574 (
8575 <span class="optional">optional</span>
8576 <span class="enum" style="display: none; ">enumerated</span>
8577 <span id="typeTemplate">
8578 <span>
8579 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a>
8580 </span>
8581 <span style="display: none; ">
8582 <span>
8583 array of <span><span></span></span>
8584 </span>
8585 <span>paramType</span>
8586 <span></span>
8587 </span>
8588 </span>
8589 )
8590 </div>
8591
8592 </em>
8593 </dt>
8594 <dd class="todo" style="display: none; ">
8595 Undocumented.
8596 </dd>
8597 <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the e vent listener should return an object of this type.</dd>
8598 <dd style="display: none; ">
8599 This parameter was added in version
8600 <b><span></span></b>.
8601 You must omit this parameter in earlier versions,
8602 and you may omit it in any version. If you require this
8603 parameter, the manifest key
8604 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8605 can ensure that your extension won't be run in an earlier browser ve rsion.
8606 </dd>
8607
8608 <!-- OBJECT PROPERTIES -->
8609 <dd style="display: none; ">
8610 <dl>
8611 <div>
8612 <div>
8613 </div>
8614 </div>
8615 </dl>
8616 </dd>
8617
8618 <!-- OBJECT METHODS -->
8619 <dd style="display: none; ">
8620 <div></div>
8621 </dd>
8622
8623 <!-- OBJECT EVENT FIELDS -->
8624 <dd style="display: none; ">
8625 <div></div>
8626 </dd>
8627
8628 <!-- FUNCTION PARAMETERS -->
8629 <dd style="display: none; ">
8630 <div></div>
8631 </dd>
8632
8633 </div>
8634 </div>
8635 </dl>
8636
8637 </div> <!-- /description -->
8638 </div><div class="apiItem">
8639 <a name="event-onResponseStarted"></a>
8640 <h4>onResponseStarted</h4>
8641
8642 <div class="summary">
8643 <!-- Note: intentionally longer 80 columns -->
8644 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onResponseStarted</span><span class="subdued">.addListener</span>(function(<sp an>object details</span>) <span class="subdued">{...}</span><span>, RequestFilte r filter, array of string extraInfoSpec</span>);
8645 </div>
8646
8647 <div class="description">
8648 <p class="todo" style="display: none; ">Undocumented.</p>
8649 <p>Fired when the first byte of the response body is received. F or HTTP requests, this means that the status line and response headers are avail able.</p>
8650
8651 <!-- LISTENER PARAMETERS -->
8652 <div>
8653 <h4>Listener parameters</h4>
8654 <dl>
8655 <div>
8656 <div>
8657 <dt>
8658 <var>details</var>
8659 <em>
8660
8661 <!-- TYPE -->
8662 <div style="display:inline">
8663 (
8664 <span class="optional" style="display: none; ">optional</spa n>
8665 <span class="enum" style="display: none; ">enumerated</span>
8666 <span id="typeTemplate">
8667 <span style="display: none; ">
8668 <a> Type</a>
8669 </span>
8670 <span>
8671 <span style="display: none; ">
8672 array of <span><span></span></span>
8673 </span>
8674 <span>object</span>
8675 <span style="display: none; "></span>
8676 </span>
8677 </span>
8678 )
8679 </div>
8680
8681 </em>
8682 </dt>
8683 <dd class="todo">
8684 Undocumented.
8685 </dd>
8686 <dd style="display: none; ">
8687 Description of this parameter from the json schema.
8688 </dd>
8689 <dd style="display: none; ">
8690 This parameter was added in version
8691 <b><span></span></b>.
8692 You must omit this parameter in earlier versions,
8693 and you may omit it in any version. If you require this
8694 parameter, the manifest key
8695 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8696 can ensure that your extension won't be run in an earlier browser ve rsion.
8697 </dd>
8698
8699 <!-- OBJECT PROPERTIES -->
8700 <dd>
8701 <dl>
8702 <div>
8703 <div>
8704 <dt>
8705 <var>requestId</var>
8706 <em>
8707
8708 <!-- TYPE -->
8709 <div style="display:inline">
8710 (
8711 <span class="optional" style="display: none; ">optional</spa n>
8712 <span class="enum" style="display: none; ">enumerated</span>
8713 <span id="typeTemplate">
8714 <span style="display: none; ">
8715 <a> Type</a>
8716 </span>
8717 <span>
8718 <span style="display: none; ">
8719 array of <span><span></span></span>
8720 </span>
8721 <span>string</span>
8722 <span style="display: none; "></span>
8723 </span>
8724 </span>
8725 )
8726 </div>
8727
8728 </em>
8729 </dt>
8730 <dd class="todo" style="display: none; ">
8731 Undocumented.
8732 </dd>
8733 <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>
8734 <dd style="display: none; ">
8735 This parameter was added in version
8736 <b><span></span></b>.
8737 You must omit this parameter in earlier versions,
8738 and you may omit it in any version. If you require this
8739 parameter, the manifest key
8740 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8741 can ensure that your extension won't be run in an earlier browser ve rsion.
8742 </dd>
8743
8744 <!-- OBJECT PROPERTIES -->
8745 <dd style="display: none; ">
8746 <dl>
8747 <div>
8748 <div>
8749 </div>
8750 </div>
8751 </dl>
8752 </dd>
8753
8754 <!-- OBJECT METHODS -->
8755 <dd style="display: none; ">
8756 <div></div>
8757 </dd>
8758
8759 <!-- OBJECT EVENT FIELDS -->
8760 <dd style="display: none; ">
8761 <div></div>
8762 </dd>
8763
8764 <!-- FUNCTION PARAMETERS -->
8765 <dd style="display: none; ">
8766 <div></div>
8767 </dd>
8768
8769 </div>
8770 </div><div>
8771 <div>
8772 <dt>
8773 <var>url</var>
8774 <em>
8775
8776 <!-- TYPE -->
8777 <div style="display:inline">
8778 (
8779 <span class="optional" style="display: none; ">optional</spa n>
8780 <span class="enum" style="display: none; ">enumerated</span>
8781 <span id="typeTemplate">
8782 <span style="display: none; ">
8783 <a> Type</a>
8784 </span>
8785 <span>
8786 <span style="display: none; ">
8787 array of <span><span></span></span>
8788 </span>
8789 <span>string</span>
8790 <span style="display: none; "></span>
8791 </span>
8792 </span>
8793 )
8794 </div>
8795
8796 </em>
8797 </dt>
8798 <dd class="todo">
8799 Undocumented.
8800 </dd>
8801 <dd style="display: none; ">
8802 Description of this parameter from the json schema.
8803 </dd>
8804 <dd style="display: none; ">
8805 This parameter was added in version
8806 <b><span></span></b>.
8807 You must omit this parameter in earlier versions,
8808 and you may omit it in any version. If you require this
8809 parameter, the manifest key
8810 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8811 can ensure that your extension won't be run in an earlier browser ve rsion.
8812 </dd>
8813
8814 <!-- OBJECT PROPERTIES -->
8815 <dd style="display: none; ">
8816 <dl>
8817 <div>
8818 <div>
8819 </div>
8820 </div>
8821 </dl>
8822 </dd>
8823
8824 <!-- OBJECT METHODS -->
8825 <dd style="display: none; ">
8826 <div></div>
8827 </dd>
8828
8829 <!-- OBJECT EVENT FIELDS -->
8830 <dd style="display: none; ">
8831 <div></div>
8832 </dd>
8833
8834 <!-- FUNCTION PARAMETERS -->
8835 <dd style="display: none; ">
8836 <div></div>
8837 </dd>
8838
8839 </div>
8840 </div><div>
8841 <div>
8842 <dt>
8843 <var>method</var>
8844 <em>
8845
8846 <!-- TYPE -->
8847 <div style="display:inline">
8848 (
8849 <span class="optional" style="display: none; ">optional</spa n>
8850 <span class="enum" style="display: none; ">enumerated</span>
8851 <span id="typeTemplate">
8852 <span style="display: none; ">
8853 <a> Type</a>
8854 </span>
8855 <span>
8856 <span style="display: none; ">
8857 array of <span><span></span></span>
8858 </span>
8859 <span>string</span>
8860 <span style="display: none; "></span>
8861 </span>
8862 </span>
8863 )
8864 </div>
8865
8866 </em>
8867 </dt>
8868 <dd class="todo" style="display: none; ">
8869 Undocumented.
8870 </dd>
8871 <dd>Standard HTTP method.</dd>
8872 <dd style="display: none; ">
8873 This parameter was added in version
8874 <b><span></span></b>.
8875 You must omit this parameter in earlier versions,
8876 and you may omit it in any version. If you require this
8877 parameter, the manifest key
8878 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8879 can ensure that your extension won't be run in an earlier browser ve rsion.
8880 </dd>
8881
8882 <!-- OBJECT PROPERTIES -->
8883 <dd style="display: none; ">
8884 <dl>
8885 <div>
8886 <div>
8887 </div>
8888 </div>
8889 </dl>
8890 </dd>
8891
8892 <!-- OBJECT METHODS -->
8893 <dd style="display: none; ">
8894 <div></div>
8895 </dd>
8896
8897 <!-- OBJECT EVENT FIELDS -->
8898 <dd style="display: none; ">
8899 <div></div>
8900 </dd>
8901
8902 <!-- FUNCTION PARAMETERS -->
8903 <dd style="display: none; ">
8904 <div></div>
8905 </dd>
8906
8907 </div>
8908 </div><div>
8909 <div>
8910 <dt>
8911 <var>frameId</var>
8912 <em>
8913
8914 <!-- TYPE -->
8915 <div style="display:inline">
8916 (
8917 <span class="optional" style="display: none; ">optional</spa n>
8918 <span class="enum" style="display: none; ">enumerated</span>
8919 <span id="typeTemplate">
8920 <span style="display: none; ">
8921 <a> Type</a>
8922 </span>
8923 <span>
8924 <span style="display: none; ">
8925 array of <span><span></span></span>
8926 </span>
8927 <span>integer</span>
8928 <span style="display: none; "></span>
8929 </span>
8930 </span>
8931 )
8932 </div>
8933
8934 </em>
8935 </dt>
8936 <dd class="todo" style="display: none; ">
8937 Undocumented.
8938 </dd>
8939 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
8940 <dd style="display: none; ">
8941 This parameter was added in version
8942 <b><span></span></b>.
8943 You must omit this parameter in earlier versions,
8944 and you may omit it in any version. If you require this
8945 parameter, the manifest key
8946 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
8947 can ensure that your extension won't be run in an earlier browser ve rsion.
8948 </dd>
8949
8950 <!-- OBJECT PROPERTIES -->
8951 <dd style="display: none; ">
8952 <dl>
8953 <div>
8954 <div>
8955 </div>
8956 </div>
8957 </dl>
8958 </dd>
8959
8960 <!-- OBJECT METHODS -->
8961 <dd style="display: none; ">
8962 <div></div>
8963 </dd>
8964
8965 <!-- OBJECT EVENT FIELDS -->
8966 <dd style="display: none; ">
8967 <div></div>
8968 </dd>
8969
8970 <!-- FUNCTION PARAMETERS -->
8971 <dd style="display: none; ">
8972 <div></div>
8973 </dd>
8974
8975 </div>
8976 </div><div>
8977 <div>
8978 <dt>
8979 <var>parentFrameId</var>
8980 <em>
8981
8982 <!-- TYPE -->
8983 <div style="display:inline">
8984 (
8985 <span class="optional" style="display: none; ">optional</spa n>
8986 <span class="enum" style="display: none; ">enumerated</span>
8987 <span id="typeTemplate">
8988 <span style="display: none; ">
8989 <a> Type</a>
8990 </span>
8991 <span>
8992 <span style="display: none; ">
8993 array of <span><span></span></span>
8994 </span>
8995 <span>integer</span>
8996 <span style="display: none; "></span>
8997 </span>
8998 </span>
8999 )
9000 </div>
9001
9002 </em>
9003 </dt>
9004 <dd class="todo" style="display: none; ">
9005 Undocumented.
9006 </dd>
9007 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
9008 <dd style="display: none; ">
9009 This parameter was added in version
9010 <b><span></span></b>.
9011 You must omit this parameter in earlier versions,
9012 and you may omit it in any version. If you require this
9013 parameter, the manifest key
9014 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9015 can ensure that your extension won't be run in an earlier browser ve rsion.
9016 </dd>
9017
9018 <!-- OBJECT PROPERTIES -->
9019 <dd style="display: none; ">
9020 <dl>
9021 <div>
9022 <div>
9023 </div>
9024 </div>
9025 </dl>
9026 </dd>
9027
9028 <!-- OBJECT METHODS -->
9029 <dd style="display: none; ">
9030 <div></div>
9031 </dd>
9032
9033 <!-- OBJECT EVENT FIELDS -->
9034 <dd style="display: none; ">
9035 <div></div>
9036 </dd>
9037
9038 <!-- FUNCTION PARAMETERS -->
9039 <dd style="display: none; ">
9040 <div></div>
9041 </dd>
9042
9043 </div>
9044 </div><div>
9045 <div>
9046 <dt>
9047 <var>tabId</var>
9048 <em>
9049
9050 <!-- TYPE -->
9051 <div style="display:inline">
9052 (
9053 <span class="optional" style="display: none; ">optional</spa n>
9054 <span class="enum" style="display: none; ">enumerated</span>
9055 <span id="typeTemplate">
9056 <span style="display: none; ">
9057 <a> Type</a>
9058 </span>
9059 <span>
9060 <span style="display: none; ">
9061 array of <span><span></span></span>
9062 </span>
9063 <span>integer</span>
9064 <span style="display: none; "></span>
9065 </span>
9066 </span>
9067 )
9068 </div>
9069
9070 </em>
9071 </dt>
9072 <dd class="todo" style="display: none; ">
9073 Undocumented.
9074 </dd>
9075 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
9076 <dd style="display: none; ">
9077 This parameter was added in version
9078 <b><span></span></b>.
9079 You must omit this parameter in earlier versions,
9080 and you may omit it in any version. If you require this
9081 parameter, the manifest key
9082 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9083 can ensure that your extension won't be run in an earlier browser ve rsion.
9084 </dd>
9085
9086 <!-- OBJECT PROPERTIES -->
9087 <dd style="display: none; ">
9088 <dl>
9089 <div>
9090 <div>
9091 </div>
9092 </div>
9093 </dl>
9094 </dd>
9095
9096 <!-- OBJECT METHODS -->
9097 <dd style="display: none; ">
9098 <div></div>
9099 </dd>
9100
9101 <!-- OBJECT EVENT FIELDS -->
9102 <dd style="display: none; ">
9103 <div></div>
9104 </dd>
9105
9106 <!-- FUNCTION PARAMETERS -->
9107 <dd style="display: none; ">
9108 <div></div>
9109 </dd>
9110
9111 </div>
9112 </div><div>
9113 <div>
9114 <dt>
9115 <var>type</var>
9116 <em>
9117
9118 <!-- TYPE -->
9119 <div style="display:inline">
9120 (
9121 <span class="optional" style="display: none; ">optional</spa n>
9122 <span class="enum">enumerated</span>
9123 <span id="typeTemplate">
9124 <span style="display: none; ">
9125 <a> Type</a>
9126 </span>
9127 <span>
9128 <span style="display: none; ">
9129 array of <span><span></span></span>
9130 </span>
9131 <span>string</span>
9132 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
9133 </span>
9134 </span>
9135 )
9136 </div>
9137
9138 </em>
9139 </dt>
9140 <dd class="todo" style="display: none; ">
9141 Undocumented.
9142 </dd>
9143 <dd>How the requested resource will be used.</dd>
9144 <dd style="display: none; ">
9145 This parameter was added in version
9146 <b><span></span></b>.
9147 You must omit this parameter in earlier versions,
9148 and you may omit it in any version. If you require this
9149 parameter, the manifest key
9150 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9151 can ensure that your extension won't be run in an earlier browser ve rsion.
9152 </dd>
9153
9154 <!-- OBJECT PROPERTIES -->
9155 <dd style="display: none; ">
9156 <dl>
9157 <div>
9158 <div>
9159 </div>
9160 </div>
9161 </dl>
9162 </dd>
9163
9164 <!-- OBJECT METHODS -->
9165 <dd style="display: none; ">
9166 <div></div>
9167 </dd>
9168
9169 <!-- OBJECT EVENT FIELDS -->
9170 <dd style="display: none; ">
9171 <div></div>
9172 </dd>
9173
9174 <!-- FUNCTION PARAMETERS -->
9175 <dd style="display: none; ">
9176 <div></div>
9177 </dd>
9178
9179 </div>
9180 </div><div>
9181 <div>
9182 <dt>
9183 <var>timeStamp</var>
9184 <em>
9185
9186 <!-- TYPE -->
9187 <div style="display:inline">
9188 (
9189 <span class="optional" style="display: none; ">optional</spa n>
9190 <span class="enum" style="display: none; ">enumerated</span>
9191 <span id="typeTemplate">
9192 <span style="display: none; ">
9193 <a> Type</a>
9194 </span>
9195 <span>
9196 <span style="display: none; ">
9197 array of <span><span></span></span>
9198 </span>
9199 <span>number</span>
9200 <span style="display: none; "></span>
9201 </span>
9202 </span>
9203 )
9204 </div>
9205
9206 </em>
9207 </dt>
9208 <dd class="todo" style="display: none; ">
9209 Undocumented.
9210 </dd>
9211 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
9212 <dd style="display: none; ">
9213 This parameter was added in version
9214 <b><span></span></b>.
9215 You must omit this parameter in earlier versions,
9216 and you may omit it in any version. If you require this
9217 parameter, the manifest key
9218 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9219 can ensure that your extension won't be run in an earlier browser ve rsion.
9220 </dd>
9221
9222 <!-- OBJECT PROPERTIES -->
9223 <dd style="display: none; ">
9224 <dl>
9225 <div>
9226 <div>
9227 </div>
9228 </div>
9229 </dl>
9230 </dd>
9231
9232 <!-- OBJECT METHODS -->
9233 <dd style="display: none; ">
9234 <div></div>
9235 </dd>
9236
9237 <!-- OBJECT EVENT FIELDS -->
9238 <dd style="display: none; ">
9239 <div></div>
9240 </dd>
9241
9242 <!-- FUNCTION PARAMETERS -->
9243 <dd style="display: none; ">
9244 <div></div>
9245 </dd>
9246
9247 </div>
9248 </div><div>
9249 <div>
9250 <dt>
9251 <var>ip</var>
9252 <em>
9253
9254 <!-- TYPE -->
9255 <div style="display:inline">
9256 (
9257 <span class="optional">optional</span>
9258 <span class="enum" style="display: none; ">enumerated</span>
9259 <span id="typeTemplate">
9260 <span style="display: none; ">
9261 <a> Type</a>
9262 </span>
9263 <span>
9264 <span style="display: none; ">
9265 array of <span><span></span></span>
9266 </span>
9267 <span>string</span>
9268 <span style="display: none; "></span>
9269 </span>
9270 </span>
9271 )
9272 </div>
9273
9274 </em>
9275 </dt>
9276 <dd class="todo" style="display: none; ">
9277 Undocumented.
9278 </dd>
9279 <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
9280 <dd style="display: none; ">
9281 This parameter was added in version
9282 <b><span></span></b>.
9283 You must omit this parameter in earlier versions,
9284 and you may omit it in any version. If you require this
9285 parameter, the manifest key
9286 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9287 can ensure that your extension won't be run in an earlier browser ve rsion.
9288 </dd>
9289
9290 <!-- OBJECT PROPERTIES -->
9291 <dd style="display: none; ">
9292 <dl>
9293 <div>
9294 <div>
9295 </div>
9296 </div>
9297 </dl>
9298 </dd>
9299
9300 <!-- OBJECT METHODS -->
9301 <dd style="display: none; ">
9302 <div></div>
9303 </dd>
9304
9305 <!-- OBJECT EVENT FIELDS -->
9306 <dd style="display: none; ">
9307 <div></div>
9308 </dd>
9309
9310 <!-- FUNCTION PARAMETERS -->
9311 <dd style="display: none; ">
9312 <div></div>
9313 </dd>
9314
9315 </div>
9316 </div><div>
9317 <div>
9318 <dt>
9319 <var>fromCache</var>
9320 <em>
9321
9322 <!-- TYPE -->
9323 <div style="display:inline">
9324 (
9325 <span class="optional" style="display: none; ">optional</spa n>
9326 <span class="enum" style="display: none; ">enumerated</span>
9327 <span id="typeTemplate">
9328 <span style="display: none; ">
9329 <a> Type</a>
9330 </span>
9331 <span>
9332 <span style="display: none; ">
9333 array of <span><span></span></span>
9334 </span>
9335 <span>boolean</span>
9336 <span style="display: none; "></span>
9337 </span>
9338 </span>
9339 )
9340 </div>
9341
9342 </em>
9343 </dt>
9344 <dd class="todo" style="display: none; ">
9345 Undocumented.
9346 </dd>
9347 <dd>Indicates if this response was fetched from disk cache.</dd>
9348 <dd style="display: none; ">
9349 This parameter was added in version
9350 <b><span></span></b>.
9351 You must omit this parameter in earlier versions,
9352 and you may omit it in any version. If you require this
9353 parameter, the manifest key
9354 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9355 can ensure that your extension won't be run in an earlier browser ve rsion.
9356 </dd>
9357
9358 <!-- OBJECT PROPERTIES -->
9359 <dd style="display: none; ">
9360 <dl>
9361 <div>
9362 <div>
9363 </div>
9364 </div>
9365 </dl>
9366 </dd>
9367
9368 <!-- OBJECT METHODS -->
9369 <dd style="display: none; ">
9370 <div></div>
9371 </dd>
9372
9373 <!-- OBJECT EVENT FIELDS -->
9374 <dd style="display: none; ">
9375 <div></div>
9376 </dd>
9377
9378 <!-- FUNCTION PARAMETERS -->
9379 <dd style="display: none; ">
9380 <div></div>
9381 </dd>
9382
9383 </div>
9384 </div><div>
9385 <div>
9386 <dt>
9387 <var>statusCode</var>
9388 <em>
9389
9390 <!-- TYPE -->
9391 <div style="display:inline">
9392 (
9393 <span class="optional" style="display: none; ">optional</spa n>
9394 <span class="enum" style="display: none; ">enumerated</span>
9395 <span id="typeTemplate">
9396 <span style="display: none; ">
9397 <a> Type</a>
9398 </span>
9399 <span>
9400 <span style="display: none; ">
9401 array of <span><span></span></span>
9402 </span>
9403 <span>integer</span>
9404 <span style="display: none; "></span>
9405 </span>
9406 </span>
9407 )
9408 </div>
9409
9410 </em>
9411 </dt>
9412 <dd class="todo" style="display: none; ">
9413 Undocumented.
9414 </dd>
9415 <dd>Standard HTTP status code returned by the server.</dd>
9416 <dd style="display: none; ">
9417 This parameter was added in version
9418 <b><span></span></b>.
9419 You must omit this parameter in earlier versions,
9420 and you may omit it in any version. If you require this
9421 parameter, the manifest key
9422 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9423 can ensure that your extension won't be run in an earlier browser ve rsion.
9424 </dd>
9425
9426 <!-- OBJECT PROPERTIES -->
9427 <dd style="display: none; ">
9428 <dl>
9429 <div>
9430 <div>
9431 </div>
9432 </div>
9433 </dl>
9434 </dd>
9435
9436 <!-- OBJECT METHODS -->
9437 <dd style="display: none; ">
9438 <div></div>
9439 </dd>
9440
9441 <!-- OBJECT EVENT FIELDS -->
9442 <dd style="display: none; ">
9443 <div></div>
9444 </dd>
9445
9446 <!-- FUNCTION PARAMETERS -->
9447 <dd style="display: none; ">
9448 <div></div>
9449 </dd>
9450
9451 </div>
9452 </div><div>
9453 <div>
9454 <dt>
9455 <var>responseHeaders</var>
9456 <em>
9457
9458 <!-- TYPE -->
9459 <div style="display:inline">
9460 (
9461 <span class="optional">optional</span>
9462 <span class="enum" style="display: none; ">enumerated</span>
9463 <span id="typeTemplate">
9464 <span>
9465 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
9466 </span>
9467 <span style="display: none; ">
9468 <span>
9469 array of <span><span></span></span>
9470 </span>
9471 <span>paramType</span>
9472 <span></span>
9473 </span>
9474 </span>
9475 )
9476 </div>
9477
9478 </em>
9479 </dt>
9480 <dd class="todo" style="display: none; ">
9481 Undocumented.
9482 </dd>
9483 <dd>The HTTP response headers that were received along with this respo nse.</dd>
9484 <dd style="display: none; ">
9485 This parameter was added in version
9486 <b><span></span></b>.
9487 You must omit this parameter in earlier versions,
9488 and you may omit it in any version. If you require this
9489 parameter, the manifest key
9490 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9491 can ensure that your extension won't be run in an earlier browser ve rsion.
9492 </dd>
9493
9494 <!-- OBJECT PROPERTIES -->
9495 <dd style="display: none; ">
9496 <dl>
9497 <div>
9498 <div>
9499 </div>
9500 </div>
9501 </dl>
9502 </dd>
9503
9504 <!-- OBJECT METHODS -->
9505 <dd style="display: none; ">
9506 <div></div>
9507 </dd>
9508
9509 <!-- OBJECT EVENT FIELDS -->
9510 <dd style="display: none; ">
9511 <div></div>
9512 </dd>
9513
9514 <!-- FUNCTION PARAMETERS -->
9515 <dd style="display: none; ">
9516 <div></div>
9517 </dd>
9518
9519 </div>
9520 </div><div>
9521 <div>
9522 <dt>
9523 <var>statusLine</var>
9524 <em>
9525
9526 <!-- TYPE -->
9527 <div style="display:inline">
9528 (
9529 <span class="optional">optional</span>
9530 <span class="enum" style="display: none; ">enumerated</span>
9531 <span id="typeTemplate">
9532 <span style="display: none; ">
9533 <a> Type</a>
9534 </span>
9535 <span>
9536 <span style="display: none; ">
9537 array of <span><span></span></span>
9538 </span>
9539 <span>string</span>
9540 <span style="display: none; "></span>
9541 </span>
9542 </span>
9543 )
9544 </div>
9545
9546 </em>
9547 </dt>
9548 <dd class="todo" style="display: none; ">
9549 Undocumented.
9550 </dd>
9551 <dd>HTTP status line of the response</dd>
9552 <dd style="display: none; ">
9553 This parameter was added in version
9554 <b><span></span></b>.
9555 You must omit this parameter in earlier versions,
9556 and you may omit it in any version. If you require this
9557 parameter, the manifest key
9558 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9559 can ensure that your extension won't be run in an earlier browser ve rsion.
9560 </dd>
9561
9562 <!-- OBJECT PROPERTIES -->
9563 <dd style="display: none; ">
9564 <dl>
9565 <div>
9566 <div>
9567 </div>
9568 </div>
9569 </dl>
9570 </dd>
9571
9572 <!-- OBJECT METHODS -->
9573 <dd style="display: none; ">
9574 <div></div>
9575 </dd>
9576
9577 <!-- OBJECT EVENT FIELDS -->
9578 <dd style="display: none; ">
9579 <div></div>
9580 </dd>
9581
9582 <!-- FUNCTION PARAMETERS -->
9583 <dd style="display: none; ">
9584 <div></div>
9585 </dd>
9586
9587 </div>
9588 </div>
9589 </dl>
9590 </dd>
9591
9592 <!-- OBJECT METHODS -->
9593 <dd style="display: none; ">
9594 <div></div>
9595 </dd>
9596
9597 <!-- OBJECT EVENT FIELDS -->
9598 <dd style="display: none; ">
9599 <div></div>
9600 </dd>
9601
9602 <!-- FUNCTION PARAMETERS -->
9603 <dd style="display: none; ">
9604 <div></div>
9605 </dd>
9606
9607 </div>
9608 </div>
9609 </dl>
9610 </div>
9611
9612 <!-- EXTRA PARAMETERS -->
9613 <div>
9614 <h4>Extra parameters to addListener</h4>
9615 <dl>
9616 <div>
9617 <div>
9618 <dt>
9619 <var>filter</var>
9620 <em>
9621
9622 <!-- TYPE -->
9623 <div style="display:inline">
9624 (
9625 <span class="optional">optional</span>
9626 <span class="enum" style="display: none; ">enumerated</span>
9627 <span id="typeTemplate">
9628 <span>
9629 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
9630 </span>
9631 <span style="display: none; ">
9632 <span>
9633 array of <span><span></span></span>
9634 </span>
9635 <span>paramType</span>
9636 <span></span>
9637 </span>
9638 </span>
9639 )
9640 </div>
9641
9642 </em>
9643 </dt>
9644 <dd class="todo" style="display: none; ">
9645 Undocumented.
9646 </dd>
9647 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
9648 <dd style="display: none; ">
9649 This parameter was added in version
9650 <b><span></span></b>.
9651 You must omit this parameter in earlier versions,
9652 and you may omit it in any version. If you require this
9653 parameter, the manifest key
9654 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9655 can ensure that your extension won't be run in an earlier browser ve rsion.
9656 </dd>
9657
9658 <!-- OBJECT PROPERTIES -->
9659 <dd style="display: none; ">
9660 <dl>
9661 <div>
9662 <div>
9663 </div>
9664 </div>
9665 </dl>
9666 </dd>
9667
9668 <!-- OBJECT METHODS -->
9669 <dd style="display: none; ">
9670 <div></div>
9671 </dd>
9672
9673 <!-- OBJECT EVENT FIELDS -->
9674 <dd style="display: none; ">
9675 <div></div>
9676 </dd>
9677
9678 <!-- FUNCTION PARAMETERS -->
9679 <dd style="display: none; ">
9680 <div></div>
9681 </dd>
9682
9683 </div>
9684 </div><div>
9685 <div>
9686 <dt>
9687 <var>extraInfoSpec</var>
9688 <em>
9689
9690 <!-- TYPE -->
9691 <div style="display:inline">
9692 (
9693 <span class="optional">optional</span>
9694 <span class="enum" style="display: none; ">enumerated</span>
9695 <span id="typeTemplate">
9696 <span style="display: none; ">
9697 <a> Type</a>
9698 </span>
9699 <span>
9700 <span>
9701 array of <span><span>
9702 <span style="display: none; ">
9703 <a> Type</a>
9704 </span>
9705 <span>
9706 <span style="display: none; ">
9707 array of <span><span></span></span>
9708 </span>
9709 <span>string</span>
9710 <span>["responseHeaders"]</span>
9711 </span>
9712 </span></span>
9713 </span>
9714 <span style="display: none; ">paramType</span>
9715 <span style="display: none; "></span>
9716 </span>
9717 </span>
9718 )
9719 </div>
9720
9721 </em>
9722 </dt>
9723 <dd class="todo" style="display: none; ">
9724 Undocumented.
9725 </dd>
9726 <dd>Array of extra information that should be passed to the listener f unction.</dd>
9727 <dd style="display: none; ">
9728 This parameter was added in version
9729 <b><span></span></b>.
9730 You must omit this parameter in earlier versions,
9731 and you may omit it in any version. If you require this
9732 parameter, the manifest key
9733 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9734 can ensure that your extension won't be run in an earlier browser ve rsion.
9735 </dd>
9736
9737 <!-- OBJECT PROPERTIES -->
9738 <dd style="display: none; ">
9739 <dl>
9740 <div>
9741 <div>
9742 </div>
9743 </div>
9744 </dl>
9745 </dd>
9746
9747 <!-- OBJECT METHODS -->
9748 <dd style="display: none; ">
9749 <div></div>
9750 </dd>
9751
9752 <!-- OBJECT EVENT FIELDS -->
9753 <dd style="display: none; ">
9754 <div></div>
9755 </dd>
9756
9757 <!-- FUNCTION PARAMETERS -->
9758 <dd style="display: none; ">
9759 <div></div>
9760 </dd>
9761
9762 </div>
9763 </div>
9764 </dl>
9765 </div>
9766
9767 <!-- LISTENER RETURN VALUE -->
9768 <h4 style="display: none; ">Listener returns</h4>
9769 <dl>
9770 <div style="display: none; ">
9771 <div>
9772 </div>
9773 </div>
9774 </dl>
9775
9776 </div> <!-- /description -->
9777 </div><div class="apiItem">
9778 <a name="event-onSendHeaders"></a>
9779 <h4>onSendHeaders</h4>
9780
9781 <div class="summary">
9782 <!-- Note: intentionally longer 80 columns -->
9783 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onSendHeaders</span><span class="subdued">.addListener</span>(function(<span>o bject details</span>) <span class="subdued">{...}</span><span>, RequestFilter fi lter, array of string extraInfoSpec</span>);
9784 </div>
9785
9786 <div class="description">
9787 <p class="todo" style="display: none; ">Undocumented.</p>
9788 <p>Fired just before a request is going to be sent to the server (modifications of prvious onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).</p>
9789
9790 <!-- LISTENER PARAMETERS -->
9791 <div>
9792 <h4>Listener parameters</h4>
9793 <dl>
9794 <div>
9795 <div>
9796 <dt>
9797 <var>details</var>
9798 <em>
9799
9800 <!-- TYPE -->
9801 <div style="display:inline">
9802 (
9803 <span class="optional" style="display: none; ">optional</spa n>
9804 <span class="enum" style="display: none; ">enumerated</span>
9805 <span id="typeTemplate">
9806 <span style="display: none; ">
9807 <a> Type</a>
9808 </span>
9809 <span>
9810 <span style="display: none; ">
9811 array of <span><span></span></span>
9812 </span>
9813 <span>object</span>
9814 <span style="display: none; "></span>
9815 </span>
9816 </span>
9817 )
9818 </div>
9819
9820 </em>
9821 </dt>
9822 <dd class="todo">
9823 Undocumented.
9824 </dd>
9825 <dd style="display: none; ">
9826 Description of this parameter from the json schema.
9827 </dd>
9828 <dd style="display: none; ">
9829 This parameter was added in version
9830 <b><span></span></b>.
9831 You must omit this parameter in earlier versions,
9832 and you may omit it in any version. If you require this
9833 parameter, the manifest key
9834 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9835 can ensure that your extension won't be run in an earlier browser ve rsion.
9836 </dd>
9837
9838 <!-- OBJECT PROPERTIES -->
9839 <dd>
9840 <dl>
9841 <div>
9842 <div>
9843 <dt>
9844 <var>requestId</var>
9845 <em>
9846
9847 <!-- TYPE -->
9848 <div style="display:inline">
9849 (
9850 <span class="optional" style="display: none; ">optional</spa n>
9851 <span class="enum" style="display: none; ">enumerated</span>
9852 <span id="typeTemplate">
9853 <span style="display: none; ">
9854 <a> Type</a>
9855 </span>
9856 <span>
9857 <span style="display: none; ">
9858 array of <span><span></span></span>
9859 </span>
9860 <span>string</span>
9861 <span style="display: none; "></span>
9862 </span>
9863 </span>
9864 )
9865 </div>
9866
9867 </em>
9868 </dt>
9869 <dd class="todo" style="display: none; ">
9870 Undocumented.
9871 </dd>
9872 <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>
9873 <dd style="display: none; ">
9874 This parameter was added in version
9875 <b><span></span></b>.
9876 You must omit this parameter in earlier versions,
9877 and you may omit it in any version. If you require this
9878 parameter, the manifest key
9879 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9880 can ensure that your extension won't be run in an earlier browser ve rsion.
9881 </dd>
9882
9883 <!-- OBJECT PROPERTIES -->
9884 <dd style="display: none; ">
9885 <dl>
9886 <div>
9887 <div>
9888 </div>
9889 </div>
9890 </dl>
9891 </dd>
9892
9893 <!-- OBJECT METHODS -->
9894 <dd style="display: none; ">
9895 <div></div>
9896 </dd>
9897
9898 <!-- OBJECT EVENT FIELDS -->
9899 <dd style="display: none; ">
9900 <div></div>
9901 </dd>
9902
9903 <!-- FUNCTION PARAMETERS -->
9904 <dd style="display: none; ">
9905 <div></div>
9906 </dd>
9907
9908 </div>
9909 </div><div>
9910 <div>
9911 <dt>
9912 <var>url</var>
9913 <em>
9914
9915 <!-- TYPE -->
9916 <div style="display:inline">
9917 (
9918 <span class="optional" style="display: none; ">optional</spa n>
9919 <span class="enum" style="display: none; ">enumerated</span>
9920 <span id="typeTemplate">
9921 <span style="display: none; ">
9922 <a> Type</a>
9923 </span>
9924 <span>
9925 <span style="display: none; ">
9926 array of <span><span></span></span>
9927 </span>
9928 <span>string</span>
9929 <span style="display: none; "></span>
9930 </span>
9931 </span>
9932 )
9933 </div>
9934
9935 </em>
9936 </dt>
9937 <dd class="todo">
9938 Undocumented.
9939 </dd>
9940 <dd style="display: none; ">
9941 Description of this parameter from the json schema.
9942 </dd>
9943 <dd style="display: none; ">
9944 This parameter was added in version
9945 <b><span></span></b>.
9946 You must omit this parameter in earlier versions,
9947 and you may omit it in any version. If you require this
9948 parameter, the manifest key
9949 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
9950 can ensure that your extension won't be run in an earlier browser ve rsion.
9951 </dd>
9952
9953 <!-- OBJECT PROPERTIES -->
9954 <dd style="display: none; ">
9955 <dl>
9956 <div>
9957 <div>
9958 </div>
9959 </div>
9960 </dl>
9961 </dd>
9962
9963 <!-- OBJECT METHODS -->
9964 <dd style="display: none; ">
9965 <div></div>
9966 </dd>
9967
9968 <!-- OBJECT EVENT FIELDS -->
9969 <dd style="display: none; ">
9970 <div></div>
9971 </dd>
9972
9973 <!-- FUNCTION PARAMETERS -->
9974 <dd style="display: none; ">
9975 <div></div>
9976 </dd>
9977
9978 </div>
9979 </div><div>
9980 <div>
9981 <dt>
9982 <var>method</var>
9983 <em>
9984
9985 <!-- TYPE -->
9986 <div style="display:inline">
9987 (
9988 <span class="optional" style="display: none; ">optional</spa n>
9989 <span class="enum" style="display: none; ">enumerated</span>
9990 <span id="typeTemplate">
9991 <span style="display: none; ">
9992 <a> Type</a>
9993 </span>
9994 <span>
9995 <span style="display: none; ">
9996 array of <span><span></span></span>
9997 </span>
9998 <span>string</span>
9999 <span style="display: none; "></span>
10000 </span>
10001 </span>
10002 )
10003 </div>
10004
10005 </em>
10006 </dt>
10007 <dd class="todo" style="display: none; ">
10008 Undocumented.
10009 </dd>
10010 <dd>Standard HTTP method.</dd>
10011 <dd style="display: none; ">
10012 This parameter was added in version
10013 <b><span></span></b>.
10014 You must omit this parameter in earlier versions,
10015 and you may omit it in any version. If you require this
10016 parameter, the manifest key
10017 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10018 can ensure that your extension won't be run in an earlier browser ve rsion.
10019 </dd>
10020
10021 <!-- OBJECT PROPERTIES -->
10022 <dd style="display: none; ">
10023 <dl>
10024 <div>
10025 <div>
10026 </div>
10027 </div>
10028 </dl>
10029 </dd>
10030
10031 <!-- OBJECT METHODS -->
10032 <dd style="display: none; ">
10033 <div></div>
10034 </dd>
10035
10036 <!-- OBJECT EVENT FIELDS -->
10037 <dd style="display: none; ">
10038 <div></div>
10039 </dd>
10040
10041 <!-- FUNCTION PARAMETERS -->
10042 <dd style="display: none; ">
10043 <div></div>
10044 </dd>
10045
10046 </div>
10047 </div><div>
10048 <div>
10049 <dt>
10050 <var>frameId</var>
10051 <em>
10052
10053 <!-- TYPE -->
10054 <div style="display:inline">
10055 (
10056 <span class="optional" style="display: none; ">optional</spa n>
10057 <span class="enum" style="display: none; ">enumerated</span>
10058 <span id="typeTemplate">
10059 <span style="display: none; ">
10060 <a> Type</a>
10061 </span>
10062 <span>
10063 <span style="display: none; ">
10064 array of <span><span></span></span>
10065 </span>
10066 <span>integer</span>
10067 <span style="display: none; "></span>
10068 </span>
10069 </span>
10070 )
10071 </div>
10072
10073 </em>
10074 </dt>
10075 <dd class="todo" style="display: none; ">
10076 Undocumented.
10077 </dd>
10078 <dd>0 indicates the request happens in the main frame; a positive valu e indicates the ID of a subframe in which the request happens. If the document o f a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code >sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
10079 <dd style="display: none; ">
10080 This parameter was added in version
10081 <b><span></span></b>.
10082 You must omit this parameter in earlier versions,
10083 and you may omit it in any version. If you require this
10084 parameter, the manifest key
10085 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10086 can ensure that your extension won't be run in an earlier browser ve rsion.
10087 </dd>
10088
10089 <!-- OBJECT PROPERTIES -->
10090 <dd style="display: none; ">
10091 <dl>
10092 <div>
10093 <div>
10094 </div>
10095 </div>
10096 </dl>
10097 </dd>
10098
10099 <!-- OBJECT METHODS -->
10100 <dd style="display: none; ">
10101 <div></div>
10102 </dd>
10103
10104 <!-- OBJECT EVENT FIELDS -->
10105 <dd style="display: none; ">
10106 <div></div>
10107 </dd>
10108
10109 <!-- FUNCTION PARAMETERS -->
10110 <dd style="display: none; ">
10111 <div></div>
10112 </dd>
10113
10114 </div>
10115 </div><div>
10116 <div>
10117 <dt>
10118 <var>parentFrameId</var>
10119 <em>
10120
10121 <!-- TYPE -->
10122 <div style="display:inline">
10123 (
10124 <span class="optional" style="display: none; ">optional</spa n>
10125 <span class="enum" style="display: none; ">enumerated</span>
10126 <span id="typeTemplate">
10127 <span style="display: none; ">
10128 <a> Type</a>
10129 </span>
10130 <span>
10131 <span style="display: none; ">
10132 array of <span><span></span></span>
10133 </span>
10134 <span>integer</span>
10135 <span style="display: none; "></span>
10136 </span>
10137 </span>
10138 )
10139 </div>
10140
10141 </em>
10142 </dt>
10143 <dd class="todo" style="display: none; ">
10144 Undocumented.
10145 </dd>
10146 <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
10147 <dd style="display: none; ">
10148 This parameter was added in version
10149 <b><span></span></b>.
10150 You must omit this parameter in earlier versions,
10151 and you may omit it in any version. If you require this
10152 parameter, the manifest key
10153 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10154 can ensure that your extension won't be run in an earlier browser ve rsion.
10155 </dd>
10156
10157 <!-- OBJECT PROPERTIES -->
10158 <dd style="display: none; ">
10159 <dl>
10160 <div>
10161 <div>
10162 </div>
10163 </div>
10164 </dl>
10165 </dd>
10166
10167 <!-- OBJECT METHODS -->
10168 <dd style="display: none; ">
10169 <div></div>
10170 </dd>
10171
10172 <!-- OBJECT EVENT FIELDS -->
10173 <dd style="display: none; ">
10174 <div></div>
10175 </dd>
10176
10177 <!-- FUNCTION PARAMETERS -->
10178 <dd style="display: none; ">
10179 <div></div>
10180 </dd>
10181
10182 </div>
10183 </div><div>
10184 <div>
10185 <dt>
10186 <var>tabId</var>
10187 <em>
10188
10189 <!-- TYPE -->
10190 <div style="display:inline">
10191 (
10192 <span class="optional" style="display: none; ">optional</spa n>
10193 <span class="enum" style="display: none; ">enumerated</span>
10194 <span id="typeTemplate">
10195 <span style="display: none; ">
10196 <a> Type</a>
10197 </span>
10198 <span>
10199 <span style="display: none; ">
10200 array of <span><span></span></span>
10201 </span>
10202 <span>integer</span>
10203 <span style="display: none; "></span>
10204 </span>
10205 </span>
10206 )
10207 </div>
10208
10209 </em>
10210 </dt>
10211 <dd class="todo" style="display: none; ">
10212 Undocumented.
10213 </dd>
10214 <dd>The ID of the tab in which the request takes place. Set to -1 if t he request isn't related to a tab.</dd>
10215 <dd style="display: none; ">
10216 This parameter was added in version
10217 <b><span></span></b>.
10218 You must omit this parameter in earlier versions,
10219 and you may omit it in any version. If you require this
10220 parameter, the manifest key
10221 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10222 can ensure that your extension won't be run in an earlier browser ve rsion.
10223 </dd>
10224
10225 <!-- OBJECT PROPERTIES -->
10226 <dd style="display: none; ">
10227 <dl>
10228 <div>
10229 <div>
10230 </div>
10231 </div>
10232 </dl>
10233 </dd>
10234
10235 <!-- OBJECT METHODS -->
10236 <dd style="display: none; ">
10237 <div></div>
10238 </dd>
10239
10240 <!-- OBJECT EVENT FIELDS -->
10241 <dd style="display: none; ">
10242 <div></div>
10243 </dd>
10244
10245 <!-- FUNCTION PARAMETERS -->
10246 <dd style="display: none; ">
10247 <div></div>
10248 </dd>
10249
10250 </div>
10251 </div><div>
10252 <div>
10253 <dt>
10254 <var>type</var>
10255 <em>
10256
10257 <!-- TYPE -->
10258 <div style="display:inline">
10259 (
10260 <span class="optional" style="display: none; ">optional</spa n>
10261 <span class="enum">enumerated</span>
10262 <span id="typeTemplate">
10263 <span style="display: none; ">
10264 <a> Type</a>
10265 </span>
10266 <span>
10267 <span style="display: none; ">
10268 array of <span><span></span></span>
10269 </span>
10270 <span>string</span>
10271 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
10272 </span>
10273 </span>
10274 )
10275 </div>
10276
10277 </em>
10278 </dt>
10279 <dd class="todo" style="display: none; ">
10280 Undocumented.
10281 </dd>
10282 <dd>How the requested resource will be used.</dd>
10283 <dd style="display: none; ">
10284 This parameter was added in version
10285 <b><span></span></b>.
10286 You must omit this parameter in earlier versions,
10287 and you may omit it in any version. If you require this
10288 parameter, the manifest key
10289 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10290 can ensure that your extension won't be run in an earlier browser ve rsion.
10291 </dd>
10292
10293 <!-- OBJECT PROPERTIES -->
10294 <dd style="display: none; ">
10295 <dl>
10296 <div>
10297 <div>
10298 </div>
10299 </div>
10300 </dl>
10301 </dd>
10302
10303 <!-- OBJECT METHODS -->
10304 <dd style="display: none; ">
10305 <div></div>
10306 </dd>
10307
10308 <!-- OBJECT EVENT FIELDS -->
10309 <dd style="display: none; ">
10310 <div></div>
10311 </dd>
10312
10313 <!-- FUNCTION PARAMETERS -->
10314 <dd style="display: none; ">
10315 <div></div>
10316 </dd>
10317
10318 </div>
10319 </div><div>
10320 <div>
10321 <dt>
10322 <var>timeStamp</var>
10323 <em>
10324
10325 <!-- TYPE -->
10326 <div style="display:inline">
10327 (
10328 <span class="optional" style="display: none; ">optional</spa n>
10329 <span class="enum" style="display: none; ">enumerated</span>
10330 <span id="typeTemplate">
10331 <span style="display: none; ">
10332 <a> Type</a>
10333 </span>
10334 <span>
10335 <span style="display: none; ">
10336 array of <span><span></span></span>
10337 </span>
10338 <span>number</span>
10339 <span style="display: none; "></span>
10340 </span>
10341 </span>
10342 )
10343 </div>
10344
10345 </em>
10346 </dt>
10347 <dd class="todo" style="display: none; ">
10348 Undocumented.
10349 </dd>
10350 <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
10351 <dd style="display: none; ">
10352 This parameter was added in version
10353 <b><span></span></b>.
10354 You must omit this parameter in earlier versions,
10355 and you may omit it in any version. If you require this
10356 parameter, the manifest key
10357 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10358 can ensure that your extension won't be run in an earlier browser ve rsion.
10359 </dd>
10360
10361 <!-- OBJECT PROPERTIES -->
10362 <dd style="display: none; ">
10363 <dl>
10364 <div>
10365 <div>
10366 </div>
10367 </div>
10368 </dl>
10369 </dd>
10370
10371 <!-- OBJECT METHODS -->
10372 <dd style="display: none; ">
10373 <div></div>
10374 </dd>
10375
10376 <!-- OBJECT EVENT FIELDS -->
10377 <dd style="display: none; ">
10378 <div></div>
10379 </dd>
10380
10381 <!-- FUNCTION PARAMETERS -->
10382 <dd style="display: none; ">
10383 <div></div>
10384 </dd>
10385
10386 </div>
10387 </div><div>
10388 <div>
10389 <dt>
10390 <var>requestHeaders</var>
10391 <em>
10392
10393 <!-- TYPE -->
10394 <div style="display:inline">
10395 (
10396 <span class="optional">optional</span>
10397 <span class="enum" style="display: none; ">enumerated</span>
10398 <span id="typeTemplate">
10399 <span>
10400 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
10401 </span>
10402 <span style="display: none; ">
10403 <span>
10404 array of <span><span></span></span>
10405 </span>
10406 <span>paramType</span>
10407 <span></span>
10408 </span>
10409 </span>
10410 )
10411 </div>
10412
10413 </em>
10414 </dt>
10415 <dd class="todo" style="display: none; ">
10416 Undocumented.
10417 </dd>
10418 <dd>The HTTP request headers that have been sent out with this request .</dd>
10419 <dd style="display: none; ">
10420 This parameter was added in version
10421 <b><span></span></b>.
10422 You must omit this parameter in earlier versions,
10423 and you may omit it in any version. If you require this
10424 parameter, the manifest key
10425 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10426 can ensure that your extension won't be run in an earlier browser ve rsion.
10427 </dd>
10428
10429 <!-- OBJECT PROPERTIES -->
10430 <dd style="display: none; ">
10431 <dl>
10432 <div>
10433 <div>
10434 </div>
10435 </div>
10436 </dl>
10437 </dd>
10438
10439 <!-- OBJECT METHODS -->
10440 <dd style="display: none; ">
10441 <div></div>
10442 </dd>
10443
10444 <!-- OBJECT EVENT FIELDS -->
10445 <dd style="display: none; ">
10446 <div></div>
10447 </dd>
10448
10449 <!-- FUNCTION PARAMETERS -->
10450 <dd style="display: none; ">
10451 <div></div>
10452 </dd>
10453
10454 </div>
10455 </div>
10456 </dl>
10457 </dd>
10458
10459 <!-- OBJECT METHODS -->
10460 <dd style="display: none; ">
10461 <div></div>
10462 </dd>
10463
10464 <!-- OBJECT EVENT FIELDS -->
10465 <dd style="display: none; ">
10466 <div></div>
10467 </dd>
10468
10469 <!-- FUNCTION PARAMETERS -->
10470 <dd style="display: none; ">
10471 <div></div>
10472 </dd>
10473
10474 </div>
10475 </div>
10476 </dl>
10477 </div>
10478
10479 <!-- EXTRA PARAMETERS -->
10480 <div>
10481 <h4>Extra parameters to addListener</h4>
10482 <dl>
10483 <div>
10484 <div>
10485 <dt>
10486 <var>filter</var>
10487 <em>
10488
10489 <!-- TYPE -->
10490 <div style="display:inline">
10491 (
10492 <span class="optional">optional</span>
10493 <span class="enum" style="display: none; ">enumerated</span>
10494 <span id="typeTemplate">
10495 <span>
10496 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a>
10497 </span>
10498 <span style="display: none; ">
10499 <span>
10500 array of <span><span></span></span>
10501 </span>
10502 <span>paramType</span>
10503 <span></span>
10504 </span>
10505 </span>
10506 )
10507 </div>
10508
10509 </em>
10510 </dt>
10511 <dd class="todo" style="display: none; ">
10512 Undocumented.
10513 </dd>
10514 <dd>A set of filters that restricts the events that will be sent to th is listener.</dd>
10515 <dd style="display: none; ">
10516 This parameter was added in version
10517 <b><span></span></b>.
10518 You must omit this parameter in earlier versions,
10519 and you may omit it in any version. If you require this
10520 parameter, the manifest key
10521 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10522 can ensure that your extension won't be run in an earlier browser ve rsion.
10523 </dd>
10524
10525 <!-- OBJECT PROPERTIES -->
10526 <dd style="display: none; ">
10527 <dl>
10528 <div>
10529 <div>
10530 </div>
10531 </div>
10532 </dl>
10533 </dd>
10534
10535 <!-- OBJECT METHODS -->
10536 <dd style="display: none; ">
10537 <div></div>
10538 </dd>
10539
10540 <!-- OBJECT EVENT FIELDS -->
10541 <dd style="display: none; ">
10542 <div></div>
10543 </dd>
10544
10545 <!-- FUNCTION PARAMETERS -->
10546 <dd style="display: none; ">
10547 <div></div>
10548 </dd>
10549
10550 </div>
10551 </div><div>
10552 <div>
10553 <dt>
10554 <var>extraInfoSpec</var>
10555 <em>
10556
10557 <!-- TYPE -->
10558 <div style="display:inline">
10559 (
10560 <span class="optional">optional</span>
10561 <span class="enum" style="display: none; ">enumerated</span>
10562 <span id="typeTemplate">
10563 <span style="display: none; ">
10564 <a> Type</a>
10565 </span>
10566 <span>
10567 <span>
10568 array of <span><span>
10569 <span style="display: none; ">
10570 <a> Type</a>
10571 </span>
10572 <span>
10573 <span style="display: none; ">
10574 array of <span><span></span></span>
10575 </span>
10576 <span>string</span>
10577 <span>["requestHeaders"]</span>
10578 </span>
10579 </span></span>
10580 </span>
10581 <span style="display: none; ">paramType</span>
10582 <span style="display: none; "></span>
10583 </span>
10584 </span>
10585 )
10586 </div>
10587
10588 </em>
10589 </dt>
10590 <dd class="todo" style="display: none; ">
10591 Undocumented.
10592 </dd>
10593 <dd>Array of extra information that should be passed to the listener f unction.</dd>
10594 <dd style="display: none; ">
10595 This parameter was added in version
10596 <b><span></span></b>.
10597 You must omit this parameter in earlier versions,
10598 and you may omit it in any version. If you require this
10599 parameter, the manifest key
10600 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10601 can ensure that your extension won't be run in an earlier browser ve rsion.
10602 </dd>
10603
10604 <!-- OBJECT PROPERTIES -->
10605 <dd style="display: none; ">
10606 <dl>
10607 <div>
10608 <div>
10609 </div>
10610 </div>
10611 </dl>
10612 </dd>
10613
10614 <!-- OBJECT METHODS -->
10615 <dd style="display: none; ">
10616 <div></div>
10617 </dd>
10618
10619 <!-- OBJECT EVENT FIELDS -->
10620 <dd style="display: none; ">
10621 <div></div>
10622 </dd>
10623
10624 <!-- FUNCTION PARAMETERS -->
10625 <dd style="display: none; ">
10626 <div></div>
10627 </dd>
10628
10629 </div>
10630 </div>
10631 </dl>
10632 </div>
10633
10634 <!-- LISTENER RETURN VALUE -->
10635 <h4 style="display: none; ">Listener returns</h4>
10636 <dl>
10637 <div style="display: none; ">
10638 <div>
10639 </div>
10640 </div>
10641 </dl>
10642
10643 </div> <!-- /description -->
10644 </div> <!-- /apiItem -->
10645
10646 </div> <!-- /apiGroup -->
10647
10648 <!-- TYPES -->
10649 <div class="apiGroup">
10650 <a name="types"></a>
10651 <h3 id="types">Types</h3>
10652
10653 <!-- iterates over all types -->
10654 <div class="apiItem">
10655 <a name="type-RequestFilter"></a>
10656 <h4>RequestFilter</h4>
10657
10658 <div>
10659 <dt>
10660 <var style="display: none; ">paramName</var>
10661 <em>
10662
10663 <!-- TYPE -->
10664 <div style="display:inline">
10665 (
10666 <span class="optional" style="display: none; ">optional</spa n>
10667 <span class="enum" style="display: none; ">enumerated</span>
10668 <span id="typeTemplate">
10669 <span style="display: none; ">
10670 <a> Type</a>
10671 </span>
10672 <span>
10673 <span style="display: none; ">
10674 array of <span><span></span></span>
10675 </span>
10676 <span>object</span>
10677 <span style="display: none; "></span>
10678 </span>
10679 </span>
10680 )
10681 </div>
10682
10683 </em>
10684 </dt>
10685 <dd class="todo" style="display: none; ">
10686 Undocumented.
10687 </dd>
10688 <dd>An object describing filters to apply to webRequest events.</dd>
10689 <dd style="display: none; ">
10690 This parameter was added in version
10691 <b><span></span></b>.
10692 You must omit this parameter in earlier versions,
10693 and you may omit it in any version. If you require this
10694 parameter, the manifest key
10695 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10696 can ensure that your extension won't be run in an earlier browser ve rsion.
10697 </dd>
10698
10699 <!-- OBJECT PROPERTIES -->
10700 <dd>
10701 <dl>
10702 <div>
10703 <div>
10704 <dt>
10705 <var>urls</var>
10706 <em>
10707
10708 <!-- TYPE -->
10709 <div style="display:inline">
10710 (
10711 <span class="optional">optional</span>
10712 <span class="enum" style="display: none; ">enumerated</span>
10713 <span id="typeTemplate">
10714 <span style="display: none; ">
10715 <a> Type</a>
10716 </span>
10717 <span>
10718 <span>
10719 array of <span><span>
10720 <span style="display: none; ">
10721 <a> Type</a>
10722 </span>
10723 <span>
10724 <span style="display: none; ">
10725 array of <span><span></span></span>
10726 </span>
10727 <span>string</span>
10728 <span style="display: none; "></span>
10729 </span>
10730 </span></span>
10731 </span>
10732 <span style="display: none; ">paramType</span>
10733 <span style="display: none; "></span>
10734 </span>
10735 </span>
10736 )
10737 </div>
10738
10739 </em>
10740 </dt>
10741 <dd class="todo" style="display: none; ">
10742 Undocumented.
10743 </dd>
10744 <dd>A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.</dd>
10745 <dd style="display: none; ">
10746 This parameter was added in version
10747 <b><span></span></b>.
10748 You must omit this parameter in earlier versions,
10749 and you may omit it in any version. If you require this
10750 parameter, the manifest key
10751 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10752 can ensure that your extension won't be run in an earlier browser ve rsion.
10753 </dd>
10754
10755 <!-- OBJECT PROPERTIES -->
10756 <dd style="display: none; ">
10757 <dl>
10758 <div>
10759 <div>
10760 </div>
10761 </div>
10762 </dl>
10763 </dd>
10764
10765 <!-- OBJECT METHODS -->
10766 <dd style="display: none; ">
10767 <div></div>
10768 </dd>
10769
10770 <!-- OBJECT EVENT FIELDS -->
10771 <dd style="display: none; ">
10772 <div></div>
10773 </dd>
10774
10775 <!-- FUNCTION PARAMETERS -->
10776 <dd style="display: none; ">
10777 <div></div>
10778 </dd>
10779
10780 </div>
10781 </div><div>
10782 <div>
10783 <dt>
10784 <var>types</var>
10785 <em>
10786
10787 <!-- TYPE -->
10788 <div style="display:inline">
10789 (
10790 <span class="optional">optional</span>
10791 <span class="enum" style="display: none; ">enumerated</span>
10792 <span id="typeTemplate">
10793 <span style="display: none; ">
10794 <a> Type</a>
10795 </span>
10796 <span>
10797 <span>
10798 array of <span><span>
10799 <span style="display: none; ">
10800 <a> Type</a>
10801 </span>
10802 <span>
10803 <span style="display: none; ">
10804 array of <span><span></span></span>
10805 </span>
10806 <span>string</span>
10807 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
10808 </span>
10809 </span></span>
10810 </span>
10811 <span style="display: none; ">paramType</span>
10812 <span style="display: none; "></span>
10813 </span>
10814 </span>
10815 )
10816 </div>
10817
10818 </em>
10819 </dt>
10820 <dd class="todo" style="display: none; ">
10821 Undocumented.
10822 </dd>
10823 <dd>A list of request types. Requests that cannot match any of the typ es will be filtered out.</dd>
10824 <dd style="display: none; ">
10825 This parameter was added in version
10826 <b><span></span></b>.
10827 You must omit this parameter in earlier versions,
10828 and you may omit it in any version. If you require this
10829 parameter, the manifest key
10830 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10831 can ensure that your extension won't be run in an earlier browser ve rsion.
10832 </dd>
10833
10834 <!-- OBJECT PROPERTIES -->
10835 <dd style="display: none; ">
10836 <dl>
10837 <div>
10838 <div>
10839 </div>
10840 </div>
10841 </dl>
10842 </dd>
10843
10844 <!-- OBJECT METHODS -->
10845 <dd style="display: none; ">
10846 <div></div>
10847 </dd>
10848
10849 <!-- OBJECT EVENT FIELDS -->
10850 <dd style="display: none; ">
10851 <div></div>
10852 </dd>
10853
10854 <!-- FUNCTION PARAMETERS -->
10855 <dd style="display: none; ">
10856 <div></div>
10857 </dd>
10858
10859 </div>
10860 </div><div>
10861 <div>
10862 <dt>
10863 <var>tabId</var>
10864 <em>
10865
10866 <!-- TYPE -->
10867 <div style="display:inline">
10868 (
10869 <span class="optional">optional</span>
10870 <span class="enum" style="display: none; ">enumerated</span>
10871 <span id="typeTemplate">
10872 <span style="display: none; ">
10873 <a> Type</a>
10874 </span>
10875 <span>
10876 <span style="display: none; ">
10877 array of <span><span></span></span>
10878 </span>
10879 <span>integer</span>
10880 <span style="display: none; "></span>
10881 </span>
10882 </span>
10883 )
10884 </div>
10885
10886 </em>
10887 </dt>
10888 <dd class="todo">
10889 Undocumented.
10890 </dd>
10891 <dd style="display: none; ">
10892 Description of this parameter from the json schema.
10893 </dd>
10894 <dd style="display: none; ">
10895 This parameter was added in version
10896 <b><span></span></b>.
10897 You must omit this parameter in earlier versions,
10898 and you may omit it in any version. If you require this
10899 parameter, the manifest key
10900 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10901 can ensure that your extension won't be run in an earlier browser ve rsion.
10902 </dd>
10903
10904 <!-- OBJECT PROPERTIES -->
10905 <dd style="display: none; ">
10906 <dl>
10907 <div>
10908 <div>
10909 </div>
10910 </div>
10911 </dl>
10912 </dd>
10913
10914 <!-- OBJECT METHODS -->
10915 <dd style="display: none; ">
10916 <div></div>
10917 </dd>
10918
10919 <!-- OBJECT EVENT FIELDS -->
10920 <dd style="display: none; ">
10921 <div></div>
10922 </dd>
10923
10924 <!-- FUNCTION PARAMETERS -->
10925 <dd style="display: none; ">
10926 <div></div>
10927 </dd>
10928
10929 </div>
10930 </div><div>
10931 <div>
10932 <dt>
10933 <var>windowId</var>
10934 <em>
10935
10936 <!-- TYPE -->
10937 <div style="display:inline">
10938 (
10939 <span class="optional">optional</span>
10940 <span class="enum" style="display: none; ">enumerated</span>
10941 <span id="typeTemplate">
10942 <span style="display: none; ">
10943 <a> Type</a>
10944 </span>
10945 <span>
10946 <span style="display: none; ">
10947 array of <span><span></span></span>
10948 </span>
10949 <span>integer</span>
10950 <span style="display: none; "></span>
10951 </span>
10952 </span>
10953 )
10954 </div>
10955
10956 </em>
10957 </dt>
10958 <dd class="todo">
10959 Undocumented.
10960 </dd>
10961 <dd style="display: none; ">
10962 Description of this parameter from the json schema.
10963 </dd>
10964 <dd style="display: none; ">
10965 This parameter was added in version
10966 <b><span></span></b>.
10967 You must omit this parameter in earlier versions,
10968 and you may omit it in any version. If you require this
10969 parameter, the manifest key
10970 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10971 can ensure that your extension won't be run in an earlier browser ve rsion.
10972 </dd>
10973
10974 <!-- OBJECT PROPERTIES -->
10975 <dd style="display: none; ">
10976 <dl>
10977 <div>
10978 <div>
10979 </div>
10980 </div>
10981 </dl>
10982 </dd>
10983
10984 <!-- OBJECT METHODS -->
10985 <dd style="display: none; ">
10986 <div></div>
10987 </dd>
10988
10989 <!-- OBJECT EVENT FIELDS -->
10990 <dd style="display: none; ">
10991 <div></div>
10992 </dd>
10993
10994 <!-- FUNCTION PARAMETERS -->
10995 <dd style="display: none; ">
10996 <div></div>
10997 </dd>
10998
10999 </div>
11000 </div>
11001 </dl>
11002 </dd>
11003
11004 <!-- OBJECT METHODS -->
11005 <dd style="display: none; ">
11006 <div></div>
11007 </dd>
11008
11009 <!-- OBJECT EVENT FIELDS -->
11010 <dd style="display: none; ">
11011 <div></div>
11012 </dd>
11013
11014 <!-- FUNCTION PARAMETERS -->
11015 <dd style="display: none; ">
11016 <div></div>
11017 </dd>
11018
11019 </div>
11020
11021 </div><div class="apiItem">
11022 <a name="type-HttpHeaders"></a>
11023 <h4>HttpHeaders</h4>
11024
11025 <div>
11026 <dt>
11027 <var style="display: none; ">paramName</var>
11028 <em>
11029
11030 <!-- TYPE -->
11031 <div style="display:inline">
11032 (
11033 <span class="optional" style="display: none; ">optional</spa n>
11034 <span class="enum" style="display: none; ">enumerated</span>
11035 <span id="typeTemplate">
11036 <span style="display: none; ">
11037 <a> Type</a>
11038 </span>
11039 <span>
11040 <span>
11041 array of <span><span>
11042 <span style="display: none; ">
11043 <a> Type</a>
11044 </span>
11045 <span>
11046 <span style="display: none; ">
11047 array of <span><span></span></span>
11048 </span>
11049 <span>object</span>
11050 <span style="display: none; "></span>
11051 </span>
11052 </span></span>
11053 </span>
11054 <span style="display: none; ">paramType</span>
11055 <span style="display: none; "></span>
11056 </span>
11057 </span>
11058 )
11059 </div>
11060
11061 </em>
11062 </dt>
11063 <dd class="todo" style="display: none; ">
11064 Undocumented.
11065 </dd>
11066 <dd>An array of HTTP headers. Each header is represented as a dictiona ry containing the keys <code>name</code> and either <code>value</code> or <code> binaryValue</code>.</dd>
11067 <dd style="display: none; ">
11068 This parameter was added in version
11069 <b><span></span></b>.
11070 You must omit this parameter in earlier versions,
11071 and you may omit it in any version. If you require this
11072 parameter, the manifest key
11073 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11074 can ensure that your extension won't be run in an earlier browser ve rsion.
11075 </dd>
11076
11077 <!-- OBJECT PROPERTIES -->
11078 <dd>
11079 <dl>
11080 <div>
11081 <div>
11082 <dt>
11083 <var>name</var>
11084 <em>
11085
11086 <!-- TYPE -->
11087 <div style="display:inline">
11088 (
11089 <span class="optional" style="display: none; ">optional</spa n>
11090 <span class="enum" style="display: none; ">enumerated</span>
11091 <span id="typeTemplate">
11092 <span style="display: none; ">
11093 <a> Type</a>
11094 </span>
11095 <span>
11096 <span style="display: none; ">
11097 array of <span><span></span></span>
11098 </span>
11099 <span>string</span>
11100 <span style="display: none; "></span>
11101 </span>
11102 </span>
11103 )
11104 </div>
11105
11106 </em>
11107 </dt>
11108 <dd class="todo" style="display: none; ">
11109 Undocumented.
11110 </dd>
11111 <dd>Name of the HTTP header.</dd>
11112 <dd style="display: none; ">
11113 This parameter was added in version
11114 <b><span></span></b>.
11115 You must omit this parameter in earlier versions,
11116 and you may omit it in any version. If you require this
11117 parameter, the manifest key
11118 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11119 can ensure that your extension won't be run in an earlier browser ve rsion.
11120 </dd>
11121
11122 <!-- OBJECT PROPERTIES -->
11123 <dd style="display: none; ">
11124 <dl>
11125 <div>
11126 <div>
11127 </div>
11128 </div>
11129 </dl>
11130 </dd>
11131
11132 <!-- OBJECT METHODS -->
11133 <dd style="display: none; ">
11134 <div></div>
11135 </dd>
11136
11137 <!-- OBJECT EVENT FIELDS -->
11138 <dd style="display: none; ">
11139 <div></div>
11140 </dd>
11141
11142 <!-- FUNCTION PARAMETERS -->
11143 <dd style="display: none; ">
11144 <div></div>
11145 </dd>
11146
11147 </div>
11148 </div><div>
11149 <div>
11150 <dt>
11151 <var>value</var>
11152 <em>
11153
11154 <!-- TYPE -->
11155 <div style="display:inline">
11156 (
11157 <span class="optional">optional</span>
11158 <span class="enum" style="display: none; ">enumerated</span>
11159 <span id="typeTemplate">
11160 <span style="display: none; ">
11161 <a> Type</a>
11162 </span>
11163 <span>
11164 <span style="display: none; ">
11165 array of <span><span></span></span>
11166 </span>
11167 <span>string</span>
11168 <span style="display: none; "></span>
11169 </span>
11170 </span>
11171 )
11172 </div>
11173
11174 </em>
11175 </dt>
11176 <dd class="todo" style="display: none; ">
11177 Undocumented.
11178 </dd>
11179 <dd>Value of the HTTP header if it can be represented by UTF-8.</dd>
11180 <dd style="display: none; ">
11181 This parameter was added in version
11182 <b><span></span></b>.
11183 You must omit this parameter in earlier versions,
11184 and you may omit it in any version. If you require this
11185 parameter, the manifest key
11186 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11187 can ensure that your extension won't be run in an earlier browser ve rsion.
11188 </dd>
11189
11190 <!-- OBJECT PROPERTIES -->
11191 <dd style="display: none; ">
11192 <dl>
11193 <div>
11194 <div>
11195 </div>
11196 </div>
11197 </dl>
11198 </dd>
11199
11200 <!-- OBJECT METHODS -->
11201 <dd style="display: none; ">
11202 <div></div>
11203 </dd>
11204
11205 <!-- OBJECT EVENT FIELDS -->
11206 <dd style="display: none; ">
11207 <div></div>
11208 </dd>
11209
11210 <!-- FUNCTION PARAMETERS -->
11211 <dd style="display: none; ">
11212 <div></div>
11213 </dd>
11214
11215 </div>
11216 </div><div>
11217 <div>
11218 <dt>
11219 <var>binaryValue</var>
11220 <em>
11221
11222 <!-- TYPE -->
11223 <div style="display:inline">
11224 (
11225 <span class="optional">optional</span>
11226 <span class="enum" style="display: none; ">enumerated</span>
11227 <span id="typeTemplate">
11228 <span style="display: none; ">
11229 <a> Type</a>
11230 </span>
11231 <span>
11232 <span>
11233 array of <span><span>
11234 <span style="display: none; ">
11235 <a> Type</a>
11236 </span>
11237 <span>
11238 <span style="display: none; ">
11239 array of <span><span></span></span>
11240 </span>
11241 <span>integer</span>
11242 <span style="display: none; "></span>
11243 </span>
11244 </span></span>
11245 </span>
11246 <span style="display: none; ">paramType</span>
11247 <span style="display: none; "></span>
11248 </span>
11249 </span>
11250 )
11251 </div>
11252
11253 </em>
11254 </dt>
11255 <dd class="todo" style="display: none; ">
11256 Undocumented.
11257 </dd>
11258 <dd>Value of the HTTP header if it cannot be represented by UTF-8, sto red as individual byte values (0..255).</dd>
11259 <dd style="display: none; ">
11260 This parameter was added in version
11261 <b><span></span></b>.
11262 You must omit this parameter in earlier versions,
11263 and you may omit it in any version. If you require this
11264 parameter, the manifest key
11265 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11266 can ensure that your extension won't be run in an earlier browser ve rsion.
11267 </dd>
11268
11269 <!-- OBJECT PROPERTIES -->
11270 <dd style="display: none; ">
11271 <dl>
11272 <div>
11273 <div>
11274 </div>
11275 </div>
11276 </dl>
11277 </dd>
11278
11279 <!-- OBJECT METHODS -->
11280 <dd style="display: none; ">
11281 <div></div>
11282 </dd>
11283
11284 <!-- OBJECT EVENT FIELDS -->
11285 <dd style="display: none; ">
11286 <div></div>
11287 </dd>
11288
11289 <!-- FUNCTION PARAMETERS -->
11290 <dd style="display: none; ">
11291 <div></div>
11292 </dd>
11293
11294 </div>
11295 </div>
11296 </dl>
11297 </dd>
11298
11299 <!-- OBJECT METHODS -->
11300 <dd style="display: none; ">
11301 <div></div>
11302 </dd>
11303
11304 <!-- OBJECT EVENT FIELDS -->
11305 <dd style="display: none; ">
11306 <div></div>
11307 </dd>
11308
11309 <!-- FUNCTION PARAMETERS -->
11310 <dd style="display: none; ">
11311 <div></div>
11312 </dd>
11313
11314 </div>
11315
11316 </div><div class="apiItem">
11317 <a name="type-BlockingResponse"></a>
11318 <h4>BlockingResponse</h4>
11319
11320 <div>
11321 <dt>
11322 <var style="display: none; ">paramName</var>
11323 <em>
11324
11325 <!-- TYPE -->
11326 <div style="display:inline">
11327 (
11328 <span class="optional" style="display: none; ">optional</spa n>
11329 <span class="enum" style="display: none; ">enumerated</span>
11330 <span id="typeTemplate">
11331 <span style="display: none; ">
11332 <a> Type</a>
11333 </span>
11334 <span>
11335 <span style="display: none; ">
11336 array of <span><span></span></span>
11337 </span>
11338 <span>object</span>
11339 <span style="display: none; "></span>
11340 </span>
11341 </span>
11342 )
11343 </div>
11344
11345 </em>
11346 </dt>
11347 <dd class="todo" style="display: none; ">
11348 Undocumented.
11349 </dd>
11350 <dd>Returns value for event handlers that have the 'blocking' extraInf oSpec applied. Allows the event handler to modify network requests.</dd>
11351 <dd style="display: none; ">
11352 This parameter was added in version
11353 <b><span></span></b>.
11354 You must omit this parameter in earlier versions,
11355 and you may omit it in any version. If you require this
11356 parameter, the manifest key
11357 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11358 can ensure that your extension won't be run in an earlier browser ve rsion.
11359 </dd>
11360
11361 <!-- OBJECT PROPERTIES -->
11362 <dd>
11363 <dl>
11364 <div>
11365 <div>
11366 <dt>
11367 <var>cancel</var>
11368 <em>
11369
11370 <!-- TYPE -->
11371 <div style="display:inline">
11372 (
11373 <span class="optional">optional</span>
11374 <span class="enum" style="display: none; ">enumerated</span>
11375 <span id="typeTemplate">
11376 <span style="display: none; ">
11377 <a> Type</a>
11378 </span>
11379 <span>
11380 <span style="display: none; ">
11381 array of <span><span></span></span>
11382 </span>
11383 <span>boolean</span>
11384 <span style="display: none; "></span>
11385 </span>
11386 </span>
11387 )
11388 </div>
11389
11390 </em>
11391 </dt>
11392 <dd class="todo" style="display: none; ">
11393 Undocumented.
11394 </dd>
11395 <dd>If true, the request is cancelled. Used in onBeforeRequest, this p revents the request from being sent.</dd>
11396 <dd style="display: none; ">
11397 This parameter was added in version
11398 <b><span></span></b>.
11399 You must omit this parameter in earlier versions,
11400 and you may omit it in any version. If you require this
11401 parameter, the manifest key
11402 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11403 can ensure that your extension won't be run in an earlier browser ve rsion.
11404 </dd>
11405
11406 <!-- OBJECT PROPERTIES -->
11407 <dd style="display: none; ">
11408 <dl>
11409 <div>
11410 <div>
11411 </div>
11412 </div>
11413 </dl>
11414 </dd>
11415
11416 <!-- OBJECT METHODS -->
11417 <dd style="display: none; ">
11418 <div></div>
11419 </dd>
11420
11421 <!-- OBJECT EVENT FIELDS -->
11422 <dd style="display: none; ">
11423 <div></div>
11424 </dd>
11425
11426 <!-- FUNCTION PARAMETERS -->
11427 <dd style="display: none; ">
11428 <div></div>
11429 </dd>
11430
11431 </div>
11432 </div><div>
11433 <div>
11434 <dt>
11435 <var>redirectUrl</var>
11436 <em>
11437
11438 <!-- TYPE -->
11439 <div style="display:inline">
11440 (
11441 <span class="optional">optional</span>
11442 <span class="enum" style="display: none; ">enumerated</span>
11443 <span id="typeTemplate">
11444 <span style="display: none; ">
11445 <a> Type</a>
11446 </span>
11447 <span>
11448 <span style="display: none; ">
11449 array of <span><span></span></span>
11450 </span>
11451 <span>string</span>
11452 <span style="display: none; "></span>
11453 </span>
11454 </span>
11455 )
11456 </div>
11457
11458 </em>
11459 </dt>
11460 <dd class="todo" style="display: none; ">
11461 Undocumented.
11462 </dd>
11463 <dd>Only used as a response to the onBeforeRequest event. If set, the original request is prevented from being sent and is instead redirected to the g iven URL.</dd>
11464 <dd style="display: none; ">
11465 This parameter was added in version
11466 <b><span></span></b>.
11467 You must omit this parameter in earlier versions,
11468 and you may omit it in any version. If you require this
11469 parameter, the manifest key
11470 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11471 can ensure that your extension won't be run in an earlier browser ve rsion.
11472 </dd>
11473
11474 <!-- OBJECT PROPERTIES -->
11475 <dd style="display: none; ">
11476 <dl>
11477 <div>
11478 <div>
11479 </div>
11480 </div>
11481 </dl>
11482 </dd>
11483
11484 <!-- OBJECT METHODS -->
11485 <dd style="display: none; ">
11486 <div></div>
11487 </dd>
11488
11489 <!-- OBJECT EVENT FIELDS -->
11490 <dd style="display: none; ">
11491 <div></div>
11492 </dd>
11493
11494 <!-- FUNCTION PARAMETERS -->
11495 <dd style="display: none; ">
11496 <div></div>
11497 </dd>
11498
11499 </div>
11500 </div><div>
11501 <div>
11502 <dt>
11503 <var>requestHeaders</var>
11504 <em>
11505
11506 <!-- TYPE -->
11507 <div style="display:inline">
11508 (
11509 <span class="optional">optional</span>
11510 <span class="enum" style="display: none; ">enumerated</span>
11511 <span id="typeTemplate">
11512 <span>
11513 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
11514 </span>
11515 <span style="display: none; ">
11516 <span>
11517 array of <span><span></span></span>
11518 </span>
11519 <span>paramType</span>
11520 <span></span>
11521 </span>
11522 </span>
11523 )
11524 </div>
11525
11526 </em>
11527 </dt>
11528 <dd class="todo" style="display: none; ">
11529 Undocumented.
11530 </dd>
11531 <dd>Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead.</dd>
11532 <dd style="display: none; ">
11533 This parameter was added in version
11534 <b><span></span></b>.
11535 You must omit this parameter in earlier versions,
11536 and you may omit it in any version. If you require this
11537 parameter, the manifest key
11538 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11539 can ensure that your extension won't be run in an earlier browser ve rsion.
11540 </dd>
11541
11542 <!-- OBJECT PROPERTIES -->
11543 <dd style="display: none; ">
11544 <dl>
11545 <div>
11546 <div>
11547 </div>
11548 </div>
11549 </dl>
11550 </dd>
11551
11552 <!-- OBJECT METHODS -->
11553 <dd style="display: none; ">
11554 <div></div>
11555 </dd>
11556
11557 <!-- OBJECT EVENT FIELDS -->
11558 <dd style="display: none; ">
11559 <div></div>
11560 </dd>
11561
11562 <!-- FUNCTION PARAMETERS -->
11563 <dd style="display: none; ">
11564 <div></div>
11565 </dd>
11566
11567 </div>
11568 </div><div>
11569 <div>
11570 <dt>
11571 <var>responseHeaders</var>
11572 <em>
11573
11574 <!-- TYPE -->
11575 <div style="display:inline">
11576 (
11577 <span class="optional">optional</span>
11578 <span class="enum" style="display: none; ">enumerated</span>
11579 <span id="typeTemplate">
11580 <span>
11581 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a>
11582 </span>
11583 <span style="display: none; ">
11584 <span>
11585 array of <span><span></span></span>
11586 </span>
11587 <span>paramType</span>
11588 <span></span>
11589 </span>
11590 </span>
11591 )
11592 </div>
11593
11594 </em>
11595 </dt>
11596 <dd class="todo" style="display: none; ">
11597 Undocumented.
11598 </dd>
11599 <dd>Only used as a response to the onHeadersReceived event. If set, th e server is assumed to have responsed with these response headers instead. Only return <code>responseHeaders</code> if you really want to modify the headers in order to limit the number of conflicts (only one extension may modify <code>resp onseHeaders</code> for each request).</dd>
11600 <dd style="display: none; ">
11601 This parameter was added in version
11602 <b><span></span></b>.
11603 You must omit this parameter in earlier versions,
11604 and you may omit it in any version. If you require this
11605 parameter, the manifest key
11606 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11607 can ensure that your extension won't be run in an earlier browser ve rsion.
11608 </dd>
11609
11610 <!-- OBJECT PROPERTIES -->
11611 <dd style="display: none; ">
11612 <dl>
11613 <div>
11614 <div>
11615 </div>
11616 </div>
11617 </dl>
11618 </dd>
11619
11620 <!-- OBJECT METHODS -->
11621 <dd style="display: none; ">
11622 <div></div>
11623 </dd>
11624
11625 <!-- OBJECT EVENT FIELDS -->
11626 <dd style="display: none; ">
11627 <div></div>
11628 </dd>
11629
11630 <!-- FUNCTION PARAMETERS -->
11631 <dd style="display: none; ">
11632 <div></div>
11633 </dd>
11634
11635 </div>
11636 </div><div>
11637 <div>
11638 <dt>
11639 <var>authCredentials</var>
11640 <em>
11641
11642 <!-- TYPE -->
11643 <div style="display:inline">
11644 (
11645 <span class="optional">optional</span>
11646 <span class="enum" style="display: none; ">enumerated</span>
11647 <span id="typeTemplate">
11648 <span style="display: none; ">
11649 <a> Type</a>
11650 </span>
11651 <span>
11652 <span style="display: none; ">
11653 array of <span><span></span></span>
11654 </span>
11655 <span>object</span>
11656 <span style="display: none; "></span>
11657 </span>
11658 </span>
11659 )
11660 </div>
11661
11662 </em>
11663 </dt>
11664 <dd class="todo" style="display: none; ">
11665 Undocumented.
11666 </dd>
11667 <dd>Only used as a response to the onAuthRequired event. If set, the r equest is made using the supplied credentials.</dd>
11668 <dd style="display: none; ">
11669 This parameter was added in version
11670 <b><span></span></b>.
11671 You must omit this parameter in earlier versions,
11672 and you may omit it in any version. If you require this
11673 parameter, the manifest key
11674 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11675 can ensure that your extension won't be run in an earlier browser ve rsion.
11676 </dd>
11677
11678 <!-- OBJECT PROPERTIES -->
11679 <dd>
11680 <dl>
11681 <div>
11682 <div>
11683 <dt>
11684 <var>username</var>
11685 <em>
11686
11687 <!-- TYPE -->
11688 <div style="display:inline">
11689 (
11690 <span class="optional" style="display: none; ">optional</spa n>
11691 <span class="enum" style="display: none; ">enumerated</span>
11692 <span id="typeTemplate">
11693 <span style="display: none; ">
11694 <a> Type</a>
11695 </span>
11696 <span>
11697 <span style="display: none; ">
11698 array of <span><span></span></span>
11699 </span>
11700 <span>string</span>
11701 <span style="display: none; "></span>
11702 </span>
11703 </span>
11704 )
11705 </div>
11706
11707 </em>
11708 </dt>
11709 <dd class="todo">
11710 Undocumented.
11711 </dd>
11712 <dd style="display: none; ">
11713 Description of this parameter from the json schema.
11714 </dd>
11715 <dd style="display: none; ">
11716 This parameter was added in version
11717 <b><span></span></b>.
11718 You must omit this parameter in earlier versions,
11719 and you may omit it in any version. If you require this
11720 parameter, the manifest key
11721 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11722 can ensure that your extension won't be run in an earlier browser ve rsion.
11723 </dd>
11724
11725 <!-- OBJECT PROPERTIES -->
11726 <dd style="display: none; ">
11727 <dl>
11728 <div>
11729 <div>
11730 </div>
11731 </div>
11732 </dl>
11733 </dd>
11734
11735 <!-- OBJECT METHODS -->
11736 <dd style="display: none; ">
11737 <div></div>
11738 </dd>
11739
11740 <!-- OBJECT EVENT FIELDS -->
11741 <dd style="display: none; ">
11742 <div></div>
11743 </dd>
11744
11745 <!-- FUNCTION PARAMETERS -->
11746 <dd style="display: none; ">
11747 <div></div>
11748 </dd>
11749
11750 </div>
11751 </div><div>
11752 <div>
11753 <dt>
11754 <var>password</var>
11755 <em>
11756
11757 <!-- TYPE -->
11758 <div style="display:inline">
11759 (
11760 <span class="optional" style="display: none; ">optional</spa n>
11761 <span class="enum" style="display: none; ">enumerated</span>
11762 <span id="typeTemplate">
11763 <span style="display: none; ">
11764 <a> Type</a>
11765 </span>
11766 <span>
11767 <span style="display: none; ">
11768 array of <span><span></span></span>
11769 </span>
11770 <span>string</span>
11771 <span style="display: none; "></span>
11772 </span>
11773 </span>
11774 )
11775 </div>
11776
11777 </em>
11778 </dt>
11779 <dd class="todo">
11780 Undocumented.
11781 </dd>
11782 <dd style="display: none; ">
11783 Description of this parameter from the json schema.
11784 </dd>
11785 <dd style="display: none; ">
11786 This parameter was added in version
11787 <b><span></span></b>.
11788 You must omit this parameter in earlier versions,
11789 and you may omit it in any version. If you require this
11790 parameter, the manifest key
11791 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
11792 can ensure that your extension won't be run in an earlier browser ve rsion.
11793 </dd>
11794
11795 <!-- OBJECT PROPERTIES -->
11796 <dd style="display: none; ">
11797 <dl>
11798 <div>
11799 <div>
11800 </div>
11801 </div>
11802 </dl>
11803 </dd>
11804
11805 <!-- OBJECT METHODS -->
11806 <dd style="display: none; ">
11807 <div></div>
11808 </dd>
11809
11810 <!-- OBJECT EVENT FIELDS -->
11811 <dd style="display: none; ">
11812 <div></div>
11813 </dd>
11814
11815 <!-- FUNCTION PARAMETERS -->
11816 <dd style="display: none; ">
11817 <div></div>
11818 </dd>
11819
11820 </div>
11821 </div>
11822 </dl>
11823 </dd>
11824
11825 <!-- OBJECT METHODS -->
11826 <dd style="display: none; ">
11827 <div></div>
11828 </dd>
11829
11830 <!-- OBJECT EVENT FIELDS -->
11831 <dd style="display: none; ">
11832 <div></div>
11833 </dd>
11834
11835 <!-- FUNCTION PARAMETERS -->
11836 <dd style="display: none; ">
11837 <div></div>
11838 </dd>
11839
11840 </div>
11841 </div>
11842 </dl>
11843 </dd>
11844
11845 <!-- OBJECT METHODS -->
11846 <dd style="display: none; ">
11847 <div></div>
11848 </dd>
11849
11850 <!-- OBJECT EVENT FIELDS -->
11851 <dd style="display: none; ">
11852 <div></div>
11853 </dd>
11854
11855 <!-- FUNCTION PARAMETERS -->
11856 <dd style="display: none; ">
11857 <div></div>
11858 </dd>
11859
11860 </div>
11861
11862 </div> <!-- /apiItem -->
11863
11864 </div> <!-- /apiGroup -->
11865
11866 </div> <!-- /apiPage -->
11867 </div> <!-- /gc-pagecontent -->
11868 </div> <!-- /g-section -->
11869 </div> <!-- /codesiteContent -->
11870 <div id="gc-footer" --="">
11871 <div class="text">
11872 <p>
11873 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
11874 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
11875 Attribution 3.0 License</a>, and code samples are licensed under the
11876 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
11877 </p>
11878 <p>
11879 ©2011 Google
11880 </p>
11881
11882 <!-- begin analytics -->
11883 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
11884 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
11885
11886 <script type="text/javascript">
11887 // chrome doc tracking
11888 try {
11889 var engdocs = _gat._getTracker("YT-10763712-2");
11890 engdocs._trackPageview();
11891 } catch(err) {}
11892
11893 // code.google.com site-wide tracking
11894 try {
11895 _uacct="UA-18071-1";
11896 _uanchor=1;
11897 _uff=0;
11898 urchinTracker();
11899 }
11900 catch(e) {/* urchinTracker not available. */}
11901 </script>
11902 <!-- end analytics -->
11903 </div>
11904 </div> <!-- /gc-footer -->
11905 </div> <!-- /gc-container -->
11906 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/manifest.html » ('j') | chrome/common/extensions/extension_permission_set.cc » ('J')

Powered by Google App Engine
This is Rietveld 408576698