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/jstemplate_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_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 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 </div> <!-- /SUBTEMPLATES --> 111 112 <a id="top"></a> 113 <div id="skipto"> 114 <a href="#gc-pagecontent">Skip to page content</a> 115 <a href="#gc-toc">Skip to main navigation</a> 116 </div> 117 <!-- API HEADER --> 118 <table id="header" width="100%" cellspacing="0" border="0"> 119 <tbody><tr> 120 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 121 <td valign="middle" width="100%" style="padding-left:0.6em;"> 122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 123 <div id="gsc-search-box"> 124 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 125 <input type="hidden" name="ie" value="UTF-8"> 126 <input type="text" name="q" value="" size="55"> 127 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 128 <br> 129 <span class="greytext">e.g. "page action" or "tabs"</span> 130 </div> 131 </form> 132 133 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 137 </td> 138 </tr> 139 </tbody></table> 140 141 <div id="codesiteContent" class=""> 142 143 <a id="gc-topnav-anchor"></a> 144 <div id="gc-topnav"> 145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 146 <ul id="home" class="gc-topnav-tabs"> 147 <li id="home_link"> 148 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 149 </li> 150 <li id="docs_link"> 151 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 155 </li> 156 <li id="samples_link"> 157 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 158 </li> 159 <li id="group_link"> 160 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 161 </li> 162 </ul> 163 </div> <!-- end gc-topnav --> 164 165 <div class="g-section g-tpl-170"> 166 <!-- SIDENAV --> 167 <div class="g-unit g-first" id="gc-toc"> 168 <ul> 169 <li><a href="getstarted.html">Getting Started</a></li> 170 <li><a href="overview.html">Overview</a></li> 171 <li><a href="whats_new.html">What's New?</a></li> 172 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 173 <ul> 174 <li>Browser UI 175 <ul> 176 <li><a href="browserAction.html">Browser Actions</a></li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li><a href="omnibox.html">Omnibox</a></li> 180 <li><a href="options.html">Options Pages</a></li> 181 <li><a href="override.html">Override Pages</a></li> 182 <li><a href="pageAction.html">Page Actions</a></li> 183 </ul> 184 </li> 185 <li>Browser Interaction 186 <ul> 187 <li><a href="bookmarks.html">Bookmarks</a></li> 188 <li><a href="cookies.html">Cookies</a></li> 189 <li><a href="events.html">Events</a></li> 190 <li><a href="history.html">History</a></li> 191 <li><a href="management.html">Management</a></li> 192 <li><a href="tabs.html">Tabs</a></li> 193 <li><a href="windows.html">Windows</a></li> 194 </ul> 195 </li> 196 <li>Implementation 197 <ul> 198 <li><a href="a11y.html">Accessibility</a></li> 199 <li><a href="background_pages.html">Background Pages</a></li> 200 <li><a href="content_scripts.html">Content Scripts</a></li> 201 <li><a href="xhr.html">Cross-Origin XHR</a></li> 202 <li><a href="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">WebRequest API</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#H2-0">A note about timestamps</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li> 268 <li> 269 <a href="#apiReference">API reference: chrome.experimental.webRequest</a> 270 <ol> 271 <li style="display: none; "> 272 <a href="#properties">Properties</a> 273 <ol> 274 <li> 275 <a href="#property-anchor">propertyName</a> 276 </li> 277 </ol> 278 </li> 279 <li> 280 <a href="#global-methods">Methods</a> 281 <ol> 282 <li style="display: none; "> 283 <a href="#method-anchor">methodName</a> 284 </li><li style="display: none; "> 285 <a href="#method-anchor">methodName</a> 286 </li> 287 </ol> 288 </li> 289 <li> 290 <a href="#global-events">Events</a> 291 <ol> 292 <li> 293 <a href="#event-onBeforeRedirect">onBeforeRedirect</a> 294 </li><li> 295 <a href="#event-onBeforeRequest">onBeforeRequest</a> 296 </li><li> 297 <a href="#event-onBeforeSendHeaders">onBeforeSendHeaders</a> 298 </li><li> 299 <a href="#event-onCompleted">onCompleted</a> 300 </li><li> 301 <a href="#event-onErrorOccurred">onErrorOccurred</a> 302 </li><li> 303 <a href="#event-onHeadersReceived">onHeadersReceived</a> 304 </li><li> 305 <a href="#event-onRequestSent">onRequestSent</a> 306 </li> 307 </ol> 308 </li> 309 <li> 310 <a href="#types">Types</a> 311 <ol> 312 <li> 313 <a href="#type-RequestFilter">RequestFilter</a> 314 </li><li> 315 <a href="#type-BlockingResponse">BlockingResponse</a> 316 </li> 317 </ol> 318 </li> 319 </ol> 320 </li> 321 </ol> 322 </div> 323 <!-- /TABLE OF CONTENTS --> 324 325 <!-- Standard content lead-in for experimental API pages --> 326 <p id="classSummary" style="display: none; "> 327 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 328 </p> 329 330 <!-- STATIC CONTENT PLACEHOLDER --> 331 <div id="static"><div id="pageData-name" class="pageData">WebRequest API</div> 332 333 <!-- BEGIN AUTHORED CONTENT --> 334 <p id="classSummary"> 335 Use the <code>chrome.experimental.webRequest</code> module to intercept, block, 336 or modify requests in-flight. This module is still very much experimental. For 337 information on how to use experimental APIs, see the 338 <a href="experimental.html">chrome.experimental.* APIs</a> page. 339 </p> 340 341 <a name="H2-0"></a><h2>A note about timestamps</h2> 342 <p> 343 It's important to note that some technical oddities in the OS's handling 344 of distinct Chrome processes can cause the clock to be skewed between the 345 browser itself and extension processes. That means that WebRequest's events' 346 <code>timeStamp</code> property is only guaranteed to be <i>internally</i> 347 consistent. Comparing one event to another event will give you the correct 348 offset between them, but comparing them to the current time inside the 349 extension (via <code>(new Date()).getTime()</code>, for instance) might give 350 unexpected results. 351 </p> 352 <!-- END AUTHORED CONTENT --> 353 </div> 354 355 <!-- API PAGE --> 356 <div class="apiPage"> 357 <a name="apiReference"></a> 358 <h2>API reference: chrome.experimental.webRequest</h2> 359 360 <!-- PROPERTIES --> 361 <div class="apiGroup" style="display: none; "> 362 <a name="properties"></a> 363 <h3 id="properties">Properties</h3> 364 365 <div> 366 <a></a> 367 <h4>getLastError</h4> 368 <div class="summary"> 369 <!-- Note: intentionally longer 80 columns --> 370 <span>chrome.extension</span><span>lastError</span> 371 </div> 372 <div> 373 </div> 374 </div> 375 376 </div> <!-- /apiGroup --> 377 378 <!-- METHODS --> 379 <div id="methodsTemplate" class="apiGroup"> 380 <a name="global-methods"></a> 381 <h3>Methods</h3> 382 383 <!-- iterates over all functions --> 384 <div class="apiItem" style="display: none; "> 385 <a></a> <!-- method-anchor --> 386 <h4>method name</h4> 387 388 <div class="summary"><span>void</span> 389 <!-- Note: intentionally longer 80 columns --> 390 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 391 <var><span></span></var></span>)</div> 392 393 <div class="description"> 394 <p class="todo">Undocumented.</p> 395 <p> 396 A description from the json schema def of the function goes here. 397 </p> 398 399 <!-- PARAMETERS --> 400 <h4>Parameters</h4> 401 <dl> 402 <div> 403 <div> 404 </div> 405 </div> 406 </dl> 407 408 <!-- RETURNS --> 409 <h4>Returns</h4> 410 <dl> 411 <div> 412 <div> 413 </div> 414 </div> 415 </dl> 416 417 <!-- CALLBACK --> 418 <div> 419 <div> 420 <h4>Callback function</h4> 421 <p> 422 The callback <em>parameter</em> should specify a function 423 that looks like this: 424 </p> 425 <p> 426 If you specify the <em>callback</em> parameter, it should 427 specify a function that looks like this: 428 </p> 429 430 <!-- Note: intentionally longer 80 columns --> 431 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 432 <dl> 433 <div> 434 <div> 435 </div> 436 </div> 437 </dl> 438 </div> 439 </div> 440 441 <!-- MIN_VERSION --> 442 <p> 443 This function was added in version <b><span></span></b>. 444 If you require this function, the manifest key 445 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 446 can ensure that your extension won't be run in an earlier browser version. 447 </p> 448 </div> <!-- /description --> 449 450 </div><div class="apiItem" style="display: none; "> 451 <a></a> <!-- method-anchor --> 452 <h4>method name</h4> 453 454 <div class="summary"><span>void</span> 455 <!-- Note: intentionally longer 80 columns --> 456 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 457 <var><span></span></var></span>)</div> 458 459 <div class="description"> 460 <p class="todo">Undocumented.</p> 461 <p> 462 A description from the json schema def of the function goes here. 463 </p> 464 465 <!-- PARAMETERS --> 466 <h4>Parameters</h4> 467 <dl> 468 <div> 469 <div> 470 </div> 471 </div> 472 </dl> 473 474 <!-- RETURNS --> 475 <h4>Returns</h4> 476 <dl> 477 <div> 478 <div> 479 </div> 480 </div> 481 </dl> 482 483 <!-- CALLBACK --> 484 <div> 485 <div> 486 <h4>Callback function</h4> 487 <p> 488 The callback <em>parameter</em> should specify a function 489 that looks like this: 490 </p> 491 <p> 492 If you specify the <em>callback</em> parameter, it should 493 specify a function that looks like this: 494 </p> 495 496 <!-- Note: intentionally longer 80 columns --> 497 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 498 <dl> 499 <div> 500 <div> 501 </div> 502 </div> 503 </dl> 504 </div> 505 </div> 506 507 <!-- MIN_VERSION --> 508 <p> 509 This function was added in version <b><span></span></b>. 510 If you require this function, the manifest key 511 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 512 can ensure that your extension won't be run in an earlier browser version. 513 </p> 514 </div> <!-- /description --> 515 516 </div> <!-- /apiItem --> 517 518 </div> <!-- /apiGroup --> 519 520 <!-- EVENTS --> 521 <div id="eventsTemplate" class="apiGroup"> 522 <a name="global-events"></a> 523 <h3>Events</h3> 524 <!-- iterates over all events --> 525 <div class="apiItem"> 526 <a name="event-onBeforeRedirect"></a> 527 <h4>onBeforeRedirect</h4> 528 529 <div class="summary"> 530 <!-- Note: intentionally longer 80 columns --> 531 <span class="subdued">chrome.experimental.webRequest.</span><span>onBeforeRedirect</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 532 </div> 533 534 <div class="description"> 535 <p class="todo" style="display: none; ">Undocumented.</p> 536 <p>Fires when a server initiated redirect is about to occur.</p> 537 538 <!-- PARAMETERS --> 539 <div> 540 <h4>Parameters</h4> 541 <dl> 542 <div> 543 <div> 544 <dt> 545 <var>details</var> 546 <em> 547 548 <!-- TYPE --> 549 <div style="display:inline"> 550 ( 551 <span class="optional" style="display: none; ">optional</span> 552 <span class="enum" style="display: none; ">enumerated</span> 553 <span id="typeTemplate"> 554 <span style="display: none; "> 555 <a> Type</a> 556 </span> 557 <span> 558 <span style="display: none; "> 559 array of <span><span></span></span> 560 </span> 561 <span>object</span> 562 <span style="display: none; "></span> 563 </span> 564 </span> 565 ) 566 </div> 567 568 </em> 569 </dt> 570 <dd class="todo"> 571 Undocumented. 572 </dd> 573 <dd style="display: none; "> 574 Description of this parameter from the json schema. 575 </dd> 576 <dd style="display: none; "> 577 This parameter was added in version 578 <b><span></span></b>. 579 You must omit this parameter in earlier versions, 580 and you may omit it in any version. If you require this 581 parameter, the manifest key 582 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 583 can ensure that your extension won't be run in an earlier browser version. 584 </dd> 585 586 <!-- OBJECT PROPERTIES --> 587 <dd> 588 <dl> 589 <div> 590 <div> 591 <dt> 592 <var>requestId</var> 593 <em> 594 595 <!-- TYPE --> 596 <div style="display:inline"> 597 ( 598 <span class="optional" style="display: none; ">optional</span> 599 <span class="enum" style="display: none; ">enumerated</span> 600 <span id="typeTemplate"> 601 <span style="display: none; "> 602 <a> Type</a> 603 </span> 604 <span> 605 <span style="display: none; "> 606 array of <span><span></span></span> 607 </span> 608 <span>string</span> 609 <span style="display: none; "></span> 610 </span> 611 </span> 612 ) 613 </div> 614 615 </em> 616 </dt> 617 <dd class="todo" style="display: none; "> 618 Undocumented. 619 </dd> 620 <dd>The ID of the request.</dd> 621 <dd style="display: none; "> 622 This parameter was added in version 623 <b><span></span></b>. 624 You must omit this parameter in earlier versions, 625 and you may omit it in any version. If you require this 626 parameter, the manifest key 627 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 628 can ensure that your extension won't be run in an earlier browser version. 629 </dd> 630 631 <!-- OBJECT PROPERTIES --> 632 <dd style="display: none; "> 633 <dl> 634 <div> 635 <div> 636 </div> 637 </div> 638 </dl> 639 </dd> 640 641 <!-- OBJECT METHODS --> 642 <dd style="display: none; "> 643 <div></div> 644 </dd> 645 646 <!-- OBJECT EVENT FIELDS --> 647 <dd style="display: none; "> 648 <div></div> 649 </dd> 650 651 <!-- FUNCTION PARAMETERS --> 652 <dd style="display: none; "> 653 <div></div> 654 </dd> 655 656 </div> 657 </div><div> 658 <div> 659 <dt> 660 <var>url</var> 661 <em> 662 663 <!-- TYPE --> 664 <div style="display:inline"> 665 ( 666 <span class="optional" style="display: none; ">optional</span> 667 <span class="enum" style="display: none; ">enumerated</span> 668 <span id="typeTemplate"> 669 <span style="display: none; "> 670 <a> Type</a> 671 </span> 672 <span> 673 <span style="display: none; "> 674 array of <span><span></span></span> 675 </span> 676 <span>string</span> 677 <span style="display: none; "></span> 678 </span> 679 </span> 680 ) 681 </div> 682 683 </em> 684 </dt> 685 <dd class="todo" style="display: none; "> 686 Undocumented. 687 </dd> 688 <dd>The URL of the current request.</dd> 689 <dd style="display: none; "> 690 This parameter was added in version 691 <b><span></span></b>. 692 You must omit this parameter in earlier versions, 693 and you may omit it in any version. If you require this 694 parameter, the manifest key 695 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 696 can ensure that your extension won't be run in an earlier browser version. 697 </dd> 698 699 <!-- OBJECT PROPERTIES --> 700 <dd style="display: none; "> 701 <dl> 702 <div> 703 <div> 704 </div> 705 </div> 706 </dl> 707 </dd> 708 709 <!-- OBJECT METHODS --> 710 <dd style="display: none; "> 711 <div></div> 712 </dd> 713 714 <!-- OBJECT EVENT FIELDS --> 715 <dd style="display: none; "> 716 <div></div> 717 </dd> 718 719 <!-- FUNCTION PARAMETERS --> 720 <dd style="display: none; "> 721 <div></div> 722 </dd> 723 724 </div> 725 </div><div> 726 <div> 727 <dt> 728 <var>statusCode</var> 729 <em> 730 731 <!-- TYPE --> 732 <div style="display:inline"> 733 ( 734 <span class="optional" style="display: none; ">optional</span> 735 <span class="enum" style="display: none; ">enumerated</span> 736 <span id="typeTemplate"> 737 <span style="display: none; "> 738 <a> Type</a> 739 </span> 740 <span> 741 <span style="display: none; "> 742 array of <span><span></span></span> 743 </span> 744 <span>integer</span> 745 <span style="display: none; "></span> 746 </span> 747 </span> 748 ) 749 </div> 750 751 </em> 752 </dt> 753 <dd class="todo" style="display: none; "> 754 Undocumented. 755 </dd> 756 <dd>Standard HTTP status code returned by the server.</dd> 757 <dd style="display: none; "> 758 This parameter was added in version 759 <b><span></span></b>. 760 You must omit this parameter in earlier versions, 761 and you may omit it in any version. If you require this 762 parameter, the manifest key 763 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 764 can ensure that your extension won't be run in an earlier browser version. 765 </dd> 766 767 <!-- OBJECT PROPERTIES --> 768 <dd style="display: none; "> 769 <dl> 770 <div> 771 <div> 772 </div> 773 </div> 774 </dl> 775 </dd> 776 777 <!-- OBJECT METHODS --> 778 <dd style="display: none; "> 779 <div></div> 780 </dd> 781 782 <!-- OBJECT EVENT FIELDS --> 783 <dd style="display: none; "> 784 <div></div> 785 </dd> 786 787 <!-- FUNCTION PARAMETERS --> 788 <dd style="display: none; "> 789 <div></div> 790 </dd> 791 792 </div> 793 </div><div> 794 <div> 795 <dt> 796 <var>redirectUrl</var> 797 <em> 798 799 <!-- TYPE --> 800 <div style="display:inline"> 801 ( 802 <span class="optional" style="display: none; ">optional</span> 803 <span class="enum" style="display: none; ">enumerated</span> 804 <span id="typeTemplate"> 805 <span style="display: none; "> 806 <a> Type</a> 807 </span> 808 <span> 809 <span style="display: none; "> 810 array of <span><span></span></span> 811 </span> 812 <span>string</span> 813 <span style="display: none; "></span> 814 </span> 815 </span> 816 ) 817 </div> 818 819 </em> 820 </dt> 821 <dd class="todo" style="display: none; "> 822 Undocumented. 823 </dd> 824 <dd>The new URL.</dd> 825 <dd style="display: none; "> 826 This parameter was added in version 827 <b><span></span></b>. 828 You must omit this parameter in earlier versions, 829 and you may omit it in any version. If you require this 830 parameter, the manifest key 831 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 832 can ensure that your extension won't be run in an earlier browser version. 833 </dd> 834 835 <!-- OBJECT PROPERTIES --> 836 <dd style="display: none; "> 837 <dl> 838 <div> 839 <div> 840 </div> 841 </div> 842 </dl> 843 </dd> 844 845 <!-- OBJECT METHODS --> 846 <dd style="display: none; "> 847 <div></div> 848 </dd> 849 850 <!-- OBJECT EVENT FIELDS --> 851 <dd style="display: none; "> 852 <div></div> 853 </dd> 854 855 <!-- FUNCTION PARAMETERS --> 856 <dd style="display: none; "> 857 <div></div> 858 </dd> 859 860 </div> 861 </div><div> 862 <div> 863 <dt> 864 <var>timeStamp</var> 865 <em> 866 867 <!-- TYPE --> 868 <div style="display:inline"> 869 ( 870 <span class="optional" style="display: none; ">optional</span> 871 <span class="enum" style="display: none; ">enumerated</span> 872 <span id="typeTemplate"> 873 <span style="display: none; "> 874 <a> Type</a> 875 </span> 876 <span> 877 <span style="display: none; "> 878 array of <span><span></span></span> 879 </span> 880 <span>number</span> 881 <span style="display: none; "></span> 882 </span> 883 </span> 884 ) 885 </div> 886 887 </em> 888 </dt> 889 <dd class="todo" style="display: none; "> 890 Undocumented. 891 </dd> 892 <dd>The time when the browser was about to make the redirect, in milliseconds since the epoch.</dd> 893 <dd style="display: none; "> 894 This parameter was added in version 895 <b><span></span></b>. 896 You must omit this parameter in earlier versions, 897 and you may omit it in any version. If you require this 898 parameter, the manifest key 899 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 900 can ensure that your extension won't be run in an earlier browser version. 901 </dd> 902 903 <!-- OBJECT PROPERTIES --> 904 <dd style="display: none; "> 905 <dl> 906 <div> 907 <div> 908 </div> 909 </div> 910 </dl> 911 </dd> 912 913 <!-- OBJECT METHODS --> 914 <dd style="display: none; "> 915 <div></div> 916 </dd> 917 918 <!-- OBJECT EVENT FIELDS --> 919 <dd style="display: none; "> 920 <div></div> 921 </dd> 922 923 <!-- FUNCTION PARAMETERS --> 924 <dd style="display: none; "> 925 <div></div> 926 </dd> 927 928 </div> 929 </div> 930 </dl> 931 </dd> 932 933 <!-- OBJECT METHODS --> 934 <dd style="display: none; "> 935 <div></div> 936 </dd> 937 938 <!-- OBJECT EVENT FIELDS --> 939 <dd style="display: none; "> 940 <div></div> 941 </dd> 942 943 <!-- FUNCTION PARAMETERS --> 944 <dd style="display: none; "> 945 <div></div> 946 </dd> 947 948 </div> 949 </div> 950 </dl> 951 </div> 952 </div> <!-- /decription --> 953 954 </div><div class="apiItem"> 955 <a name="event-onBeforeRequest"></a> 956 <h4>onBeforeRequest</h4> 957 958 <div class="summary"> 959 <!-- Note: intentionally longer 80 columns --> 960 <span class="subdued">chrome.experimental.webRequest.</span><span>onBeforeRequest</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 961 </div> 962 963 <div class="description"> 964 <p class="todo" style="display: none; ">Undocumented.</p> 965 <p>Fires when a request is about to occur.</p> 966 967 <!-- PARAMETERS --> 968 <div> 969 <h4>Parameters</h4> 970 <dl> 971 <div> 972 <div> 973 <dt> 974 <var>details</var> 975 <em> 976 977 <!-- TYPE --> 978 <div style="display:inline"> 979 ( 980 <span class="optional" style="display: none; ">optional</span> 981 <span class="enum" style="display: none; ">enumerated</span> 982 <span id="typeTemplate"> 983 <span style="display: none; "> 984 <a> Type</a> 985 </span> 986 <span> 987 <span style="display: none; "> 988 array of <span><span></span></span> 989 </span> 990 <span>object</span> 991 <span style="display: none; "></span> 992 </span> 993 </span> 994 ) 995 </div> 996 997 </em> 998 </dt> 999 <dd class="todo"> 1000 Undocumented. 1001 </dd> 1002 <dd style="display: none; "> 1003 Description of this parameter from the json schema. 1004 </dd> 1005 <dd style="display: none; "> 1006 This parameter was added in version 1007 <b><span></span></b>. 1008 You must omit this parameter in earlier versions, 1009 and you may omit it in any version. If you require this 1010 parameter, the manifest key 1011 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1012 can ensure that your extension won't be run in an earlier browser version. 1013 </dd> 1014 1015 <!-- OBJECT PROPERTIES --> 1016 <dd> 1017 <dl> 1018 <div> 1019 <div> 1020 <dt> 1021 <var>requestId</var> 1022 <em> 1023 1024 <!-- TYPE --> 1025 <div style="display:inline"> 1026 ( 1027 <span class="optional" style="display: none; ">optional</span> 1028 <span class="enum" style="display: none; ">enumerated</span> 1029 <span id="typeTemplate"> 1030 <span style="display: none; "> 1031 <a> Type</a> 1032 </span> 1033 <span> 1034 <span style="display: none; "> 1035 array of <span><span></span></span> 1036 </span> 1037 <span>string</span> 1038 <span style="display: none; "></span> 1039 </span> 1040 </span> 1041 ) 1042 </div> 1043 1044 </em> 1045 </dt> 1046 <dd class="todo" style="display: none; "> 1047 Undocumented. 1048 </dd> 1049 <dd>The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.</dd> 1050 <dd style="display: none; "> 1051 This parameter was added in version 1052 <b><span></span></b>. 1053 You must omit this parameter in earlier versions, 1054 and you may omit it in any version. If you require this 1055 parameter, the manifest key 1056 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1057 can ensure that your extension won't be run in an earlier browser version. 1058 </dd> 1059 1060 <!-- OBJECT PROPERTIES --> 1061 <dd style="display: none; "> 1062 <dl> 1063 <div> 1064 <div> 1065 </div> 1066 </div> 1067 </dl> 1068 </dd> 1069 1070 <!-- OBJECT METHODS --> 1071 <dd style="display: none; "> 1072 <div></div> 1073 </dd> 1074 1075 <!-- OBJECT EVENT FIELDS --> 1076 <dd style="display: none; "> 1077 <div></div> 1078 </dd> 1079 1080 <!-- FUNCTION PARAMETERS --> 1081 <dd style="display: none; "> 1082 <div></div> 1083 </dd> 1084 1085 </div> 1086 </div><div> 1087 <div> 1088 <dt> 1089 <var>url</var> 1090 <em> 1091 1092 <!-- TYPE --> 1093 <div style="display:inline"> 1094 ( 1095 <span class="optional" style="display: none; ">optional</span> 1096 <span class="enum" style="display: none; ">enumerated</span> 1097 <span id="typeTemplate"> 1098 <span style="display: none; "> 1099 <a> Type</a> 1100 </span> 1101 <span> 1102 <span style="display: none; "> 1103 array of <span><span></span></span> 1104 </span> 1105 <span>string</span> 1106 <span style="display: none; "></span> 1107 </span> 1108 </span> 1109 ) 1110 </div> 1111 1112 </em> 1113 </dt> 1114 <dd class="todo"> 1115 Undocumented. 1116 </dd> 1117 <dd style="display: none; "> 1118 Description of this parameter from the json schema. 1119 </dd> 1120 <dd style="display: none; "> 1121 This parameter was added in version 1122 <b><span></span></b>. 1123 You must omit this parameter in earlier versions, 1124 and you may omit it in any version. If you require this 1125 parameter, the manifest key 1126 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1127 can ensure that your extension won't be run in an earlier browser version. 1128 </dd> 1129 1130 <!-- OBJECT PROPERTIES --> 1131 <dd style="display: none; "> 1132 <dl> 1133 <div> 1134 <div> 1135 </div> 1136 </div> 1137 </dl> 1138 </dd> 1139 1140 <!-- OBJECT METHODS --> 1141 <dd style="display: none; "> 1142 <div></div> 1143 </dd> 1144 1145 <!-- OBJECT EVENT FIELDS --> 1146 <dd style="display: none; "> 1147 <div></div> 1148 </dd> 1149 1150 <!-- FUNCTION PARAMETERS --> 1151 <dd style="display: none; "> 1152 <div></div> 1153 </dd> 1154 1155 </div> 1156 </div><div> 1157 <div> 1158 <dt> 1159 <var>method</var> 1160 <em> 1161 1162 <!-- TYPE --> 1163 <div style="display:inline"> 1164 ( 1165 <span class="optional" style="display: none; ">optional</span> 1166 <span class="enum" style="display: none; ">enumerated</span> 1167 <span id="typeTemplate"> 1168 <span style="display: none; "> 1169 <a> Type</a> 1170 </span> 1171 <span> 1172 <span style="display: none; "> 1173 array of <span><span></span></span> 1174 </span> 1175 <span>string</span> 1176 <span style="display: none; "></span> 1177 </span> 1178 </span> 1179 ) 1180 </div> 1181 1182 </em> 1183 </dt> 1184 <dd class="todo" style="display: none; "> 1185 Undocumented. 1186 </dd> 1187 <dd>Standard HTTP method.</dd> 1188 <dd style="display: none; "> 1189 This parameter was added in version 1190 <b><span></span></b>. 1191 You must omit this parameter in earlier versions, 1192 and you may omit it in any version. If you require this 1193 parameter, the manifest key 1194 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1195 can ensure that your extension won't be run in an earlier browser version. 1196 </dd> 1197 1198 <!-- OBJECT PROPERTIES --> 1199 <dd style="display: none; "> 1200 <dl> 1201 <div> 1202 <div> 1203 </div> 1204 </div> 1205 </dl> 1206 </dd> 1207 1208 <!-- OBJECT METHODS --> 1209 <dd style="display: none; "> 1210 <div></div> 1211 </dd> 1212 1213 <!-- OBJECT EVENT FIELDS --> 1214 <dd style="display: none; "> 1215 <div></div> 1216 </dd> 1217 1218 <!-- FUNCTION PARAMETERS --> 1219 <dd style="display: none; "> 1220 <div></div> 1221 </dd> 1222 1223 </div> 1224 </div><div> 1225 <div> 1226 <dt> 1227 <var>tabId</var> 1228 <em> 1229 1230 <!-- TYPE --> 1231 <div style="display:inline"> 1232 ( 1233 <span class="optional" style="display: none; ">optional</span> 1234 <span class="enum" style="display: none; ">enumerated</span> 1235 <span id="typeTemplate"> 1236 <span style="display: none; "> 1237 <a> Type</a> 1238 </span> 1239 <span> 1240 <span style="display: none; "> 1241 array of <span><span></span></span> 1242 </span> 1243 <span>integer</span> 1244 <span style="display: none; "></span> 1245 </span> 1246 </span> 1247 ) 1248 </div> 1249 1250 </em> 1251 </dt> 1252 <dd class="todo" style="display: none; "> 1253 Undocumented. 1254 </dd> 1255 <dd>The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab.</dd> 1256 <dd style="display: none; "> 1257 This parameter was added in version 1258 <b><span></span></b>. 1259 You must omit this parameter in earlier versions, 1260 and you may omit it in any version. If you require this 1261 parameter, the manifest key 1262 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1263 can ensure that your extension won't be run in an earlier browser version. 1264 </dd> 1265 1266 <!-- OBJECT PROPERTIES --> 1267 <dd style="display: none; "> 1268 <dl> 1269 <div> 1270 <div> 1271 </div> 1272 </div> 1273 </dl> 1274 </dd> 1275 1276 <!-- OBJECT METHODS --> 1277 <dd style="display: none; "> 1278 <div></div> 1279 </dd> 1280 1281 <!-- OBJECT EVENT FIELDS --> 1282 <dd style="display: none; "> 1283 <div></div> 1284 </dd> 1285 1286 <!-- FUNCTION PARAMETERS --> 1287 <dd style="display: none; "> 1288 <div></div> 1289 </dd> 1290 1291 </div> 1292 </div><div> 1293 <div> 1294 <dt> 1295 <var>type</var> 1296 <em> 1297 1298 <!-- TYPE --> 1299 <div style="display:inline"> 1300 ( 1301 <span class="optional" style="display: none; ">optional</span> 1302 <span class="enum">enumerated</span> 1303 <span id="typeTemplate"> 1304 <span style="display: none; "> 1305 <a> Type</a> 1306 </span> 1307 <span> 1308 <span style="display: none; "> 1309 array of <span><span></span></span> 1310 </span> 1311 <span>string</span> 1312 <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"]</span> 1313 </span> 1314 </span> 1315 ) 1316 </div> 1317 1318 </em> 1319 </dt> 1320 <dd class="todo" style="display: none; "> 1321 Undocumented. 1322 </dd> 1323 <dd>How the requested resource will be used.</dd> 1324 <dd style="display: none; "> 1325 This parameter was added in version 1326 <b><span></span></b>. 1327 You must omit this parameter in earlier versions, 1328 and you may omit it in any version. If you require this 1329 parameter, the manifest key 1330 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1331 can ensure that your extension won't be run in an earlier browser version. 1332 </dd> 1333 1334 <!-- OBJECT PROPERTIES --> 1335 <dd style="display: none; "> 1336 <dl> 1337 <div> 1338 <div> 1339 </div> 1340 </div> 1341 </dl> 1342 </dd> 1343 1344 <!-- OBJECT METHODS --> 1345 <dd style="display: none; "> 1346 <div></div> 1347 </dd> 1348 1349 <!-- OBJECT EVENT FIELDS --> 1350 <dd style="display: none; "> 1351 <div></div> 1352 </dd> 1353 1354 <!-- FUNCTION PARAMETERS --> 1355 <dd style="display: none; "> 1356 <div></div> 1357 </dd> 1358 1359 </div> 1360 </div><div> 1361 <div> 1362 <dt> 1363 <var>timeStamp</var> 1364 <em> 1365 1366 <!-- TYPE --> 1367 <div style="display:inline"> 1368 ( 1369 <span class="optional" style="display: none; ">optional</span> 1370 <span class="enum" style="display: none; ">enumerated</span> 1371 <span id="typeTemplate"> 1372 <span style="display: none; "> 1373 <a> Type</a> 1374 </span> 1375 <span> 1376 <span style="display: none; "> 1377 array of <span><span></span></span> 1378 </span> 1379 <span>number</span> 1380 <span style="display: none; "></span> 1381 </span> 1382 </span> 1383 ) 1384 </div> 1385 1386 </em> 1387 </dt> 1388 <dd class="todo" style="display: none; "> 1389 Undocumented. 1390 </dd> 1391 <dd>The time when the browser was about to make the request, in milliseconds since the epoch.</dd> 1392 <dd style="display: none; "> 1393 This parameter was added in version 1394 <b><span></span></b>. 1395 You must omit this parameter in earlier versions, 1396 and you may omit it in any version. If you require this 1397 parameter, the manifest key 1398 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1399 can ensure that your extension won't be run in an earlier browser version. 1400 </dd> 1401 1402 <!-- OBJECT PROPERTIES --> 1403 <dd style="display: none; "> 1404 <dl> 1405 <div> 1406 <div> 1407 </div> 1408 </div> 1409 </dl> 1410 </dd> 1411 1412 <!-- OBJECT METHODS --> 1413 <dd style="display: none; "> 1414 <div></div> 1415 </dd> 1416 1417 <!-- OBJECT EVENT FIELDS --> 1418 <dd style="display: none; "> 1419 <div></div> 1420 </dd> 1421 1422 <!-- FUNCTION PARAMETERS --> 1423 <dd style="display: none; "> 1424 <div></div> 1425 </dd> 1426 1427 </div> 1428 </div> 1429 </dl> 1430 </dd> 1431 1432 <!-- OBJECT METHODS --> 1433 <dd style="display: none; "> 1434 <div></div> 1435 </dd> 1436 1437 <!-- OBJECT EVENT FIELDS --> 1438 <dd style="display: none; "> 1439 <div></div> 1440 </dd> 1441 1442 <!-- FUNCTION PARAMETERS --> 1443 <dd style="display: none; "> 1444 <div></div> 1445 </dd> 1446 1447 </div> 1448 </div> 1449 </dl> 1450 </div> 1451 </div> <!-- /decription --> 1452 1453 </div><div class="apiItem"> 1454 <a name="event-onBeforeSendHeaders"></a> 1455 <h4>onBeforeSendHeaders</h4> 1456 1457 <div class="summary"> 1458 <!-- Note: intentionally longer 80 columns --> 1459 <span class="subdued">chrome.experimental.webRequest.</span><span>onBeforeSendHeaders</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 1460 </div> 1461 1462 <div class="description"> 1463 <p class="todo" style="display: none; ">Undocumented.</p> 1464 <p>Fires before sending an HTTP request, once the request headers are available.</p> 1465 1466 <!-- PARAMETERS --> 1467 <div> 1468 <h4>Parameters</h4> 1469 <dl> 1470 <div> 1471 <div> 1472 <dt> 1473 <var>details</var> 1474 <em> 1475 1476 <!-- TYPE --> 1477 <div style="display:inline"> 1478 ( 1479 <span class="optional" style="display: none; ">optional</span> 1480 <span class="enum" style="display: none; ">enumerated</span> 1481 <span id="typeTemplate"> 1482 <span style="display: none; "> 1483 <a> Type</a> 1484 </span> 1485 <span> 1486 <span style="display: none; "> 1487 array of <span><span></span></span> 1488 </span> 1489 <span>object</span> 1490 <span style="display: none; "></span> 1491 </span> 1492 </span> 1493 ) 1494 </div> 1495 1496 </em> 1497 </dt> 1498 <dd class="todo"> 1499 Undocumented. 1500 </dd> 1501 <dd style="display: none; "> 1502 Description of this parameter from the json schema. 1503 </dd> 1504 <dd style="display: none; "> 1505 This parameter was added in version 1506 <b><span></span></b>. 1507 You must omit this parameter in earlier versions, 1508 and you may omit it in any version. If you require this 1509 parameter, the manifest key 1510 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1511 can ensure that your extension won't be run in an earlier browser version. 1512 </dd> 1513 1514 <!-- OBJECT PROPERTIES --> 1515 <dd> 1516 <dl> 1517 <div> 1518 <div> 1519 <dt> 1520 <var>requestId</var> 1521 <em> 1522 1523 <!-- TYPE --> 1524 <div style="display:inline"> 1525 ( 1526 <span class="optional" style="display: none; ">optional</span> 1527 <span class="enum" style="display: none; ">enumerated</span> 1528 <span id="typeTemplate"> 1529 <span style="display: none; "> 1530 <a> Type</a> 1531 </span> 1532 <span> 1533 <span style="display: none; "> 1534 array of <span><span></span></span> 1535 </span> 1536 <span>string</span> 1537 <span style="display: none; "></span> 1538 </span> 1539 </span> 1540 ) 1541 </div> 1542 1543 </em> 1544 </dt> 1545 <dd class="todo" style="display: none; "> 1546 Undocumented. 1547 </dd> 1548 <dd>The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.</dd> 1549 <dd style="display: none; "> 1550 This parameter was added in version 1551 <b><span></span></b>. 1552 You must omit this parameter in earlier versions, 1553 and you may omit it in any version. If you require this 1554 parameter, the manifest key 1555 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1556 can ensure that your extension won't be run in an earlier browser version. 1557 </dd> 1558 1559 <!-- OBJECT PROPERTIES --> 1560 <dd style="display: none; "> 1561 <dl> 1562 <div> 1563 <div> 1564 </div> 1565 </div> 1566 </dl> 1567 </dd> 1568 1569 <!-- OBJECT METHODS --> 1570 <dd style="display: none; "> 1571 <div></div> 1572 </dd> 1573 1574 <!-- OBJECT EVENT FIELDS --> 1575 <dd style="display: none; "> 1576 <div></div> 1577 </dd> 1578 1579 <!-- FUNCTION PARAMETERS --> 1580 <dd style="display: none; "> 1581 <div></div> 1582 </dd> 1583 1584 </div> 1585 </div><div> 1586 <div> 1587 <dt> 1588 <var>url</var> 1589 <em> 1590 1591 <!-- TYPE --> 1592 <div style="display:inline"> 1593 ( 1594 <span class="optional" style="display: none; ">optional</span> 1595 <span class="enum" style="display: none; ">enumerated</span> 1596 <span id="typeTemplate"> 1597 <span style="display: none; "> 1598 <a> Type</a> 1599 </span> 1600 <span> 1601 <span style="display: none; "> 1602 array of <span><span></span></span> 1603 </span> 1604 <span>string</span> 1605 <span style="display: none; "></span> 1606 </span> 1607 </span> 1608 ) 1609 </div> 1610 1611 </em> 1612 </dt> 1613 <dd class="todo"> 1614 Undocumented. 1615 </dd> 1616 <dd style="display: none; "> 1617 Description of this parameter from the json schema. 1618 </dd> 1619 <dd style="display: none; "> 1620 This parameter was added in version 1621 <b><span></span></b>. 1622 You must omit this parameter in earlier versions, 1623 and you may omit it in any version. If you require this 1624 parameter, the manifest key 1625 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1626 can ensure that your extension won't be run in an earlier browser version. 1627 </dd> 1628 1629 <!-- OBJECT PROPERTIES --> 1630 <dd style="display: none; "> 1631 <dl> 1632 <div> 1633 <div> 1634 </div> 1635 </div> 1636 </dl> 1637 </dd> 1638 1639 <!-- OBJECT METHODS --> 1640 <dd style="display: none; "> 1641 <div></div> 1642 </dd> 1643 1644 <!-- OBJECT EVENT FIELDS --> 1645 <dd style="display: none; "> 1646 <div></div> 1647 </dd> 1648 1649 <!-- FUNCTION PARAMETERS --> 1650 <dd style="display: none; "> 1651 <div></div> 1652 </dd> 1653 1654 </div> 1655 </div><div> 1656 <div> 1657 <dt> 1658 <var>timeStamp</var> 1659 <em> 1660 1661 <!-- TYPE --> 1662 <div style="display:inline"> 1663 ( 1664 <span class="optional" style="display: none; ">optional</span> 1665 <span class="enum" style="display: none; ">enumerated</span> 1666 <span id="typeTemplate"> 1667 <span style="display: none; "> 1668 <a> Type</a> 1669 </span> 1670 <span> 1671 <span style="display: none; "> 1672 array of <span><span></span></span> 1673 </span> 1674 <span>number</span> 1675 <span style="display: none; "></span> 1676 </span> 1677 </span> 1678 ) 1679 </div> 1680 1681 </em> 1682 </dt> 1683 <dd class="todo" style="display: none; "> 1684 Undocumented. 1685 </dd> 1686 <dd>The time when the browser was about to send headers, in milliseconds since the epoch.</dd> 1687 <dd style="display: none; "> 1688 This parameter was added in version 1689 <b><span></span></b>. 1690 You must omit this parameter in earlier versions, 1691 and you may omit it in any version. If you require this 1692 parameter, the manifest key 1693 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1694 can ensure that your extension won't be run in an earlier browser version. 1695 </dd> 1696 1697 <!-- OBJECT PROPERTIES --> 1698 <dd style="display: none; "> 1699 <dl> 1700 <div> 1701 <div> 1702 </div> 1703 </div> 1704 </dl> 1705 </dd> 1706 1707 <!-- OBJECT METHODS --> 1708 <dd style="display: none; "> 1709 <div></div> 1710 </dd> 1711 1712 <!-- OBJECT EVENT FIELDS --> 1713 <dd style="display: none; "> 1714 <div></div> 1715 </dd> 1716 1717 <!-- FUNCTION PARAMETERS --> 1718 <dd style="display: none; "> 1719 <div></div> 1720 </dd> 1721 1722 </div> 1723 </div> 1724 </dl> 1725 </dd> 1726 1727 <!-- OBJECT METHODS --> 1728 <dd style="display: none; "> 1729 <div></div> 1730 </dd> 1731 1732 <!-- OBJECT EVENT FIELDS --> 1733 <dd style="display: none; "> 1734 <div></div> 1735 </dd> 1736 1737 <!-- FUNCTION PARAMETERS --> 1738 <dd style="display: none; "> 1739 <div></div> 1740 </dd> 1741 1742 </div> 1743 </div> 1744 </dl> 1745 </div> 1746 </div> <!-- /decription --> 1747 1748 </div><div class="apiItem"> 1749 <a name="event-onCompleted"></a> 1750 <h4>onCompleted</h4> 1751 1752 <div class="summary"> 1753 <!-- Note: intentionally longer 80 columns --> 1754 <span class="subdued">chrome.experimental.webRequest.</span><span>onCompleted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 1755 </div> 1756 1757 <div class="description"> 1758 <p class="todo" style="display: none; ">Undocumented.</p> 1759 <p>Fires when a request is completed.</p> 1760 1761 <!-- PARAMETERS --> 1762 <div> 1763 <h4>Parameters</h4> 1764 <dl> 1765 <div> 1766 <div> 1767 <dt> 1768 <var>details</var> 1769 <em> 1770 1771 <!-- TYPE --> 1772 <div style="display:inline"> 1773 ( 1774 <span class="optional" style="display: none; ">optional</span> 1775 <span class="enum" style="display: none; ">enumerated</span> 1776 <span id="typeTemplate"> 1777 <span style="display: none; "> 1778 <a> Type</a> 1779 </span> 1780 <span> 1781 <span style="display: none; "> 1782 array of <span><span></span></span> 1783 </span> 1784 <span>object</span> 1785 <span style="display: none; "></span> 1786 </span> 1787 </span> 1788 ) 1789 </div> 1790 1791 </em> 1792 </dt> 1793 <dd class="todo"> 1794 Undocumented. 1795 </dd> 1796 <dd style="display: none; "> 1797 Description of this parameter from the json schema. 1798 </dd> 1799 <dd style="display: none; "> 1800 This parameter was added in version 1801 <b><span></span></b>. 1802 You must omit this parameter in earlier versions, 1803 and you may omit it in any version. If you require this 1804 parameter, the manifest key 1805 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1806 can ensure that your extension won't be run in an earlier browser version. 1807 </dd> 1808 1809 <!-- OBJECT PROPERTIES --> 1810 <dd> 1811 <dl> 1812 <div> 1813 <div> 1814 <dt> 1815 <var>requestId</var> 1816 <em> 1817 1818 <!-- TYPE --> 1819 <div style="display:inline"> 1820 ( 1821 <span class="optional" style="display: none; ">optional</span> 1822 <span class="enum" style="display: none; ">enumerated</span> 1823 <span id="typeTemplate"> 1824 <span style="display: none; "> 1825 <a> Type</a> 1826 </span> 1827 <span> 1828 <span style="display: none; "> 1829 array of <span><span></span></span> 1830 </span> 1831 <span>string</span> 1832 <span style="display: none; "></span> 1833 </span> 1834 </span> 1835 ) 1836 </div> 1837 1838 </em> 1839 </dt> 1840 <dd class="todo" style="display: none; "> 1841 Undocumented. 1842 </dd> 1843 <dd>The ID of the request.</dd> 1844 <dd style="display: none; "> 1845 This parameter was added in version 1846 <b><span></span></b>. 1847 You must omit this parameter in earlier versions, 1848 and you may omit it in any version. If you require this 1849 parameter, the manifest key 1850 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1851 can ensure that your extension won't be run in an earlier browser version. 1852 </dd> 1853 1854 <!-- OBJECT PROPERTIES --> 1855 <dd style="display: none; "> 1856 <dl> 1857 <div> 1858 <div> 1859 </div> 1860 </div> 1861 </dl> 1862 </dd> 1863 1864 <!-- OBJECT METHODS --> 1865 <dd style="display: none; "> 1866 <div></div> 1867 </dd> 1868 1869 <!-- OBJECT EVENT FIELDS --> 1870 <dd style="display: none; "> 1871 <div></div> 1872 </dd> 1873 1874 <!-- FUNCTION PARAMETERS --> 1875 <dd style="display: none; "> 1876 <div></div> 1877 </dd> 1878 1879 </div> 1880 </div><div> 1881 <div> 1882 <dt> 1883 <var>url</var> 1884 <em> 1885 1886 <!-- TYPE --> 1887 <div style="display:inline"> 1888 ( 1889 <span class="optional" style="display: none; ">optional</span> 1890 <span class="enum" style="display: none; ">enumerated</span> 1891 <span id="typeTemplate"> 1892 <span style="display: none; "> 1893 <a> Type</a> 1894 </span> 1895 <span> 1896 <span style="display: none; "> 1897 array of <span><span></span></span> 1898 </span> 1899 <span>string</span> 1900 <span style="display: none; "></span> 1901 </span> 1902 </span> 1903 ) 1904 </div> 1905 1906 </em> 1907 </dt> 1908 <dd class="todo" style="display: none; "> 1909 Undocumented. 1910 </dd> 1911 <dd>The URL of the current request.</dd> 1912 <dd style="display: none; "> 1913 This parameter was added in version 1914 <b><span></span></b>. 1915 You must omit this parameter in earlier versions, 1916 and you may omit it in any version. If you require this 1917 parameter, the manifest key 1918 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1919 can ensure that your extension won't be run in an earlier browser version. 1920 </dd> 1921 1922 <!-- OBJECT PROPERTIES --> 1923 <dd style="display: none; "> 1924 <dl> 1925 <div> 1926 <div> 1927 </div> 1928 </div> 1929 </dl> 1930 </dd> 1931 1932 <!-- OBJECT METHODS --> 1933 <dd style="display: none; "> 1934 <div></div> 1935 </dd> 1936 1937 <!-- OBJECT EVENT FIELDS --> 1938 <dd style="display: none; "> 1939 <div></div> 1940 </dd> 1941 1942 <!-- FUNCTION PARAMETERS --> 1943 <dd style="display: none; "> 1944 <div></div> 1945 </dd> 1946 1947 </div> 1948 </div><div> 1949 <div> 1950 <dt> 1951 <var>statusCode</var> 1952 <em> 1953 1954 <!-- TYPE --> 1955 <div style="display:inline"> 1956 ( 1957 <span class="optional" style="display: none; ">optional</span> 1958 <span class="enum" style="display: none; ">enumerated</span> 1959 <span id="typeTemplate"> 1960 <span style="display: none; "> 1961 <a> Type</a> 1962 </span> 1963 <span> 1964 <span style="display: none; "> 1965 array of <span><span></span></span> 1966 </span> 1967 <span>integer</span> 1968 <span style="display: none; "></span> 1969 </span> 1970 </span> 1971 ) 1972 </div> 1973 1974 </em> 1975 </dt> 1976 <dd class="todo" style="display: none; "> 1977 Undocumented. 1978 </dd> 1979 <dd>Standard HTTP status code returned by the server.</dd> 1980 <dd style="display: none; "> 1981 This parameter was added in version 1982 <b><span></span></b>. 1983 You must omit this parameter in earlier versions, 1984 and you may omit it in any version. If you require this 1985 parameter, the manifest key 1986 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1987 can ensure that your extension won't be run in an earlier browser version. 1988 </dd> 1989 1990 <!-- OBJECT PROPERTIES --> 1991 <dd style="display: none; "> 1992 <dl> 1993 <div> 1994 <div> 1995 </div> 1996 </div> 1997 </dl> 1998 </dd> 1999 2000 <!-- OBJECT METHODS --> 2001 <dd style="display: none; "> 2002 <div></div> 2003 </dd> 2004 2005 <!-- OBJECT EVENT FIELDS --> 2006 <dd style="display: none; "> 2007 <div></div> 2008 </dd> 2009 2010 <!-- FUNCTION PARAMETERS --> 2011 <dd style="display: none; "> 2012 <div></div> 2013 </dd> 2014 2015 </div> 2016 </div><div> 2017 <div> 2018 <dt> 2019 <var>timeStamp</var> 2020 <em> 2021 2022 <!-- TYPE --> 2023 <div style="display:inline"> 2024 ( 2025 <span class="optional" style="display: none; ">optional</span> 2026 <span class="enum" style="display: none; ">enumerated</span> 2027 <span id="typeTemplate"> 2028 <span style="display: none; "> 2029 <a> Type</a> 2030 </span> 2031 <span> 2032 <span style="display: none; "> 2033 array of <span><span></span></span> 2034 </span> 2035 <span>number</span> 2036 <span style="display: none; "></span> 2037 </span> 2038 </span> 2039 ) 2040 </div> 2041 2042 </em> 2043 </dt> 2044 <dd class="todo" style="display: none; "> 2045 Undocumented. 2046 </dd> 2047 <dd>The time when the response was received completely, in milliseconds since the epoch.</dd> 2048 <dd style="display: none; "> 2049 This parameter was added in version 2050 <b><span></span></b>. 2051 You must omit this parameter in earlier versions, 2052 and you may omit it in any version. If you require this 2053 parameter, the manifest key 2054 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2055 can ensure that your extension won't be run in an earlier browser version. 2056 </dd> 2057 2058 <!-- OBJECT PROPERTIES --> 2059 <dd style="display: none; "> 2060 <dl> 2061 <div> 2062 <div> 2063 </div> 2064 </div> 2065 </dl> 2066 </dd> 2067 2068 <!-- OBJECT METHODS --> 2069 <dd style="display: none; "> 2070 <div></div> 2071 </dd> 2072 2073 <!-- OBJECT EVENT FIELDS --> 2074 <dd style="display: none; "> 2075 <div></div> 2076 </dd> 2077 2078 <!-- FUNCTION PARAMETERS --> 2079 <dd style="display: none; "> 2080 <div></div> 2081 </dd> 2082 2083 </div> 2084 </div> 2085 </dl> 2086 </dd> 2087 2088 <!-- OBJECT METHODS --> 2089 <dd style="display: none; "> 2090 <div></div> 2091 </dd> 2092 2093 <!-- OBJECT EVENT FIELDS --> 2094 <dd style="display: none; "> 2095 <div></div> 2096 </dd> 2097 2098 <!-- FUNCTION PARAMETERS --> 2099 <dd style="display: none; "> 2100 <div></div> 2101 </dd> 2102 2103 </div> 2104 </div> 2105 </dl> 2106 </div> 2107 </div> <!-- /decription --> 2108 2109 </div><div class="apiItem"> 2110 <a name="event-onErrorOccurred"></a> 2111 <h4>onErrorOccurred</h4> 2112 2113 <div class="summary"> 2114 <!-- Note: intentionally longer 80 columns --> 2115 <span class="subdued">chrome.experimental.webRequest.</span><span>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2116 </div> 2117 2118 <div class="description"> 2119 <p class="todo" style="display: none; ">Undocumented.</p> 2120 <p>Fires when an error occurs.</p> 2121 2122 <!-- PARAMETERS --> 2123 <div> 2124 <h4>Parameters</h4> 2125 <dl> 2126 <div> 2127 <div> 2128 <dt> 2129 <var>details</var> 2130 <em> 2131 2132 <!-- TYPE --> 2133 <div style="display:inline"> 2134 ( 2135 <span class="optional" style="display: none; ">optional</span> 2136 <span class="enum" style="display: none; ">enumerated</span> 2137 <span id="typeTemplate"> 2138 <span style="display: none; "> 2139 <a> Type</a> 2140 </span> 2141 <span> 2142 <span style="display: none; "> 2143 array of <span><span></span></span> 2144 </span> 2145 <span>object</span> 2146 <span style="display: none; "></span> 2147 </span> 2148 </span> 2149 ) 2150 </div> 2151 2152 </em> 2153 </dt> 2154 <dd class="todo"> 2155 Undocumented. 2156 </dd> 2157 <dd style="display: none; "> 2158 Description of this parameter from the json schema. 2159 </dd> 2160 <dd style="display: none; "> 2161 This parameter was added in version 2162 <b><span></span></b>. 2163 You must omit this parameter in earlier versions, 2164 and you may omit it in any version. If you require this 2165 parameter, the manifest key 2166 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2167 can ensure that your extension won't be run in an earlier browser version. 2168 </dd> 2169 2170 <!-- OBJECT PROPERTIES --> 2171 <dd> 2172 <dl> 2173 <div> 2174 <div> 2175 <dt> 2176 <var>requestId</var> 2177 <em> 2178 2179 <!-- TYPE --> 2180 <div style="display:inline"> 2181 ( 2182 <span class="optional" style="display: none; ">optional</span> 2183 <span class="enum" style="display: none; ">enumerated</span> 2184 <span id="typeTemplate"> 2185 <span style="display: none; "> 2186 <a> Type</a> 2187 </span> 2188 <span> 2189 <span style="display: none; "> 2190 array of <span><span></span></span> 2191 </span> 2192 <span>string</span> 2193 <span style="display: none; "></span> 2194 </span> 2195 </span> 2196 ) 2197 </div> 2198 2199 </em> 2200 </dt> 2201 <dd class="todo" style="display: none; "> 2202 Undocumented. 2203 </dd> 2204 <dd>The ID of the request.</dd> 2205 <dd style="display: none; "> 2206 This parameter was added in version 2207 <b><span></span></b>. 2208 You must omit this parameter in earlier versions, 2209 and you may omit it in any version. If you require this 2210 parameter, the manifest key 2211 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2212 can ensure that your extension won't be run in an earlier browser version. 2213 </dd> 2214 2215 <!-- OBJECT PROPERTIES --> 2216 <dd style="display: none; "> 2217 <dl> 2218 <div> 2219 <div> 2220 </div> 2221 </div> 2222 </dl> 2223 </dd> 2224 2225 <!-- OBJECT METHODS --> 2226 <dd style="display: none; "> 2227 <div></div> 2228 </dd> 2229 2230 <!-- OBJECT EVENT FIELDS --> 2231 <dd style="display: none; "> 2232 <div></div> 2233 </dd> 2234 2235 <!-- FUNCTION PARAMETERS --> 2236 <dd style="display: none; "> 2237 <div></div> 2238 </dd> 2239 2240 </div> 2241 </div><div> 2242 <div> 2243 <dt> 2244 <var>url</var> 2245 <em> 2246 2247 <!-- TYPE --> 2248 <div style="display:inline"> 2249 ( 2250 <span class="optional" style="display: none; ">optional</span> 2251 <span class="enum" style="display: none; ">enumerated</span> 2252 <span id="typeTemplate"> 2253 <span style="display: none; "> 2254 <a> Type</a> 2255 </span> 2256 <span> 2257 <span style="display: none; "> 2258 array of <span><span></span></span> 2259 </span> 2260 <span>string</span> 2261 <span style="display: none; "></span> 2262 </span> 2263 </span> 2264 ) 2265 </div> 2266 2267 </em> 2268 </dt> 2269 <dd class="todo" style="display: none; "> 2270 Undocumented. 2271 </dd> 2272 <dd>The URL of the current request.</dd> 2273 <dd style="display: none; "> 2274 This parameter was added in version 2275 <b><span></span></b>. 2276 You must omit this parameter in earlier versions, 2277 and you may omit it in any version. If you require this 2278 parameter, the manifest key 2279 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2280 can ensure that your extension won't be run in an earlier browser version. 2281 </dd> 2282 2283 <!-- OBJECT PROPERTIES --> 2284 <dd style="display: none; "> 2285 <dl> 2286 <div> 2287 <div> 2288 </div> 2289 </div> 2290 </dl> 2291 </dd> 2292 2293 <!-- OBJECT METHODS --> 2294 <dd style="display: none; "> 2295 <div></div> 2296 </dd> 2297 2298 <!-- OBJECT EVENT FIELDS --> 2299 <dd style="display: none; "> 2300 <div></div> 2301 </dd> 2302 2303 <!-- FUNCTION PARAMETERS --> 2304 <dd style="display: none; "> 2305 <div></div> 2306 </dd> 2307 2308 </div> 2309 </div><div> 2310 <div> 2311 <dt> 2312 <var>error</var> 2313 <em> 2314 2315 <!-- TYPE --> 2316 <div style="display:inline"> 2317 ( 2318 <span class="optional" style="display: none; ">optional</span> 2319 <span class="enum" style="display: none; ">enumerated</span> 2320 <span id="typeTemplate"> 2321 <span style="display: none; "> 2322 <a> Type</a> 2323 </span> 2324 <span> 2325 <span style="display: none; "> 2326 array of <span><span></span></span> 2327 </span> 2328 <span>string</span> 2329 <span style="display: none; "></span> 2330 </span> 2331 </span> 2332 ) 2333 </div> 2334 2335 </em> 2336 </dt> 2337 <dd class="todo" style="display: none; "> 2338 Undocumented. 2339 </dd> 2340 <dd>The error description.</dd> 2341 <dd style="display: none; "> 2342 This parameter was added in version 2343 <b><span></span></b>. 2344 You must omit this parameter in earlier versions, 2345 and you may omit it in any version. If you require this 2346 parameter, the manifest key 2347 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2348 can ensure that your extension won't be run in an earlier browser version. 2349 </dd> 2350 2351 <!-- OBJECT PROPERTIES --> 2352 <dd style="display: none; "> 2353 <dl> 2354 <div> 2355 <div> 2356 </div> 2357 </div> 2358 </dl> 2359 </dd> 2360 2361 <!-- OBJECT METHODS --> 2362 <dd style="display: none; "> 2363 <div></div> 2364 </dd> 2365 2366 <!-- OBJECT EVENT FIELDS --> 2367 <dd style="display: none; "> 2368 <div></div> 2369 </dd> 2370 2371 <!-- FUNCTION PARAMETERS --> 2372 <dd style="display: none; "> 2373 <div></div> 2374 </dd> 2375 2376 </div> 2377 </div><div> 2378 <div> 2379 <dt> 2380 <var>timeStamp</var> 2381 <em> 2382 2383 <!-- TYPE --> 2384 <div style="display:inline"> 2385 ( 2386 <span class="optional" style="display: none; ">optional</span> 2387 <span class="enum" style="display: none; ">enumerated</span> 2388 <span id="typeTemplate"> 2389 <span style="display: none; "> 2390 <a> Type</a> 2391 </span> 2392 <span> 2393 <span style="display: none; "> 2394 array of <span><span></span></span> 2395 </span> 2396 <span>number</span> 2397 <span style="display: none; "></span> 2398 </span> 2399 </span> 2400 ) 2401 </div> 2402 2403 </em> 2404 </dt> 2405 <dd class="todo" style="display: none; "> 2406 Undocumented. 2407 </dd> 2408 <dd>The time when the error occurred, in milliseconds since the epoch.</dd> 2409 <dd style="display: none; "> 2410 This parameter was added in version 2411 <b><span></span></b>. 2412 You must omit this parameter in earlier versions, 2413 and you may omit it in any version. If you require this 2414 parameter, the manifest key 2415 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2416 can ensure that your extension won't be run in an earlier browser version. 2417 </dd> 2418 2419 <!-- OBJECT PROPERTIES --> 2420 <dd style="display: none; "> 2421 <dl> 2422 <div> 2423 <div> 2424 </div> 2425 </div> 2426 </dl> 2427 </dd> 2428 2429 <!-- OBJECT METHODS --> 2430 <dd style="display: none; "> 2431 <div></div> 2432 </dd> 2433 2434 <!-- OBJECT EVENT FIELDS --> 2435 <dd style="display: none; "> 2436 <div></div> 2437 </dd> 2438 2439 <!-- FUNCTION PARAMETERS --> 2440 <dd style="display: none; "> 2441 <div></div> 2442 </dd> 2443 2444 </div> 2445 </div> 2446 </dl> 2447 </dd> 2448 2449 <!-- OBJECT METHODS --> 2450 <dd style="display: none; "> 2451 <div></div> 2452 </dd> 2453 2454 <!-- OBJECT EVENT FIELDS --> 2455 <dd style="display: none; "> 2456 <div></div> 2457 </dd> 2458 2459 <!-- FUNCTION PARAMETERS --> 2460 <dd style="display: none; "> 2461 <div></div> 2462 </dd> 2463 2464 </div> 2465 </div> 2466 </dl> 2467 </div> 2468 </div> <!-- /decription --> 2469 2470 </div><div class="apiItem"> 2471 <a name="event-onHeadersReceived"></a> 2472 <h4>onHeadersReceived</h4> 2473 2474 <div class="summary"> 2475 <!-- Note: intentionally longer 80 columns --> 2476 <span class="subdued">chrome.experimental.webRequest.</span><span>onHeadersReceived</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2477 </div> 2478 2479 <div class="description"> 2480 <p class="todo" style="display: none; ">Undocumented.</p> 2481 <p>Fires when the status line and response headers are received after a request is sent to the server.</p> 2482 2483 <!-- PARAMETERS --> 2484 <div> 2485 <h4>Parameters</h4> 2486 <dl> 2487 <div> 2488 <div> 2489 <dt> 2490 <var>details</var> 2491 <em> 2492 2493 <!-- TYPE --> 2494 <div style="display:inline"> 2495 ( 2496 <span class="optional" style="display: none; ">optional</span> 2497 <span class="enum" style="display: none; ">enumerated</span> 2498 <span id="typeTemplate"> 2499 <span style="display: none; "> 2500 <a> Type</a> 2501 </span> 2502 <span> 2503 <span style="display: none; "> 2504 array of <span><span></span></span> 2505 </span> 2506 <span>object</span> 2507 <span style="display: none; "></span> 2508 </span> 2509 </span> 2510 ) 2511 </div> 2512 2513 </em> 2514 </dt> 2515 <dd class="todo"> 2516 Undocumented. 2517 </dd> 2518 <dd style="display: none; "> 2519 Description of this parameter from the json schema. 2520 </dd> 2521 <dd style="display: none; "> 2522 This parameter was added in version 2523 <b><span></span></b>. 2524 You must omit this parameter in earlier versions, 2525 and you may omit it in any version. If you require this 2526 parameter, the manifest key 2527 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2528 can ensure that your extension won't be run in an earlier browser version. 2529 </dd> 2530 2531 <!-- OBJECT PROPERTIES --> 2532 <dd> 2533 <dl> 2534 <div> 2535 <div> 2536 <dt> 2537 <var>requestId</var> 2538 <em> 2539 2540 <!-- TYPE --> 2541 <div style="display:inline"> 2542 ( 2543 <span class="optional" style="display: none; ">optional</span> 2544 <span class="enum" style="display: none; ">enumerated</span> 2545 <span id="typeTemplate"> 2546 <span style="display: none; "> 2547 <a> Type</a> 2548 </span> 2549 <span> 2550 <span style="display: none; "> 2551 array of <span><span></span></span> 2552 </span> 2553 <span>string</span> 2554 <span style="display: none; "></span> 2555 </span> 2556 </span> 2557 ) 2558 </div> 2559 2560 </em> 2561 </dt> 2562 <dd class="todo" style="display: none; "> 2563 Undocumented. 2564 </dd> 2565 <dd>The ID of the request.</dd> 2566 <dd style="display: none; "> 2567 This parameter was added in version 2568 <b><span></span></b>. 2569 You must omit this parameter in earlier versions, 2570 and you may omit it in any version. If you require this 2571 parameter, the manifest key 2572 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2573 can ensure that your extension won't be run in an earlier browser version. 2574 </dd> 2575 2576 <!-- OBJECT PROPERTIES --> 2577 <dd style="display: none; "> 2578 <dl> 2579 <div> 2580 <div> 2581 </div> 2582 </div> 2583 </dl> 2584 </dd> 2585 2586 <!-- OBJECT METHODS --> 2587 <dd style="display: none; "> 2588 <div></div> 2589 </dd> 2590 2591 <!-- OBJECT EVENT FIELDS --> 2592 <dd style="display: none; "> 2593 <div></div> 2594 </dd> 2595 2596 <!-- FUNCTION PARAMETERS --> 2597 <dd style="display: none; "> 2598 <div></div> 2599 </dd> 2600 2601 </div> 2602 </div><div> 2603 <div> 2604 <dt> 2605 <var>url</var> 2606 <em> 2607 2608 <!-- TYPE --> 2609 <div style="display:inline"> 2610 ( 2611 <span class="optional" style="display: none; ">optional</span> 2612 <span class="enum" style="display: none; ">enumerated</span> 2613 <span id="typeTemplate"> 2614 <span style="display: none; "> 2615 <a> Type</a> 2616 </span> 2617 <span> 2618 <span style="display: none; "> 2619 array of <span><span></span></span> 2620 </span> 2621 <span>string</span> 2622 <span style="display: none; "></span> 2623 </span> 2624 </span> 2625 ) 2626 </div> 2627 2628 </em> 2629 </dt> 2630 <dd class="todo"> 2631 Undocumented. 2632 </dd> 2633 <dd style="display: none; "> 2634 Description of this parameter from the json schema. 2635 </dd> 2636 <dd style="display: none; "> 2637 This parameter was added in version 2638 <b><span></span></b>. 2639 You must omit this parameter in earlier versions, 2640 and you may omit it in any version. If you require this 2641 parameter, the manifest key 2642 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2643 can ensure that your extension won't be run in an earlier browser version. 2644 </dd> 2645 2646 <!-- OBJECT PROPERTIES --> 2647 <dd style="display: none; "> 2648 <dl> 2649 <div> 2650 <div> 2651 </div> 2652 </div> 2653 </dl> 2654 </dd> 2655 2656 <!-- OBJECT METHODS --> 2657 <dd style="display: none; "> 2658 <div></div> 2659 </dd> 2660 2661 <!-- OBJECT EVENT FIELDS --> 2662 <dd style="display: none; "> 2663 <div></div> 2664 </dd> 2665 2666 <!-- FUNCTION PARAMETERS --> 2667 <dd style="display: none; "> 2668 <div></div> 2669 </dd> 2670 2671 </div> 2672 </div><div> 2673 <div> 2674 <dt> 2675 <var>statusCode</var> 2676 <em> 2677 2678 <!-- TYPE --> 2679 <div style="display:inline"> 2680 ( 2681 <span class="optional" style="display: none; ">optional</span> 2682 <span class="enum" style="display: none; ">enumerated</span> 2683 <span id="typeTemplate"> 2684 <span style="display: none; "> 2685 <a> Type</a> 2686 </span> 2687 <span> 2688 <span style="display: none; "> 2689 array of <span><span></span></span> 2690 </span> 2691 <span>integer</span> 2692 <span style="display: none; "></span> 2693 </span> 2694 </span> 2695 ) 2696 </div> 2697 2698 </em> 2699 </dt> 2700 <dd class="todo" style="display: none; "> 2701 Undocumented. 2702 </dd> 2703 <dd>Standard HTTP status code returned by the server.</dd> 2704 <dd style="display: none; "> 2705 This parameter was added in version 2706 <b><span></span></b>. 2707 You must omit this parameter in earlier versions, 2708 and you may omit it in any version. If you require this 2709 parameter, the manifest key 2710 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2711 can ensure that your extension won't be run in an earlier browser version. 2712 </dd> 2713 2714 <!-- OBJECT PROPERTIES --> 2715 <dd style="display: none; "> 2716 <dl> 2717 <div> 2718 <div> 2719 </div> 2720 </div> 2721 </dl> 2722 </dd> 2723 2724 <!-- OBJECT METHODS --> 2725 <dd style="display: none; "> 2726 <div></div> 2727 </dd> 2728 2729 <!-- OBJECT EVENT FIELDS --> 2730 <dd style="display: none; "> 2731 <div></div> 2732 </dd> 2733 2734 <!-- FUNCTION PARAMETERS --> 2735 <dd style="display: none; "> 2736 <div></div> 2737 </dd> 2738 2739 </div> 2740 </div><div> 2741 <div> 2742 <dt> 2743 <var>timeStamp</var> 2744 <em> 2745 2746 <!-- TYPE --> 2747 <div style="display:inline"> 2748 ( 2749 <span class="optional" style="display: none; ">optional</span> 2750 <span class="enum" style="display: none; ">enumerated</span> 2751 <span id="typeTemplate"> 2752 <span style="display: none; "> 2753 <a> Type</a> 2754 </span> 2755 <span> 2756 <span style="display: none; "> 2757 array of <span><span></span></span> 2758 </span> 2759 <span>number</span> 2760 <span style="display: none; "></span> 2761 </span> 2762 </span> 2763 ) 2764 </div> 2765 2766 </em> 2767 </dt> 2768 <dd class="todo" style="display: none; "> 2769 Undocumented. 2770 </dd> 2771 <dd>The time when the status line and response headers were received, in milliseconds since the epoch.</dd> 2772 <dd style="display: none; "> 2773 This parameter was added in version 2774 <b><span></span></b>. 2775 You must omit this parameter in earlier versions, 2776 and you may omit it in any version. If you require this 2777 parameter, the manifest key 2778 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2779 can ensure that your extension won't be run in an earlier browser version. 2780 </dd> 2781 2782 <!-- OBJECT PROPERTIES --> 2783 <dd style="display: none; "> 2784 <dl> 2785 <div> 2786 <div> 2787 </div> 2788 </div> 2789 </dl> 2790 </dd> 2791 2792 <!-- OBJECT METHODS --> 2793 <dd style="display: none; "> 2794 <div></div> 2795 </dd> 2796 2797 <!-- OBJECT EVENT FIELDS --> 2798 <dd style="display: none; "> 2799 <div></div> 2800 </dd> 2801 2802 <!-- FUNCTION PARAMETERS --> 2803 <dd style="display: none; "> 2804 <div></div> 2805 </dd> 2806 2807 </div> 2808 </div> 2809 </dl> 2810 </dd> 2811 2812 <!-- OBJECT METHODS --> 2813 <dd style="display: none; "> 2814 <div></div> 2815 </dd> 2816 2817 <!-- OBJECT EVENT FIELDS --> 2818 <dd style="display: none; "> 2819 <div></div> 2820 </dd> 2821 2822 <!-- FUNCTION PARAMETERS --> 2823 <dd style="display: none; "> 2824 <div></div> 2825 </dd> 2826 2827 </div> 2828 </div> 2829 </dl> 2830 </div> 2831 </div> <!-- /decription --> 2832 2833 </div><div class="apiItem"> 2834 <a name="event-onRequestSent"></a> 2835 <h4>onRequestSent</h4> 2836 2837 <div class="summary"> 2838 <!-- Note: intentionally longer 80 columns --> 2839 <span class="subdued">chrome.experimental.webRequest.</span><span>onRequestSent</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2840 </div> 2841 2842 <div class="description"> 2843 <p class="todo" style="display: none; ">Undocumented.</p> 2844 <p>Fires when a request is sent to the server.</p> 2845 2846 <!-- PARAMETERS --> 2847 <div> 2848 <h4>Parameters</h4> 2849 <dl> 2850 <div> 2851 <div> 2852 <dt> 2853 <var>details</var> 2854 <em> 2855 2856 <!-- TYPE --> 2857 <div style="display:inline"> 2858 ( 2859 <span class="optional" style="display: none; ">optional</span> 2860 <span class="enum" style="display: none; ">enumerated</span> 2861 <span id="typeTemplate"> 2862 <span style="display: none; "> 2863 <a> Type</a> 2864 </span> 2865 <span> 2866 <span style="display: none; "> 2867 array of <span><span></span></span> 2868 </span> 2869 <span>object</span> 2870 <span style="display: none; "></span> 2871 </span> 2872 </span> 2873 ) 2874 </div> 2875 2876 </em> 2877 </dt> 2878 <dd class="todo"> 2879 Undocumented. 2880 </dd> 2881 <dd style="display: none; "> 2882 Description of this parameter from the json schema. 2883 </dd> 2884 <dd style="display: none; "> 2885 This parameter was added in version 2886 <b><span></span></b>. 2887 You must omit this parameter in earlier versions, 2888 and you may omit it in any version. If you require this 2889 parameter, the manifest key 2890 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2891 can ensure that your extension won't be run in an earlier browser version. 2892 </dd> 2893 2894 <!-- OBJECT PROPERTIES --> 2895 <dd> 2896 <dl> 2897 <div> 2898 <div> 2899 <dt> 2900 <var>requestId</var> 2901 <em> 2902 2903 <!-- TYPE --> 2904 <div style="display:inline"> 2905 ( 2906 <span class="optional" style="display: none; ">optional</span> 2907 <span class="enum" style="display: none; ">enumerated</span> 2908 <span id="typeTemplate"> 2909 <span style="display: none; "> 2910 <a> Type</a> 2911 </span> 2912 <span> 2913 <span style="display: none; "> 2914 array of <span><span></span></span> 2915 </span> 2916 <span>string</span> 2917 <span style="display: none; "></span> 2918 </span> 2919 </span> 2920 ) 2921 </div> 2922 2923 </em> 2924 </dt> 2925 <dd class="todo" style="display: none; "> 2926 Undocumented. 2927 </dd> 2928 <dd>The ID of the request.</dd> 2929 <dd style="display: none; "> 2930 This parameter was added in version 2931 <b><span></span></b>. 2932 You must omit this parameter in earlier versions, 2933 and you may omit it in any version. If you require this 2934 parameter, the manifest key 2935 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2936 can ensure that your extension won't be run in an earlier browser version. 2937 </dd> 2938 2939 <!-- OBJECT PROPERTIES --> 2940 <dd style="display: none; "> 2941 <dl> 2942 <div> 2943 <div> 2944 </div> 2945 </div> 2946 </dl> 2947 </dd> 2948 2949 <!-- OBJECT METHODS --> 2950 <dd style="display: none; "> 2951 <div></div> 2952 </dd> 2953 2954 <!-- OBJECT EVENT FIELDS --> 2955 <dd style="display: none; "> 2956 <div></div> 2957 </dd> 2958 2959 <!-- FUNCTION PARAMETERS --> 2960 <dd style="display: none; "> 2961 <div></div> 2962 </dd> 2963 2964 </div> 2965 </div><div> 2966 <div> 2967 <dt> 2968 <var>url</var> 2969 <em> 2970 2971 <!-- TYPE --> 2972 <div style="display:inline"> 2973 ( 2974 <span class="optional" style="display: none; ">optional</span> 2975 <span class="enum" style="display: none; ">enumerated</span> 2976 <span id="typeTemplate"> 2977 <span style="display: none; "> 2978 <a> Type</a> 2979 </span> 2980 <span> 2981 <span style="display: none; "> 2982 array of <span><span></span></span> 2983 </span> 2984 <span>string</span> 2985 <span style="display: none; "></span> 2986 </span> 2987 </span> 2988 ) 2989 </div> 2990 2991 </em> 2992 </dt> 2993 <dd class="todo"> 2994 Undocumented. 2995 </dd> 2996 <dd style="display: none; "> 2997 Description of this parameter from the json schema. 2998 </dd> 2999 <dd style="display: none; "> 3000 This parameter was added in version 3001 <b><span></span></b>. 3002 You must omit this parameter in earlier versions, 3003 and you may omit it in any version. If you require this 3004 parameter, the manifest key 3005 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3006 can ensure that your extension won't be run in an earlier browser version. 3007 </dd> 3008 3009 <!-- OBJECT PROPERTIES --> 3010 <dd style="display: none; "> 3011 <dl> 3012 <div> 3013 <div> 3014 </div> 3015 </div> 3016 </dl> 3017 </dd> 3018 3019 <!-- OBJECT METHODS --> 3020 <dd style="display: none; "> 3021 <div></div> 3022 </dd> 3023 3024 <!-- OBJECT EVENT FIELDS --> 3025 <dd style="display: none; "> 3026 <div></div> 3027 </dd> 3028 3029 <!-- FUNCTION PARAMETERS --> 3030 <dd style="display: none; "> 3031 <div></div> 3032 </dd> 3033 3034 </div> 3035 </div><div> 3036 <div> 3037 <dt> 3038 <var>ip</var> 3039 <em> 3040 3041 <!-- TYPE --> 3042 <div style="display:inline"> 3043 ( 3044 <span class="optional" style="display: none; ">optional</span> 3045 <span class="enum" style="display: none; ">enumerated</span> 3046 <span id="typeTemplate"> 3047 <span style="display: none; "> 3048 <a> Type</a> 3049 </span> 3050 <span> 3051 <span style="display: none; "> 3052 array of <span><span></span></span> 3053 </span> 3054 <span>string</span> 3055 <span style="display: none; "></span> 3056 </span> 3057 </span> 3058 ) 3059 </div> 3060 3061 </em> 3062 </dt> 3063 <dd class="todo" style="display: none; "> 3064 Undocumented. 3065 </dd> 3066 <dd>The server IP address that is actually connected to. Note that it may be a literal IPv6 address.</dd> 3067 <dd style="display: none; "> 3068 This parameter was added in version 3069 <b><span></span></b>. 3070 You must omit this parameter in earlier versions, 3071 and you may omit it in any version. If you require this 3072 parameter, the manifest key 3073 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3074 can ensure that your extension won't be run in an earlier browser version. 3075 </dd> 3076 3077 <!-- OBJECT PROPERTIES --> 3078 <dd style="display: none; "> 3079 <dl> 3080 <div> 3081 <div> 3082 </div> 3083 </div> 3084 </dl> 3085 </dd> 3086 3087 <!-- OBJECT METHODS --> 3088 <dd style="display: none; "> 3089 <div></div> 3090 </dd> 3091 3092 <!-- OBJECT EVENT FIELDS --> 3093 <dd style="display: none; "> 3094 <div></div> 3095 </dd> 3096 3097 <!-- FUNCTION PARAMETERS --> 3098 <dd style="display: none; "> 3099 <div></div> 3100 </dd> 3101 3102 </div> 3103 </div><div> 3104 <div> 3105 <dt> 3106 <var>timeStamp</var> 3107 <em> 3108 3109 <!-- TYPE --> 3110 <div style="display:inline"> 3111 ( 3112 <span class="optional" style="display: none; ">optional</span> 3113 <span class="enum" style="display: none; ">enumerated</span> 3114 <span id="typeTemplate"> 3115 <span style="display: none; "> 3116 <a> Type</a> 3117 </span> 3118 <span> 3119 <span style="display: none; "> 3120 array of <span><span></span></span> 3121 </span> 3122 <span>number</span> 3123 <span style="display: none; "></span> 3124 </span> 3125 </span> 3126 ) 3127 </div> 3128 3129 </em> 3130 </dt> 3131 <dd class="todo" style="display: none; "> 3132 Undocumented. 3133 </dd> 3134 <dd>The time when the browser finished sending the request, in milliseconds since the epoch.</dd> 3135 <dd style="display: none; "> 3136 This parameter was added in version 3137 <b><span></span></b>. 3138 You must omit this parameter in earlier versions, 3139 and you may omit it in any version. If you require this 3140 parameter, the manifest key 3141 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3142 can ensure that your extension won't be run in an earlier browser version. 3143 </dd> 3144 3145 <!-- OBJECT PROPERTIES --> 3146 <dd style="display: none; "> 3147 <dl> 3148 <div> 3149 <div> 3150 </div> 3151 </div> 3152 </dl> 3153 </dd> 3154 3155 <!-- OBJECT METHODS --> 3156 <dd style="display: none; "> 3157 <div></div> 3158 </dd> 3159 3160 <!-- OBJECT EVENT FIELDS --> 3161 <dd style="display: none; "> 3162 <div></div> 3163 </dd> 3164 3165 <!-- FUNCTION PARAMETERS --> 3166 <dd style="display: none; "> 3167 <div></div> 3168 </dd> 3169 3170 </div> 3171 </div> 3172 </dl> 3173 </dd> 3174 3175 <!-- OBJECT METHODS --> 3176 <dd style="display: none; "> 3177 <div></div> 3178 </dd> 3179 3180 <!-- OBJECT EVENT FIELDS --> 3181 <dd style="display: none; "> 3182 <div></div> 3183 </dd> 3184 3185 <!-- FUNCTION PARAMETERS --> 3186 <dd style="display: none; "> 3187 <div></div> 3188 </dd> 3189 3190 </div> 3191 </div> 3192 </dl> 3193 </div> 3194 </div> <!-- /decription --> 3195 3196 </div> <!-- /apiItem --> 3197 3198 </div> <!-- /apiGroup --> 3199 3200 <!-- TYPES --> 3201 <div class="apiGroup"> 3202 <a name="types"></a> 3203 <h3 id="types">Types</h3> 3204 3205 <!-- iterates over all types --> 3206 <div class="apiItem"> 3207 <a name="type-RequestFilter"></a> 3208 <h4>RequestFilter</h4> 3209 3210 <div> 3211 <dt> 3212 <var style="display: none; ">paramName</var> 3213 <em> 3214 3215 <!-- TYPE --> 3216 <div style="display:inline"> 3217 ( 3218 <span class="optional" style="display: none; ">optional</span> 3219 <span class="enum" style="display: none; ">enumerated</span> 3220 <span id="typeTemplate"> 3221 <span style="display: none; "> 3222 <a> Type</a> 3223 </span> 3224 <span> 3225 <span style="display: none; "> 3226 array of <span><span></span></span> 3227 </span> 3228 <span>object</span> 3229 <span style="display: none; "></span> 3230 </span> 3231 </span> 3232 ) 3233 </div> 3234 3235 </em> 3236 </dt> 3237 <dd class="todo" style="display: none; "> 3238 Undocumented. 3239 </dd> 3240 <dd>An object describing filters to apply to webRequest events.</dd> 3241 <dd style="display: none; "> 3242 This parameter was added in version 3243 <b><span></span></b>. 3244 You must omit this parameter in earlier versions, 3245 and you may omit it in any version. If you require this 3246 parameter, the manifest key 3247 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3248 can ensure that your extension won't be run in an earlier browser version. 3249 </dd> 3250 3251 <!-- OBJECT PROPERTIES --> 3252 <dd> 3253 <dl> 3254 <div> 3255 <div> 3256 <dt> 3257 <var>urls</var> 3258 <em> 3259 3260 <!-- TYPE --> 3261 <div style="display:inline"> 3262 ( 3263 <span class="optional">optional</span> 3264 <span class="enum" style="display: none; ">enumerated</span> 3265 <span id="typeTemplate"> 3266 <span style="display: none; "> 3267 <a> Type</a> 3268 </span> 3269 <span> 3270 <span> 3271 array of <span><span> 3272 <span style="display: none; "> 3273 <a> Type</a> 3274 </span> 3275 <span> 3276 <span style="display: none; "> 3277 array of <span><span></span></span> 3278 </span> 3279 <span>string</span> 3280 <span style="display: none; "></span> 3281 </span> 3282 </span></span> 3283 </span> 3284 <span style="display: none; ">paramType</span> 3285 <span style="display: none; "></span> 3286 </span> 3287 </span> 3288 ) 3289 </div> 3290 3291 </em> 3292 </dt> 3293 <dd class="todo" style="display: none; "> 3294 Undocumented. 3295 </dd> 3296 <dd>A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.</dd> 3297 <dd style="display: none; "> 3298 This parameter was added in version 3299 <b><span></span></b>. 3300 You must omit this parameter in earlier versions, 3301 and you may omit it in any version. If you require this 3302 parameter, the manifest key 3303 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3304 can ensure that your extension won't be run in an earlier browser version. 3305 </dd> 3306 3307 <!-- OBJECT PROPERTIES --> 3308 <dd style="display: none; "> 3309 <dl> 3310 <div> 3311 <div> 3312 </div> 3313 </div> 3314 </dl> 3315 </dd> 3316 3317 <!-- OBJECT METHODS --> 3318 <dd style="display: none; "> 3319 <div></div> 3320 </dd> 3321 3322 <!-- OBJECT EVENT FIELDS --> 3323 <dd style="display: none; "> 3324 <div></div> 3325 </dd> 3326 3327 <!-- FUNCTION PARAMETERS --> 3328 <dd style="display: none; "> 3329 <div></div> 3330 </dd> 3331 3332 </div> 3333 </div><div> 3334 <div> 3335 <dt> 3336 <var>types</var> 3337 <em> 3338 3339 <!-- TYPE --> 3340 <div style="display:inline"> 3341 ( 3342 <span class="optional">optional</span> 3343 <span class="enum" style="display: none; ">enumerated</span> 3344 <span id="typeTemplate"> 3345 <span style="display: none; "> 3346 <a> Type</a> 3347 </span> 3348 <span> 3349 <span> 3350 array of <span><span> 3351 <span style="display: none; "> 3352 <a> Type</a> 3353 </span> 3354 <span> 3355 <span style="display: none; "> 3356 array of <span><span></span></span> 3357 </span> 3358 <span>string</span> 3359 <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"]</span> 3360 </span> 3361 </span></span> 3362 </span> 3363 <span style="display: none; ">paramType</span> 3364 <span style="display: none; "></span> 3365 </span> 3366 </span> 3367 ) 3368 </div> 3369 3370 </em> 3371 </dt> 3372 <dd class="todo" style="display: none; "> 3373 Undocumented. 3374 </dd> 3375 <dd>A list of request types. Requests that cannot match any of the types will be filtered out.</dd> 3376 <dd style="display: none; "> 3377 This parameter was added in version 3378 <b><span></span></b>. 3379 You must omit this parameter in earlier versions, 3380 and you may omit it in any version. If you require this 3381 parameter, the manifest key 3382 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3383 can ensure that your extension won't be run in an earlier browser version. 3384 </dd> 3385 3386 <!-- OBJECT PROPERTIES --> 3387 <dd style="display: none; "> 3388 <dl> 3389 <div> 3390 <div> 3391 </div> 3392 </div> 3393 </dl> 3394 </dd> 3395 3396 <!-- OBJECT METHODS --> 3397 <dd style="display: none; "> 3398 <div></div> 3399 </dd> 3400 3401 <!-- OBJECT EVENT FIELDS --> 3402 <dd style="display: none; "> 3403 <div></div> 3404 </dd> 3405 3406 <!-- FUNCTION PARAMETERS --> 3407 <dd style="display: none; "> 3408 <div></div> 3409 </dd> 3410 3411 </div> 3412 </div><div> 3413 <div> 3414 <dt> 3415 <var>tabId</var> 3416 <em> 3417 3418 <!-- TYPE --> 3419 <div style="display:inline"> 3420 ( 3421 <span class="optional">optional</span> 3422 <span class="enum" style="display: none; ">enumerated</span> 3423 <span id="typeTemplate"> 3424 <span style="display: none; "> 3425 <a> Type</a> 3426 </span> 3427 <span> 3428 <span style="display: none; "> 3429 array of <span><span></span></span> 3430 </span> 3431 <span>integer</span> 3432 <span style="display: none; "></span> 3433 </span> 3434 </span> 3435 ) 3436 </div> 3437 3438 </em> 3439 </dt> 3440 <dd class="todo"> 3441 Undocumented. 3442 </dd> 3443 <dd style="display: none; "> 3444 Description of this parameter from the json schema. 3445 </dd> 3446 <dd style="display: none; "> 3447 This parameter was added in version 3448 <b><span></span></b>. 3449 You must omit this parameter in earlier versions, 3450 and you may omit it in any version. If you require this 3451 parameter, the manifest key 3452 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3453 can ensure that your extension won't be run in an earlier browser version. 3454 </dd> 3455 3456 <!-- OBJECT PROPERTIES --> 3457 <dd style="display: none; "> 3458 <dl> 3459 <div> 3460 <div> 3461 </div> 3462 </div> 3463 </dl> 3464 </dd> 3465 3466 <!-- OBJECT METHODS --> 3467 <dd style="display: none; "> 3468 <div></div> 3469 </dd> 3470 3471 <!-- OBJECT EVENT FIELDS --> 3472 <dd style="display: none; "> 3473 <div></div> 3474 </dd> 3475 3476 <!-- FUNCTION PARAMETERS --> 3477 <dd style="display: none; "> 3478 <div></div> 3479 </dd> 3480 3481 </div> 3482 </div><div> 3483 <div> 3484 <dt> 3485 <var>windowId</var> 3486 <em> 3487 3488 <!-- TYPE --> 3489 <div style="display:inline"> 3490 ( 3491 <span class="optional">optional</span> 3492 <span class="enum" style="display: none; ">enumerated</span> 3493 <span id="typeTemplate"> 3494 <span style="display: none; "> 3495 <a> Type</a> 3496 </span> 3497 <span> 3498 <span style="display: none; "> 3499 array of <span><span></span></span> 3500 </span> 3501 <span>integer</span> 3502 <span style="display: none; "></span> 3503 </span> 3504 </span> 3505 ) 3506 </div> 3507 3508 </em> 3509 </dt> 3510 <dd class="todo"> 3511 Undocumented. 3512 </dd> 3513 <dd style="display: none; "> 3514 Description of this parameter from the json schema. 3515 </dd> 3516 <dd style="display: none; "> 3517 This parameter was added in version 3518 <b><span></span></b>. 3519 You must omit this parameter in earlier versions, 3520 and you may omit it in any version. If you require this 3521 parameter, the manifest key 3522 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3523 can ensure that your extension won't be run in an earlier browser version. 3524 </dd> 3525 3526 <!-- OBJECT PROPERTIES --> 3527 <dd style="display: none; "> 3528 <dl> 3529 <div> 3530 <div> 3531 </div> 3532 </div> 3533 </dl> 3534 </dd> 3535 3536 <!-- OBJECT METHODS --> 3537 <dd style="display: none; "> 3538 <div></div> 3539 </dd> 3540 3541 <!-- OBJECT EVENT FIELDS --> 3542 <dd style="display: none; "> 3543 <div></div> 3544 </dd> 3545 3546 <!-- FUNCTION PARAMETERS --> 3547 <dd style="display: none; "> 3548 <div></div> 3549 </dd> 3550 3551 </div> 3552 </div> 3553 </dl> 3554 </dd> 3555 3556 <!-- OBJECT METHODS --> 3557 <dd style="display: none; "> 3558 <div></div> 3559 </dd> 3560 3561 <!-- OBJECT EVENT FIELDS --> 3562 <dd style="display: none; "> 3563 <div></div> 3564 </dd> 3565 3566 <!-- FUNCTION PARAMETERS --> 3567 <dd style="display: none; "> 3568 <div></div> 3569 </dd> 3570 3571 </div> 3572 3573 </div><div class="apiItem"> 3574 <a name="type-BlockingResponse"></a> 3575 <h4>BlockingResponse</h4> 3576 3577 <div> 3578 <dt> 3579 <var style="display: none; ">paramName</var> 3580 <em> 3581 3582 <!-- TYPE --> 3583 <div style="display:inline"> 3584 ( 3585 <span class="optional" style="display: none; ">optional</span> 3586 <span class="enum" style="display: none; ">enumerated</span> 3587 <span id="typeTemplate"> 3588 <span style="display: none; "> 3589 <a> Type</a> 3590 </span> 3591 <span> 3592 <span style="display: none; "> 3593 array of <span><span></span></span> 3594 </span> 3595 <span>object</span> 3596 <span style="display: none; "></span> 3597 </span> 3598 </span> 3599 ) 3600 </div> 3601 3602 </em> 3603 </dt> 3604 <dd class="todo" style="display: none; "> 3605 Undocumented. 3606 </dd> 3607 <dd>Return value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.</dd> 3608 <dd style="display: none; "> 3609 This parameter was added in version 3610 <b><span></span></b>. 3611 You must omit this parameter in earlier versions, 3612 and you may omit it in any version. If you require this 3613 parameter, the manifest key 3614 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3615 can ensure that your extension won't be run in an earlier browser version. 3616 </dd> 3617 3618 <!-- OBJECT PROPERTIES --> 3619 <dd> 3620 <dl> 3621 <div> 3622 <div> 3623 <dt> 3624 <var>cancel</var> 3625 <em> 3626 3627 <!-- TYPE --> 3628 <div style="display:inline"> 3629 ( 3630 <span class="optional">optional</span> 3631 <span class="enum" style="display: none; ">enumerated</span> 3632 <span id="typeTemplate"> 3633 <span style="display: none; "> 3634 <a> Type</a> 3635 </span> 3636 <span> 3637 <span style="display: none; "> 3638 array of <span><span></span></span> 3639 </span> 3640 <span>boolean</span> 3641 <span style="display: none; "></span> 3642 </span> 3643 </span> 3644 ) 3645 </div> 3646 3647 </em> 3648 </dt> 3649 <dd class="todo" style="display: none; "> 3650 Undocumented. 3651 </dd> 3652 <dd>If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent.</dd> 3653 <dd style="display: none; "> 3654 This parameter was added in version 3655 <b><span></span></b>. 3656 You must omit this parameter in earlier versions, 3657 and you may omit it in any version. If you require this 3658 parameter, the manifest key 3659 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3660 can ensure that your extension won't be run in an earlier browser version. 3661 </dd> 3662 3663 <!-- OBJECT PROPERTIES --> 3664 <dd style="display: none; "> 3665 <dl> 3666 <div> 3667 <div> 3668 </div> 3669 </div> 3670 </dl> 3671 </dd> 3672 3673 <!-- OBJECT METHODS --> 3674 <dd style="display: none; "> 3675 <div></div> 3676 </dd> 3677 3678 <!-- OBJECT EVENT FIELDS --> 3679 <dd style="display: none; "> 3680 <div></div> 3681 </dd> 3682 3683 <!-- FUNCTION PARAMETERS --> 3684 <dd style="display: none; "> 3685 <div></div> 3686 </dd> 3687 3688 </div> 3689 </div><div> 3690 <div> 3691 <dt> 3692 <var>redirectUrl</var> 3693 <em> 3694 3695 <!-- TYPE --> 3696 <div style="display:inline"> 3697 ( 3698 <span class="optional">optional</span> 3699 <span class="enum" style="display: none; ">enumerated</span> 3700 <span id="typeTemplate"> 3701 <span style="display: none; "> 3702 <a> Type</a> 3703 </span> 3704 <span> 3705 <span style="display: none; "> 3706 array of <span><span></span></span> 3707 </span> 3708 <span>string</span> 3709 <span style="display: none; "></span> 3710 </span> 3711 </span> 3712 ) 3713 </div> 3714 3715 </em> 3716 </dt> 3717 <dd class="todo" style="display: none; "> 3718 Undocumented. 3719 </dd> 3720 <dd>If set, the original request is prevented from being sent and is instead redirected to the given URL.</dd> 3721 <dd style="display: none; "> 3722 This parameter was added in version 3723 <b><span></span></b>. 3724 You must omit this parameter in earlier versions, 3725 and you may omit it in any version. If you require this 3726 parameter, the manifest key 3727 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3728 can ensure that your extension won't be run in an earlier browser version. 3729 </dd> 3730 3731 <!-- OBJECT PROPERTIES --> 3732 <dd style="display: none; "> 3733 <dl> 3734 <div> 3735 <div> 3736 </div> 3737 </div> 3738 </dl> 3739 </dd> 3740 3741 <!-- OBJECT METHODS --> 3742 <dd style="display: none; "> 3743 <div></div> 3744 </dd> 3745 3746 <!-- OBJECT EVENT FIELDS --> 3747 <dd style="display: none; "> 3748 <div></div> 3749 </dd> 3750 3751 <!-- FUNCTION PARAMETERS --> 3752 <dd style="display: none; "> 3753 <div></div> 3754 </dd> 3755 3756 </div> 3757 </div> 3758 </dl> 3759 </dd> 3760 3761 <!-- OBJECT METHODS --> 3762 <dd style="display: none; "> 3763 <div></div> 3764 </dd> 3765 3766 <!-- OBJECT EVENT FIELDS --> 3767 <dd style="display: none; "> 3768 <div></div> 3769 </dd> 3770 3771 <!-- FUNCTION PARAMETERS --> 3772 <dd style="display: none; "> 3773 <div></div> 3774 </dd> 3775 3776 </div> 3777 3778 </div> <!-- /apiItem --> 3779 3780 </div> <!-- /apiGroup --> 3781 3782 </div> <!-- /apiPage --> 3783 </div> <!-- /gc-pagecontent --> 3784 </div> <!-- /g-section --> 3785 </div> <!-- /codesiteContent --> 3786 <div id="gc-footer" --=""> 3787 <div class="text"> 3788 <p> 3789 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 3790 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 3791 Attribution 3.0 License</a>, and code samples are licensed under the 3792 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 3793 </p> 3794 <p> 3795 2011 Google 3796 </p> 3797 3798 <!-- begin analytics --> 3799 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 3800 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 3801 3802 <script type="text/javascript"> 3803 // chrome doc tracking 3804 try { 3805 var engdocs = _gat._getTracker("YT-10763712-2"); 3806 engdocs._trackPageview(); 3807 } catch(err) {} 3808 3809 // code.google.com site-wide tracking 3810 try { 3811 _uacct="UA-18071-1"; 3812 _uanchor=1; 3813 _uff=0; 3814 urchinTracker(); 3815 } 3816 catch(e) {/* urchinTracker not available. */} 3817 </script> 3818 <!-- end analytics --> 3819 </div> 3820 </div> <!-- /gc-footer --> 3821 </div> <!-- /gc-container --> 3822 </body></html> 3823
