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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 8662010: Rename chrome.experimental.webRequest to chrome.webRequest and chrome.webRequestBlocking (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Regenerated documentation Created 9 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/types.html ('k') | chrome/common/extensions/extension_permission_set.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <meta name="description" content="Documentation for the chrome.experimental.we bRequest module, which is part of the Google Chrome extension APIs."><title>Web Request API - Google Chrome Extensions - Google Code</title></head> 19 <meta name="description" content="Documentation for the chrome.webRequest modu le, which is part of the Google Chrome extension APIs."><title>WebRequest API - Google Chrome Extensions - Google Code</title></head>
20 <body> <div id="gc-container" class="labs"> 20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning"> 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. 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> 23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing 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 26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" --> 27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none"> 28 <div style="display:none">
29 29
(...skipping 316 matching lines...) Expand 10 before | Expand all | Expand 10 after
346 </ol> 346 </ol>
347 </li><li> 347 </li><li>
348 <a href="#examples">Examples</a> 348 <a href="#examples">Examples</a>
349 <ol> 349 <ol>
350 <li style="display: none; "> 350 <li style="display: none; ">
351 <a>h3Name</a> 351 <a>h3Name</a>
352 </li> 352 </li>
353 </ol> 353 </ol>
354 </li> 354 </li>
355 <li> 355 <li>
356 <a href="#apiReference">API reference: chrome.experimental.webRe quest</a> 356 <a href="#apiReference">API reference: chrome.webRequest</a>
357 <ol> 357 <ol>
358 <li style="display: none; "> 358 <li style="display: none; ">
359 <a href="#properties">Properties</a> 359 <a href="#properties">Properties</a>
360 <ol> 360 <ol>
361 <li> 361 <li>
362 <a href="#property-anchor">propertyName</a> 362 <a href="#property-anchor">propertyName</a>
363 </li> 363 </li>
364 </ol> 364 </ol>
365 </li> 365 </li>
366 <li> 366 <li>
367 <a href="#global-methods">Methods</a> 367 <a href="#global-methods">Methods</a>
368 <ol> 368 <ol>
369 <li style="display: none; "> 369 <li>
370 <a href="#method-anchor">methodName</a>
371 </li><li style="display: none; ">
372 <a href="#method-anchor">methodName</a> 370 <a href="#method-anchor">methodName</a>
373 </li><li> 371 </li><li>
372 <a href="#method-anchor">methodName</a>
373 </li><li style="">
374 <a href="#method-handlerBehaviorChanged">handlerBehaviorChanged< /a> 374 <a href="#method-handlerBehaviorChanged">handlerBehaviorChanged< /a>
375 </li> 375 </li>
376 </ol> 376 </ol>
377 </li> 377 </li>
378 <li> 378 <li>
379 <a href="#global-events">Events</a> 379 <a href="#global-events">Events</a>
380 <ol> 380 <ol>
381 <li> 381 <li>
382 <a href="#event-onAuthRequired">onAuthRequired</a> 382 <a href="#event-onAuthRequired">onAuthRequired</a>
383 </li><li> 383 </li><li>
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after
474 <!-- Standard content lead-in for experimental API pages --> 474 <!-- Standard content lead-in for experimental API pages -->
475 <p id="classSummary" style="display: none; "> 475 <p id="classSummary" style="display: none; ">
476 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 476 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
477 </p> 477 </p>
478 478
479 <!-- STATIC CONTENT PLACEHOLDER --> 479 <!-- STATIC CONTENT PLACEHOLDER -->
480 <div id="static"><div id="pageData-name" class="pageData">WebRequest API </div> 480 <div id="static"><div id="pageData-name" class="pageData">WebRequest API </div>
481 481
482 <!-- BEGIN AUTHORED CONTENT --> 482 <!-- BEGIN AUTHORED CONTENT -->
483 <p id="classSummary"> 483 <p id="classSummary">
484 Use the <code>chrome.experimental.webRequest</code> module to intercept, block, 484 Use the <code>chrome.webRequest</code> module to intercept, block,
485 or modify requests in-flight. This module is still experimental. For 485 or modify requests in-flight. This module is still experimental. For
486 information on how to use experimental APIs, see the 486 information on how to use experimental APIs, see the
487 <a href="experimental.html">chrome.experimental.* APIs</a> page. 487 <a href="experimental.html">chrome.experimental.* APIs</a> page.
488 </p> 488 </p>
489 489
490 <h2 id="manifest">Manifest</h2> 490 <h2 id="manifest">Manifest</h2>
491 <p>You must declare the "experimental" permission in the <a href="manifest.html" >extension manifest</a> to use the webRequest settings 491 <p>You must declare the "webRequest" permission in the <a href="manifest.html">e xtension manifest</a> to use the webRequest settings
492 API, along with <a href="manifest.html#permissions">host permissions</a> 492 API, along with <a href="manifest.html#permissions">host permissions</a>
493 for any hosts whose network requests you want to access. 493 for any hosts whose network requests you want to access. If you want to
494 use the webRequest API in a blocking fashion, you need to request
495 the "webRequestBlocking" permission in addition.
494 For example:</p> 496 For example:</p>
495 <pre>{ 497 <pre>{
496 "name": "My extension", 498 "name": "My extension",
497 ... 499 ...
498 <b>"permissions": [ 500 <b>"permissions": [
499 "experimental", 501 "webRequest",
500 "*://*.google.com" 502 "*://*.google.com"
501 ]</b>, 503 ]</b>,
502 ... 504 ...
503 }</pre> 505 }</pre>
504 506
505 <h2 id="life_cycle">Life-cycle of requests</h2> 507 <h2 id="life_cycle">Life-cycle of requests</h2>
506 508
507 <p> 509 <p>
508 The webRequest API defines the following events: 510 The webRequest API defines the following events:
509 </p><dl> 511 </p><dl>
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after
623 625
624 <p>Each request is identified by a request ID. This ID is unique within a 626 <p>Each request is identified by a request ID. This ID is unique within a
625 browser session and the context of an extension. It remains constant during the 627 browser session and the context of an extension. It remains constant during the
626 the life-cycle of a request and can be used to match signals for the same 628 the life-cycle of a request and can be used to match signals for the same
627 request. Note that several HTTP requests are mapped to one webRequest in case of 629 request. Note that several HTTP requests are mapped to one webRequest in case of
628 HTTP redirection or HTTP authentication.</p> 630 HTTP redirection or HTTP authentication.</p>
629 631
630 <h3 id="subscription">Subscription</h3> 632 <h3 id="subscription">Subscription</h3>
631 633
632 <p>For each signal XXX of the webRequest API, the API provides a function 634 <p>For each signal XXX of the webRequest API, the API provides a function
633 <code>chrome.experimental.webRequest.XXX.addListener()</code> with the following 635 <code>chrome.webRequest.XXX.addListener()</code> with the following
634 signature.</p> 636 signature.</p>
635 637
636 <pre>var callback = function(details) {...}; 638 <pre>var callback = function(details) {...};
637 var opt_filter = {...}; 639 var opt_filter = {...};
638 var opt_extraInfoSpec = [...]; 640 var opt_extraInfoSpec = [...];
639 641
640 chrome.experimental.webRequest.XXX.addListener( 642 chrome.webRequest.XXX.addListener(
641 callback, opt_filter, opt_extraInfoSpec); 643 callback, opt_filter, opt_extraInfoSpec);
642 </pre> 644 </pre>
643 645
644 <p>Each <code>addListener()</code> call takes a mandatory callback function as 646 <p>Each <code>addListener()</code> call takes a mandatory callback function as
645 the first parameter. This callback function is passed a dictionary containing 647 the first parameter. This callback function is passed a dictionary containing
646 information about the current URL request. The information in this dictionary 648 information about the current URL request. The information in this dictionary
647 depends on the specific event type as well as the content of 649 depends on the specific event type as well as the content of
648 <code>opt_extraInfoSpec</code>.</p> 650 <code>opt_extraInfoSpec</code>.</p>
649 651
650 <p>If the optional <code>opt_extraInfoSpec</code> array contains the string 652 <p>If the optional <code>opt_extraInfoSpec</code> array contains the string
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
690 redirect has been ignored.</p> 692 redirect has been ignored.</p>
691 693
692 <a name="H2-6"></a><h2>A note about caching</h2> 694 <a name="H2-6"></a><h2>A note about caching</h2>
693 <p> 695 <p>
694 Chrome employs two caches, an on-disk cache and a very fast in-memory cache. 696 Chrome employs two caches, an on-disk cache and a very fast in-memory cache.
695 The life-time of an in-memory cache is attached to the life-time of a render 697 The life-time of an in-memory cache is attached to the life-time of a render
696 process which roughly corresponds to a tab. Requests that are answered from the 698 process which roughly corresponds to a tab. Requests that are answered from the
697 in-memory cache are invisible to the webRequest API. If a request handler 699 in-memory cache are invisible to the webRequest API. If a request handler
698 changes its behavior (for example the behavior according to which requests are 700 changes its behavior (for example the behavior according to which requests are
699 blocked), a simple page refresh might not respect this changed behavior. 701 blocked), a simple page refresh might not respect this changed behavior.
700 <code>chrome.experimental.webRequest.handlerBehaviorChanged()</code> needs to be 702 <code>chrome.webRequest.handlerBehaviorChanged()</code> needs to be
701 called to flush the in-memory cache. This is a very expensive operation and 703 called to flush the in-memory cache. This is a very expensive operation and
702 should not be done often. 704 should not be done often.
703 </p> 705 </p>
704 706
705 <a name="H2-7"></a><h2>A note about timestamps</h2> 707 <a name="H2-7"></a><h2>A note about timestamps</h2>
706 <p> 708 <p>
707 It's important to note that some technical oddities in the OS's handling 709 It's important to note that some technical oddities in the OS's handling
708 of distinct Chrome processes can cause the clock to be skewed between the 710 of distinct Chrome processes can cause the clock to be skewed between the
709 browser itself and extension processes. That means that WebRequest's events' 711 browser itself and extension processes. That means that WebRequest's events'
710 <code>timeStamp</code> property is only guaranteed to be <i>internally</i> 712 <code>timeStamp</code> property is only guaranteed to be <i>internally</i>
711 consistent. Comparing one event to another event will give you the correct 713 consistent. Comparing one event to another event will give you the correct
712 offset between them, but comparing them to the current time inside the 714 offset between them, but comparing them to the current time inside the
713 extension (via <code>(new Date()).getTime()</code>, for instance) might give 715 extension (via <code>(new Date()).getTime()</code>, for instance) might give
714 unexpected results. 716 unexpected results.
715 </p> 717 </p>
716 718
717 <h2 id="examples">Examples</h2> 719 <h2 id="examples">Examples</h2>
718 720
719 <p>The following example illustrates how to block all requests to 721 <p>The following example illustrates how to block all requests to
720 <code>www.evil.com</code>:</p> 722 <code>www.evil.com</code>:</p>
721 <pre>chrome.experimental.webRequest.onBeforeRequest.addListener( 723 <pre>chrome.webRequest.onBeforeRequest.addListener(
722 function(details) { 724 function(details) {
723 return {cancel: details.url.indexOf("://www.evil.com/") != -1}; 725 return {cancel: details.url.indexOf("://www.evil.com/") != -1};
724 }, 726 },
725 {}, 727 {},
726 ["blocking"]); 728 ["blocking"]);
727 </pre> 729 </pre>
728 730
731 <p>As this function uses a blocking signal handler, it requires the "webRequest"
732 as well as the "webRequestBlocking" permission in the manifest file.</p>
733
729 <p>The following example achives the same goal in a more efficient way because 734 <p>The following example achives the same goal in a more efficient way because
730 requests that are not targeted to <code>www.evil.com</code> do not need to be 735 requests that are not targeted to <code>www.evil.com</code> do not need to be
731 passed to the extension:</p> 736 passed to the extension:</p>
732 <pre>chrome.experimental.webRequest.onBeforeRequest.addListener( 737 <pre>chrome.webRequest.onBeforeRequest.addListener(
733 function(details) { return {cancel: true}; }, 738 function(details) { return {cancel: true}; },
734 {urls: ["*://www.evil.com/*"]}, 739 {urls: ["*://www.evil.com/*"]},
735 ["blocking"]); 740 ["blocking"]);
736 </pre> 741 </pre>
737 742
738 <p>The following example illustrates how the User-Agent header can be deleted 743 <p>The following example illustrates how the User-Agent header can be deleted
739 from all requests:</p> 744 from all requests:</p>
740 <pre>chrome.experimental.webRequest.onBeforeSendHeaders.addListener( 745 <pre>chrome.webRequest.onBeforeSendHeaders.addListener(
741 function(details) { 746 function(details) {
742 delete details.requestHeaders['User-Agent']; 747 delete details.requestHeaders['User-Agent'];
743 return {requestHeaders: details.requestHeaders}; 748 return {requestHeaders: details.requestHeaders};
744 }, 749 },
745 {}, 750 {},
746 ["blocking"]); 751 ["blocking"]);
747 </pre> 752 </pre>
748 753
749 <!-- 754 <!--
750 TODO(mkwst): update this section. We do not pass windowIds any more. 755 TODO(mkwst): update this section. We do not pass windowIds any more.
(...skipping 12 matching lines...) Expand all
763 if (!frameUrl[windowId]) { 768 if (!frameUrl[windowId]) {
764 frameUrl[windowId] = {}; 769 frameUrl[windowId] = {};
765 } 770 }
766 frameUrl[windowId][tabId + "-" + frameId] = frameUrl; 771 frameUrl[windowId][tabId + "-" + frameId] = frameUrl;
767 } 772 }
768 773
769 function getFrameUrl(windowId, tabId, frameId, frameUrl) { 774 function getFrameUrl(windowId, tabId, frameId, frameUrl) {
770 return (frameUrl[windowId] || {})[tabId + "-" + frameId]; 775 return (frameUrl[windowId] || {})[tabId + "-" + frameId];
771 } 776 }
772 777
773 chrome.experimental.webRequest.onBeforeRequest.addListener( 778 chrome.webRequest.onBeforeRequest.addListener(
774 function(d) { 779 function(d) {
775 if (d.type == 'main_frame' || d.type == 'sub_frame') { 780 if (d.type == 'main_frame' || d.type == 'sub_frame') {
776 recordFrameUrl(d.windowId, d.tabId, d.frameId, d.frameUrl); 781 recordFrameUrl(d.windowId, d.tabId, d.frameId, d.frameUrl);
777 } 782 }
778 var frameUrl = getFrameUrl(d.windowId, d.tabId, d.frameId); 783 var frameUrl = getFrameUrl(d.windowId, d.tabId, d.frameId);
779 // Use the frameUrl e.g. to selectively cancel requests. 784 // Use the frameUrl e.g. to selectively cancel requests.
780 // Attention: The frameUrl can be undefined in some cases. Requests may not 785 // Attention: The frameUrl can be undefined in some cases. Requests may not
781 // originate from a frame (e.g. requests from extensions or shared workers). 786 // originate from a frame (e.g. requests from extensions or shared workers).
782 }); 787 });
783 788
784 chrome.windows.onRemoved.addListener( 789 chrome.windows.onRemoved.addListener(
785 function(windowId) {delete frameUrl[windowId];} 790 function(windowId) {delete frameUrl[windowId];}
786 ); 791 );
787 </pre> 792 </pre>
788 --> 793 -->
789 <!-- END AUTHORED CONTENT --> 794 <!-- END AUTHORED CONTENT -->
790 </dl></div> 795 </dl></div>
791 796
792 <!-- API PAGE --> 797 <!-- API PAGE -->
793 <div class="apiPage"> 798 <div class="apiPage">
794 <a name="apiReference"></a> 799 <a name="apiReference"></a>
795 <h2>API reference: chrome.experimental.webRequest</h2> 800 <h2>API reference: chrome.webRequest</h2>
796 801
797 <!-- PROPERTIES --> 802 <!-- PROPERTIES -->
798 <div class="apiGroup" style="display: none; "> 803 <div class="apiGroup" style="display: none; ">
799 <a name="properties"></a> 804 <a name="properties"></a>
800 <h3 id="properties">Properties</h3> 805 <h3 id="properties">Properties</h3>
801 806
802 <div> 807 <div>
803 <a></a> 808 <a></a>
804 <h4>getLastError</h4> 809 <h4>getLastError</h4>
805 <div class="summary"> 810 <div class="summary">
806 <!-- Note: intentionally longer 80 columns --> 811 <!-- Note: intentionally longer 80 columns -->
807 <span>chrome.extension</span><span>lastError</span> 812 <span>chrome.extension</span><span>lastError</span>
808 </div> 813 </div>
809 <div> 814 <div>
810 </div> 815 </div>
811 </div> 816 </div>
812 817
813 </div> <!-- /apiGroup --> 818 </div> <!-- /apiGroup -->
814 819
815 <!-- METHODS --> 820 <!-- METHODS -->
816 <div id="methodsTemplate" class="apiGroup"> 821 <div id="methodsTemplate" class="apiGroup">
817 <a name="global-methods"></a> 822 <a name="global-methods"></a>
818 <h3>Methods</h3> 823 <h3>Methods</h3>
819 824
820 <!-- iterates over all functions --> 825 <!-- iterates over all functions -->
821 <div class="apiItem" style="display: none; "> 826 <div class="apiItem">
822 <a></a> <!-- method-anchor --> 827 <a></a> <!-- method-anchor -->
823 <h4>method name</h4> 828 <h4>method name</h4>
824 829
825 <div class="summary"><span>void</span> 830 <div class="summary"><span>void</span>
826 <!-- Note: intentionally longer 80 columns --> 831 <!-- Note: intentionally longer 80 columns -->
827 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span> 832 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
828 <var><span></span></var></span>)</div> 833 <var><span></span></var></span>)</div>
829 834
830 <div class="description"> 835 <div class="description">
831 <p class="todo">Undocumented.</p> 836 <p class="todo">Undocumented.</p>
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after
877 882
878 <!-- MIN_VERSION --> 883 <!-- MIN_VERSION -->
879 <p> 884 <p>
880 This function was added in version <b><span></span></b>. 885 This function was added in version <b><span></span></b>.
881 If you require this function, the manifest key 886 If you require this function, the manifest key
882 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 887 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
883 can ensure that your extension won't be run in an earlier brow ser version. 888 can ensure that your extension won't be run in an earlier brow ser version.
884 </p> 889 </p>
885 </div> <!-- /description --> 890 </div> <!-- /description -->
886 891
887 </div><div class="apiItem" style="display: none; "> 892 </div><div class="apiItem">
888 <a></a> <!-- method-anchor --> 893 <a></a> <!-- method-anchor -->
889 <h4>method name</h4> 894 <h4>method name</h4>
890 895
891 <div class="summary"><span>void</span> 896 <div class="summary"><span>void</span>
892 <!-- Note: intentionally longer 80 columns --> 897 <!-- Note: intentionally longer 80 columns -->
893 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span> 898 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
894 <var><span></span></var></span>)</div> 899 <var><span></span></var></span>)</div>
895 900
896 <div class="description"> 901 <div class="description">
897 <p class="todo">Undocumented.</p> 902 <p class="todo">Undocumented.</p>
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after
943 948
944 <!-- MIN_VERSION --> 949 <!-- MIN_VERSION -->
945 <p> 950 <p>
946 This function was added in version <b><span></span></b>. 951 This function was added in version <b><span></span></b>.
947 If you require this function, the manifest key 952 If you require this function, the manifest key
948 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 953 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
949 can ensure that your extension won't be run in an earlier brow ser version. 954 can ensure that your extension won't be run in an earlier brow ser version.
950 </p> 955 </p>
951 </div> <!-- /description --> 956 </div> <!-- /description -->
952 957
953 </div><div class="apiItem"> 958 </div><div class="apiItem" style="">
954 <a name="method-handlerBehaviorChanged"></a> <!-- method-anchor -- > 959 <a name="method-handlerBehaviorChanged"></a> <!-- method-anchor -- >
955 <h4>handlerBehaviorChanged</h4> 960 <h4>handlerBehaviorChanged</h4>
956 961
957 <div class="summary"><span style="display: none; ">void</span> 962 <div class="summary"><span style="display: none; ">void</span>
958 <!-- Note: intentionally longer 80 columns --> 963 <!-- Note: intentionally longer 80 columns -->
959 <span>chrome.experimental.webRequest.handlerBehaviorChanged</s pan>(<span class="optional"><span style="display: none; ">, </span><span>functio n</span> 964 <span>chrome.webRequest.handlerBehaviorChanged</span>(<span cl ass="optional"><span style="display: none; ">, </span><span>function</span>
960 <var><span>callback</span></var></span>)</div> 965 <var><span>callback</span></var></span>)</div>
961 966
962 <div class="description"> 967 <div class="description">
963 <p class="todo" style="display: none; ">Undocumented.</p> 968 <p class="todo" style="display: none; ">Undocumented.</p>
964 <p>Needs to be called when the behavior of the webRequest handle rs has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.</p> 969 <p>Needs to be called when the behavior of the webRequest handle rs has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.</p>
965 970
966 <!-- PARAMETERS --> 971 <!-- PARAMETERS -->
967 <h4>Parameters</h4> 972 <h4>Parameters</h4>
968 <dl> 973 <dl>
969 <div> 974 <div>
(...skipping 119 matching lines...) Expand 10 before | Expand all | Expand 10 after
1089 <div id="eventsTemplate" class="apiGroup"> 1094 <div id="eventsTemplate" class="apiGroup">
1090 <a name="global-events"></a> 1095 <a name="global-events"></a>
1091 <h3>Events</h3> 1096 <h3>Events</h3>
1092 <!-- iterates over all events --> 1097 <!-- iterates over all events -->
1093 <div class="apiItem"> 1098 <div class="apiItem">
1094 <a name="event-onAuthRequired"></a> 1099 <a name="event-onAuthRequired"></a>
1095 <h4>onAuthRequired</h4> 1100 <h4>onAuthRequired</h4>
1096 1101
1097 <div class="summary"> 1102 <div class="summary">
1098 <!-- Note: intentionally longer 80 columns --> 1103 <!-- Note: intentionally longer 80 columns -->
1099 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onAuthRequired</span><span class="subdued">.addListener</span>(function(<span> object details, function callback</span>) <span class="subdued">{...}</span><spa n>, RequestFilter filter, array of string extraInfoSpec</span>); 1104 <span class="subdued">chrome.webRequest.</span><span>onAuthRequi red</span><span class="subdued">.addListener</span>(function(<span>object detail s, function callback</span>) <span class="subdued">{...}</span><span>, RequestFi lter filter, array of string extraInfoSpec</span>);
1100 </div> 1105 </div>
1101 1106
1102 <div class="description"> 1107 <div class="description">
1103 <p class="todo" style="display: none; ">Undocumented.</p> 1108 <p class="todo" style="display: none; ">Undocumented.</p>
1104 <p>Fired when an authentication failure was received. The listen er has three options: it can provide authentication credentials, it can cancel t he request and display the error page, or it can take no action on the challenge . If bad user credentials are provided, this may be called multiple times for th e same request.</p> 1109 <p>Fired when an authentication failure was received. The listen er has three options: it can provide authentication credentials, it can cancel t he request and display the error page, or it can take no action on the challenge . If bad user credentials are provided, this may be called multiple times for th e same request.</p>
1105 1110
1106 <!-- LISTENER PARAMETERS --> 1111 <!-- LISTENER PARAMETERS -->
1107 <div> 1112 <div>
1108 <h4>Listener parameters</h4> 1113 <h4>Listener parameters</h4>
1109 <dl> 1114 <dl>
(...skipping 1005 matching lines...) Expand 10 before | Expand all | Expand 10 after
2115 <var>responseHeaders</var> 2120 <var>responseHeaders</var>
2116 <em> 2121 <em>
2117 2122
2118 <!-- TYPE --> 2123 <!-- TYPE -->
2119 <div style="display:inline"> 2124 <div style="display:inline">
2120 ( 2125 (
2121 <span class="optional">optional</span> 2126 <span class="optional">optional</span>
2122 <span class="enum" style="display: none; ">enumerated</span> 2127 <span class="enum" style="display: none; ">enumerated</span>
2123 <span id="typeTemplate"> 2128 <span id="typeTemplate">
2124 <span> 2129 <span>
2125 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 2130 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
2126 </span> 2131 </span>
2127 <span style="display: none; "> 2132 <span style="display: none; ">
2128 <span> 2133 <span>
2129 array of <span><span></span></span> 2134 array of <span><span></span></span>
2130 </span> 2135 </span>
2131 <span>paramType</span> 2136 <span>paramType</span>
2132 <span></span> 2137 <span></span>
2133 </span> 2138 </span>
2134 </span> 2139 </span>
2135 ) 2140 )
(...skipping 213 matching lines...) Expand 10 before | Expand all | Expand 10 after
2349 <var>filter</var> 2354 <var>filter</var>
2350 <em> 2355 <em>
2351 2356
2352 <!-- TYPE --> 2357 <!-- TYPE -->
2353 <div style="display:inline"> 2358 <div style="display:inline">
2354 ( 2359 (
2355 <span class="optional">optional</span> 2360 <span class="optional">optional</span>
2356 <span class="enum" style="display: none; ">enumerated</span> 2361 <span class="enum" style="display: none; ">enumerated</span>
2357 <span id="typeTemplate"> 2362 <span id="typeTemplate">
2358 <span> 2363 <span>
2359 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 2364 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
2360 </span> 2365 </span>
2361 <span style="display: none; "> 2366 <span style="display: none; ">
2362 <span> 2367 <span>
2363 array of <span><span></span></span> 2368 array of <span><span></span></span>
2364 </span> 2369 </span>
2365 <span>paramType</span> 2370 <span>paramType</span>
2366 <span></span> 2371 <span></span>
2367 </span> 2372 </span>
2368 </span> 2373 </span>
2369 ) 2374 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
2503 <var style="display: none; ">paramName</var> 2508 <var style="display: none; ">paramName</var>
2504 <em> 2509 <em>
2505 2510
2506 <!-- TYPE --> 2511 <!-- TYPE -->
2507 <div style="display:inline"> 2512 <div style="display:inline">
2508 ( 2513 (
2509 <span class="optional">optional</span> 2514 <span class="optional">optional</span>
2510 <span class="enum" style="display: none; ">enumerated</span> 2515 <span class="enum" style="display: none; ">enumerated</span>
2511 <span id="typeTemplate"> 2516 <span id="typeTemplate">
2512 <span> 2517 <span>
2513 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a> 2518 <a href="webRequest.html#type-BlockingResponse">Blocking Response</a>
2514 </span> 2519 </span>
2515 <span style="display: none; "> 2520 <span style="display: none; ">
2516 <span> 2521 <span>
2517 array of <span><span></span></span> 2522 array of <span><span></span></span>
2518 </span> 2523 </span>
2519 <span>paramType</span> 2524 <span>paramType</span>
2520 <span></span> 2525 <span></span>
2521 </span> 2526 </span>
2522 </span> 2527 </span>
2523 ) 2528 )
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
2568 </div> 2573 </div>
2569 </dl> 2574 </dl>
2570 2575
2571 </div> <!-- /description --> 2576 </div> <!-- /description -->
2572 </div><div class="apiItem"> 2577 </div><div class="apiItem">
2573 <a name="event-onBeforeRedirect"></a> 2578 <a name="event-onBeforeRedirect"></a>
2574 <h4>onBeforeRedirect</h4> 2579 <h4>onBeforeRedirect</h4>
2575 2580
2576 <div class="summary"> 2581 <div class="summary">
2577 <!-- Note: intentionally longer 80 columns --> 2582 <!-- Note: intentionally longer 80 columns -->
2578 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeRedirect</span><span class="subdued">.addListener</span>(function(<spa n>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>); 2583 <span class="subdued">chrome.webRequest.</span><span>onBeforeRed irect</span><span class="subdued">.addListener</span>(function(<span>object deta ils</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, arra y of string extraInfoSpec</span>);
2579 </div> 2584 </div>
2580 2585
2581 <div class="description"> 2586 <div class="description">
2582 <p class="todo" style="display: none; ">Undocumented.</p> 2587 <p class="todo" style="display: none; ">Undocumented.</p>
2583 <p>Fired when a server initiated redirect is about to occur.</p> 2588 <p>Fired when a server initiated redirect is about to occur.</p>
2584 2589
2585 <!-- LISTENER PARAMETERS --> 2590 <!-- LISTENER PARAMETERS -->
2586 <div> 2591 <div>
2587 <h4>Listener parameters</h4> 2592 <h4>Listener parameters</h4>
2588 <dl> 2593 <dl>
(...skipping 868 matching lines...) Expand 10 before | Expand all | Expand 10 after
3457 <var>responseHeaders</var> 3462 <var>responseHeaders</var>
3458 <em> 3463 <em>
3459 3464
3460 <!-- TYPE --> 3465 <!-- TYPE -->
3461 <div style="display:inline"> 3466 <div style="display:inline">
3462 ( 3467 (
3463 <span class="optional">optional</span> 3468 <span class="optional">optional</span>
3464 <span class="enum" style="display: none; ">enumerated</span> 3469 <span class="enum" style="display: none; ">enumerated</span>
3465 <span id="typeTemplate"> 3470 <span id="typeTemplate">
3466 <span> 3471 <span>
3467 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 3472 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
3468 </span> 3473 </span>
3469 <span style="display: none; "> 3474 <span style="display: none; ">
3470 <span> 3475 <span>
3471 array of <span><span></span></span> 3476 array of <span><span></span></span>
3472 </span> 3477 </span>
3473 <span>paramType</span> 3478 <span>paramType</span>
3474 <span></span> 3479 <span></span>
3475 </span> 3480 </span>
3476 </span> 3481 </span>
3477 ) 3482 )
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after
3621 <var>filter</var> 3626 <var>filter</var>
3622 <em> 3627 <em>
3623 3628
3624 <!-- TYPE --> 3629 <!-- TYPE -->
3625 <div style="display:inline"> 3630 <div style="display:inline">
3626 ( 3631 (
3627 <span class="optional">optional</span> 3632 <span class="optional">optional</span>
3628 <span class="enum" style="display: none; ">enumerated</span> 3633 <span class="enum" style="display: none; ">enumerated</span>
3629 <span id="typeTemplate"> 3634 <span id="typeTemplate">
3630 <span> 3635 <span>
3631 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 3636 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
3632 </span> 3637 </span>
3633 <span style="display: none; "> 3638 <span style="display: none; ">
3634 <span> 3639 <span>
3635 array of <span><span></span></span> 3640 array of <span><span></span></span>
3636 </span> 3641 </span>
3637 <span>paramType</span> 3642 <span>paramType</span>
3638 <span></span> 3643 <span></span>
3639 </span> 3644 </span>
3640 </span> 3645 </span>
3641 ) 3646 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
3775 </div> 3780 </div>
3776 </dl> 3781 </dl>
3777 3782
3778 </div> <!-- /description --> 3783 </div> <!-- /description -->
3779 </div><div class="apiItem"> 3784 </div><div class="apiItem">
3780 <a name="event-onBeforeRequest"></a> 3785 <a name="event-onBeforeRequest"></a>
3781 <h4>onBeforeRequest</h4> 3786 <h4>onBeforeRequest</h4>
3782 3787
3783 <div class="summary"> 3788 <div class="summary">
3784 <!-- Note: intentionally longer 80 columns --> 3789 <!-- Note: intentionally longer 80 columns -->
3785 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeRequest</span><span class="subdued">.addListener</span>(function(<span >object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>); 3790 <span class="subdued">chrome.webRequest.</span><span>onBeforeReq uest</span><span class="subdued">.addListener</span>(function(<span>object detai ls</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>);
3786 </div> 3791 </div>
3787 3792
3788 <div class="description"> 3793 <div class="description">
3789 <p class="todo" style="display: none; ">Undocumented.</p> 3794 <p class="todo" style="display: none; ">Undocumented.</p>
3790 <p>Fired when a request is about to occur.</p> 3795 <p>Fired when a request is about to occur.</p>
3791 3796
3792 <!-- LISTENER PARAMETERS --> 3797 <!-- LISTENER PARAMETERS -->
3793 <div> 3798 <div>
3794 <h4>Listener parameters</h4> 3799 <h4>Listener parameters</h4>
3795 <dl> 3800 <dl>
(...skipping 624 matching lines...) Expand 10 before | Expand all | Expand 10 after
4420 <var>filter</var> 4425 <var>filter</var>
4421 <em> 4426 <em>
4422 4427
4423 <!-- TYPE --> 4428 <!-- TYPE -->
4424 <div style="display:inline"> 4429 <div style="display:inline">
4425 ( 4430 (
4426 <span class="optional">optional</span> 4431 <span class="optional">optional</span>
4427 <span class="enum" style="display: none; ">enumerated</span> 4432 <span class="enum" style="display: none; ">enumerated</span>
4428 <span id="typeTemplate"> 4433 <span id="typeTemplate">
4429 <span> 4434 <span>
4430 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 4435 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
4431 </span> 4436 </span>
4432 <span style="display: none; "> 4437 <span style="display: none; ">
4433 <span> 4438 <span>
4434 array of <span><span></span></span> 4439 array of <span><span></span></span>
4435 </span> 4440 </span>
4436 <span>paramType</span> 4441 <span>paramType</span>
4437 <span></span> 4442 <span></span>
4438 </span> 4443 </span>
4439 </span> 4444 </span>
4440 ) 4445 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
4574 <var style="display: none; ">paramName</var> 4579 <var style="display: none; ">paramName</var>
4575 <em> 4580 <em>
4576 4581
4577 <!-- TYPE --> 4582 <!-- TYPE -->
4578 <div style="display:inline"> 4583 <div style="display:inline">
4579 ( 4584 (
4580 <span class="optional">optional</span> 4585 <span class="optional">optional</span>
4581 <span class="enum" style="display: none; ">enumerated</span> 4586 <span class="enum" style="display: none; ">enumerated</span>
4582 <span id="typeTemplate"> 4587 <span id="typeTemplate">
4583 <span> 4588 <span>
4584 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a> 4589 <a href="webRequest.html#type-BlockingResponse">Blocking Response</a>
4585 </span> 4590 </span>
4586 <span style="display: none; "> 4591 <span style="display: none; ">
4587 <span> 4592 <span>
4588 array of <span><span></span></span> 4593 array of <span><span></span></span>
4589 </span> 4594 </span>
4590 <span>paramType</span> 4595 <span>paramType</span>
4591 <span></span> 4596 <span></span>
4592 </span> 4597 </span>
4593 </span> 4598 </span>
4594 ) 4599 )
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
4639 </div> 4644 </div>
4640 </dl> 4645 </dl>
4641 4646
4642 </div> <!-- /description --> 4647 </div> <!-- /description -->
4643 </div><div class="apiItem"> 4648 </div><div class="apiItem">
4644 <a name="event-onBeforeSendHeaders"></a> 4649 <a name="event-onBeforeSendHeaders"></a>
4645 <h4>onBeforeSendHeaders</h4> 4650 <h4>onBeforeSendHeaders</h4>
4646 4651
4647 <div class="summary"> 4652 <div class="summary">
4648 <!-- Note: intentionally longer 80 columns --> 4653 <!-- Note: intentionally longer 80 columns -->
4649 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onBeforeSendHeaders</span><span class="subdued">.addListener</span>(function(< span>object details</span>) <span class="subdued">{...}</span><span>, RequestFil ter filter, array of string extraInfoSpec</span>); 4654 <span class="subdued">chrome.webRequest.</span><span>onBeforeSen dHeaders</span><span class="subdued">.addListener</span>(function(<span>object d etails</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, a rray of string extraInfoSpec</span>);
4650 </div> 4655 </div>
4651 4656
4652 <div class="description"> 4657 <div class="description">
4653 <p class="todo" style="display: none; ">Undocumented.</p> 4658 <p class="todo" style="display: none; ">Undocumented.</p>
4654 <p>Fired before sending an HTTP request, once the request header s are available. This may occur after a TCP connection is made to the server, bu t before any HTTP data is sent. </p> 4659 <p>Fired before sending an HTTP request, once the request header s are available. This may occur after a TCP connection is made to the server, bu t before any HTTP data is sent. </p>
4655 4660
4656 <!-- LISTENER PARAMETERS --> 4661 <!-- LISTENER PARAMETERS -->
4657 <div> 4662 <div>
4658 <h4>Listener parameters</h4> 4663 <h4>Listener parameters</h4>
4659 <dl> 4664 <dl>
(...skipping 596 matching lines...) Expand 10 before | Expand all | Expand 10 after
5256 <var>requestHeaders</var> 5261 <var>requestHeaders</var>
5257 <em> 5262 <em>
5258 5263
5259 <!-- TYPE --> 5264 <!-- TYPE -->
5260 <div style="display:inline"> 5265 <div style="display:inline">
5261 ( 5266 (
5262 <span class="optional">optional</span> 5267 <span class="optional">optional</span>
5263 <span class="enum" style="display: none; ">enumerated</span> 5268 <span class="enum" style="display: none; ">enumerated</span>
5264 <span id="typeTemplate"> 5269 <span id="typeTemplate">
5265 <span> 5270 <span>
5266 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 5271 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
5267 </span> 5272 </span>
5268 <span style="display: none; "> 5273 <span style="display: none; ">
5269 <span> 5274 <span>
5270 array of <span><span></span></span> 5275 array of <span><span></span></span>
5271 </span> 5276 </span>
5272 <span>paramType</span> 5277 <span>paramType</span>
5273 <span></span> 5278 <span></span>
5274 </span> 5279 </span>
5275 </span> 5280 </span>
5276 ) 5281 )
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
5352 <var>filter</var> 5357 <var>filter</var>
5353 <em> 5358 <em>
5354 5359
5355 <!-- TYPE --> 5360 <!-- TYPE -->
5356 <div style="display:inline"> 5361 <div style="display:inline">
5357 ( 5362 (
5358 <span class="optional">optional</span> 5363 <span class="optional">optional</span>
5359 <span class="enum" style="display: none; ">enumerated</span> 5364 <span class="enum" style="display: none; ">enumerated</span>
5360 <span id="typeTemplate"> 5365 <span id="typeTemplate">
5361 <span> 5366 <span>
5362 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 5367 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
5363 </span> 5368 </span>
5364 <span style="display: none; "> 5369 <span style="display: none; ">
5365 <span> 5370 <span>
5366 array of <span><span></span></span> 5371 array of <span><span></span></span>
5367 </span> 5372 </span>
5368 <span>paramType</span> 5373 <span>paramType</span>
5369 <span></span> 5374 <span></span>
5370 </span> 5375 </span>
5371 </span> 5376 </span>
5372 ) 5377 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
5506 <var style="display: none; ">paramName</var> 5511 <var style="display: none; ">paramName</var>
5507 <em> 5512 <em>
5508 5513
5509 <!-- TYPE --> 5514 <!-- TYPE -->
5510 <div style="display:inline"> 5515 <div style="display:inline">
5511 ( 5516 (
5512 <span class="optional">optional</span> 5517 <span class="optional">optional</span>
5513 <span class="enum" style="display: none; ">enumerated</span> 5518 <span class="enum" style="display: none; ">enumerated</span>
5514 <span id="typeTemplate"> 5519 <span id="typeTemplate">
5515 <span> 5520 <span>
5516 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a> 5521 <a href="webRequest.html#type-BlockingResponse">Blocking Response</a>
5517 </span> 5522 </span>
5518 <span style="display: none; "> 5523 <span style="display: none; ">
5519 <span> 5524 <span>
5520 array of <span><span></span></span> 5525 array of <span><span></span></span>
5521 </span> 5526 </span>
5522 <span>paramType</span> 5527 <span>paramType</span>
5523 <span></span> 5528 <span></span>
5524 </span> 5529 </span>
5525 </span> 5530 </span>
5526 ) 5531 )
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
5571 </div> 5576 </div>
5572 </dl> 5577 </dl>
5573 5578
5574 </div> <!-- /description --> 5579 </div> <!-- /description -->
5575 </div><div class="apiItem"> 5580 </div><div class="apiItem">
5576 <a name="event-onCompleted"></a> 5581 <a name="event-onCompleted"></a>
5577 <h4>onCompleted</h4> 5582 <h4>onCompleted</h4>
5578 5583
5579 <div class="summary"> 5584 <div class="summary">
5580 <!-- Note: intentionally longer 80 columns --> 5585 <!-- Note: intentionally longer 80 columns -->
5581 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onCompleted</span><span class="subdued">.addListener</span>(function(<span>obj ect details</span>) <span class="subdued">{...}</span><span>, RequestFilter filt er, array of string extraInfoSpec</span>); 5586 <span class="subdued">chrome.webRequest.</span><span>onCompleted </span><span class="subdued">.addListener</span>(function(<span>object details</ span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>);
5582 </div> 5587 </div>
5583 5588
5584 <div class="description"> 5589 <div class="description">
5585 <p class="todo" style="display: none; ">Undocumented.</p> 5590 <p class="todo" style="display: none; ">Undocumented.</p>
5586 <p>Fired when a request is completed.</p> 5591 <p>Fired when a request is completed.</p>
5587 5592
5588 <!-- LISTENER PARAMETERS --> 5593 <!-- LISTENER PARAMETERS -->
5589 <div> 5594 <div>
5590 <h4>Listener parameters</h4> 5595 <h4>Listener parameters</h4>
5591 <dl> 5596 <dl>
(...skipping 800 matching lines...) Expand 10 before | Expand all | Expand 10 after
6392 <var>responseHeaders</var> 6397 <var>responseHeaders</var>
6393 <em> 6398 <em>
6394 6399
6395 <!-- TYPE --> 6400 <!-- TYPE -->
6396 <div style="display:inline"> 6401 <div style="display:inline">
6397 ( 6402 (
6398 <span class="optional">optional</span> 6403 <span class="optional">optional</span>
6399 <span class="enum" style="display: none; ">enumerated</span> 6404 <span class="enum" style="display: none; ">enumerated</span>
6400 <span id="typeTemplate"> 6405 <span id="typeTemplate">
6401 <span> 6406 <span>
6402 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 6407 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
6403 </span> 6408 </span>
6404 <span style="display: none; "> 6409 <span style="display: none; ">
6405 <span> 6410 <span>
6406 array of <span><span></span></span> 6411 array of <span><span></span></span>
6407 </span> 6412 </span>
6408 <span>paramType</span> 6413 <span>paramType</span>
6409 <span></span> 6414 <span></span>
6410 </span> 6415 </span>
6411 </span> 6416 </span>
6412 ) 6417 )
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after
6556 <var>filter</var> 6561 <var>filter</var>
6557 <em> 6562 <em>
6558 6563
6559 <!-- TYPE --> 6564 <!-- TYPE -->
6560 <div style="display:inline"> 6565 <div style="display:inline">
6561 ( 6566 (
6562 <span class="optional">optional</span> 6567 <span class="optional">optional</span>
6563 <span class="enum" style="display: none; ">enumerated</span> 6568 <span class="enum" style="display: none; ">enumerated</span>
6564 <span id="typeTemplate"> 6569 <span id="typeTemplate">
6565 <span> 6570 <span>
6566 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 6571 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
6567 </span> 6572 </span>
6568 <span style="display: none; "> 6573 <span style="display: none; ">
6569 <span> 6574 <span>
6570 array of <span><span></span></span> 6575 array of <span><span></span></span>
6571 </span> 6576 </span>
6572 <span>paramType</span> 6577 <span>paramType</span>
6573 <span></span> 6578 <span></span>
6574 </span> 6579 </span>
6575 </span> 6580 </span>
6576 ) 6581 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
6710 </div> 6715 </div>
6711 </dl> 6716 </dl>
6712 6717
6713 </div> <!-- /description --> 6718 </div> <!-- /description -->
6714 </div><div class="apiItem"> 6719 </div><div class="apiItem">
6715 <a name="event-onErrorOccurred"></a> 6720 <a name="event-onErrorOccurred"></a>
6716 <h4>onErrorOccurred</h4> 6721 <h4>onErrorOccurred</h4>
6717 6722
6718 <div class="summary"> 6723 <div class="summary">
6719 <!-- Note: intentionally longer 80 columns --> 6724 <!-- Note: intentionally longer 80 columns -->
6720 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span >object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter</span>); 6725 <span class="subdued">chrome.webRequest.</span><span>onErrorOccu rred</span><span class="subdued">.addListener</span>(function(<span>object detai ls</span>) <span class="subdued">{...}</span><span>, RequestFilter filter</span> );
6721 </div> 6726 </div>
6722 6727
6723 <div class="description"> 6728 <div class="description">
6724 <p class="todo" style="display: none; ">Undocumented.</p> 6729 <p class="todo" style="display: none; ">Undocumented.</p>
6725 <p>Fired when an error occurs.</p> 6730 <p>Fired when an error occurs.</p>
6726 6731
6727 <!-- LISTENER PARAMETERS --> 6732 <!-- LISTENER PARAMETERS -->
6728 <div> 6733 <div>
6729 <h4>Listener parameters</h4> 6734 <h4>Listener parameters</h4>
6730 <dl> 6735 <dl>
(...skipping 828 matching lines...) Expand 10 before | Expand all | Expand 10 after
7559 <var>filter</var> 7564 <var>filter</var>
7560 <em> 7565 <em>
7561 7566
7562 <!-- TYPE --> 7567 <!-- TYPE -->
7563 <div style="display:inline"> 7568 <div style="display:inline">
7564 ( 7569 (
7565 <span class="optional">optional</span> 7570 <span class="optional">optional</span>
7566 <span class="enum" style="display: none; ">enumerated</span> 7571 <span class="enum" style="display: none; ">enumerated</span>
7567 <span id="typeTemplate"> 7572 <span id="typeTemplate">
7568 <span> 7573 <span>
7569 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 7574 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
7570 </span> 7575 </span>
7571 <span style="display: none; "> 7576 <span style="display: none; ">
7572 <span> 7577 <span>
7573 array of <span><span></span></span> 7578 array of <span><span></span></span>
7574 </span> 7579 </span>
7575 <span>paramType</span> 7580 <span>paramType</span>
7576 <span></span> 7581 <span></span>
7577 </span> 7582 </span>
7578 </span> 7583 </span>
7579 ) 7584 )
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
7634 </div> 7639 </div>
7635 </dl> 7640 </dl>
7636 7641
7637 </div> <!-- /description --> 7642 </div> <!-- /description -->
7638 </div><div class="apiItem"> 7643 </div><div class="apiItem">
7639 <a name="event-onHeadersReceived"></a> 7644 <a name="event-onHeadersReceived"></a>
7640 <h4>onHeadersReceived</h4> 7645 <h4>onHeadersReceived</h4>
7641 7646
7642 <div class="summary"> 7647 <div class="summary">
7643 <!-- Note: intentionally longer 80 columns --> 7648 <!-- Note: intentionally longer 80 columns -->
7644 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onHeadersReceived</span><span class="subdued">.addListener</span>(function(<sp an>object deails</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>); 7649 <span class="subdued">chrome.webRequest.</span><span>onHeadersRe ceived</span><span class="subdued">.addListener</span>(function(<span>object dea ils</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, arra y of string extraInfoSpec</span>);
7645 </div> 7650 </div>
7646 7651
7647 <div class="description"> 7652 <div class="description">
7648 <p class="todo" style="display: none; ">Undocumented.</p> 7653 <p class="todo" style="display: none; ">Undocumented.</p>
7649 <p>Fired when HTTP response headers of a request have been recei ved</p> 7654 <p>Fired when HTTP response headers of a request have been recei ved</p>
7650 7655
7651 <!-- LISTENER PARAMETERS --> 7656 <!-- LISTENER PARAMETERS -->
7652 <div> 7657 <div>
7653 <h4>Listener parameters</h4> 7658 <h4>Listener parameters</h4>
7654 <dl> 7659 <dl>
(...skipping 664 matching lines...) Expand 10 before | Expand all | Expand 10 after
8319 <var>responseHeaders</var> 8324 <var>responseHeaders</var>
8320 <em> 8325 <em>
8321 8326
8322 <!-- TYPE --> 8327 <!-- TYPE -->
8323 <div style="display:inline"> 8328 <div style="display:inline">
8324 ( 8329 (
8325 <span class="optional">optional</span> 8330 <span class="optional">optional</span>
8326 <span class="enum" style="display: none; ">enumerated</span> 8331 <span class="enum" style="display: none; ">enumerated</span>
8327 <span id="typeTemplate"> 8332 <span id="typeTemplate">
8328 <span> 8333 <span>
8329 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 8334 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
8330 </span> 8335 </span>
8331 <span style="display: none; "> 8336 <span style="display: none; ">
8332 <span> 8337 <span>
8333 array of <span><span></span></span> 8338 array of <span><span></span></span>
8334 </span> 8339 </span>
8335 <span>paramType</span> 8340 <span>paramType</span>
8336 <span></span> 8341 <span></span>
8337 </span> 8342 </span>
8338 </span> 8343 </span>
8339 ) 8344 )
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
8415 <var>filter</var> 8420 <var>filter</var>
8416 <em> 8421 <em>
8417 8422
8418 <!-- TYPE --> 8423 <!-- TYPE -->
8419 <div style="display:inline"> 8424 <div style="display:inline">
8420 ( 8425 (
8421 <span class="optional">optional</span> 8426 <span class="optional">optional</span>
8422 <span class="enum" style="display: none; ">enumerated</span> 8427 <span class="enum" style="display: none; ">enumerated</span>
8423 <span id="typeTemplate"> 8428 <span id="typeTemplate">
8424 <span> 8429 <span>
8425 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 8430 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
8426 </span> 8431 </span>
8427 <span style="display: none; "> 8432 <span style="display: none; ">
8428 <span> 8433 <span>
8429 array of <span><span></span></span> 8434 array of <span><span></span></span>
8430 </span> 8435 </span>
8431 <span>paramType</span> 8436 <span>paramType</span>
8432 <span></span> 8437 <span></span>
8433 </span> 8438 </span>
8434 </span> 8439 </span>
8435 ) 8440 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
8569 <var style="display: none; ">paramName</var> 8574 <var style="display: none; ">paramName</var>
8570 <em> 8575 <em>
8571 8576
8572 <!-- TYPE --> 8577 <!-- TYPE -->
8573 <div style="display:inline"> 8578 <div style="display:inline">
8574 ( 8579 (
8575 <span class="optional">optional</span> 8580 <span class="optional">optional</span>
8576 <span class="enum" style="display: none; ">enumerated</span> 8581 <span class="enum" style="display: none; ">enumerated</span>
8577 <span id="typeTemplate"> 8582 <span id="typeTemplate">
8578 <span> 8583 <span>
8579 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a> 8584 <a href="webRequest.html#type-BlockingResponse">Blocking Response</a>
8580 </span> 8585 </span>
8581 <span style="display: none; "> 8586 <span style="display: none; ">
8582 <span> 8587 <span>
8583 array of <span><span></span></span> 8588 array of <span><span></span></span>
8584 </span> 8589 </span>
8585 <span>paramType</span> 8590 <span>paramType</span>
8586 <span></span> 8591 <span></span>
8587 </span> 8592 </span>
8588 </span> 8593 </span>
8589 ) 8594 )
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
8634 </div> 8639 </div>
8635 </dl> 8640 </dl>
8636 8641
8637 </div> <!-- /description --> 8642 </div> <!-- /description -->
8638 </div><div class="apiItem"> 8643 </div><div class="apiItem">
8639 <a name="event-onResponseStarted"></a> 8644 <a name="event-onResponseStarted"></a>
8640 <h4>onResponseStarted</h4> 8645 <h4>onResponseStarted</h4>
8641 8646
8642 <div class="summary"> 8647 <div class="summary">
8643 <!-- Note: intentionally longer 80 columns --> 8648 <!-- Note: intentionally longer 80 columns -->
8644 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onResponseStarted</span><span class="subdued">.addListener</span>(function(<sp an>object details</span>) <span class="subdued">{...}</span><span>, RequestFilte r filter, array of string extraInfoSpec</span>); 8649 <span class="subdued">chrome.webRequest.</span><span>onResponseS tarted</span><span class="subdued">.addListener</span>(function(<span>object det ails</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, arr ay of string extraInfoSpec</span>);
8645 </div> 8650 </div>
8646 8651
8647 <div class="description"> 8652 <div class="description">
8648 <p class="todo" style="display: none; ">Undocumented.</p> 8653 <p class="todo" style="display: none; ">Undocumented.</p>
8649 <p>Fired when the first byte of the response body is received. F or HTTP requests, this means that the status line and response headers are avail able.</p> 8654 <p>Fired when the first byte of the response body is received. F or HTTP requests, this means that the status line and response headers are avail able.</p>
8650 8655
8651 <!-- LISTENER PARAMETERS --> 8656 <!-- LISTENER PARAMETERS -->
8652 <div> 8657 <div>
8653 <h4>Listener parameters</h4> 8658 <h4>Listener parameters</h4>
8654 <dl> 8659 <dl>
(...skipping 800 matching lines...) Expand 10 before | Expand all | Expand 10 after
9455 <var>responseHeaders</var> 9460 <var>responseHeaders</var>
9456 <em> 9461 <em>
9457 9462
9458 <!-- TYPE --> 9463 <!-- TYPE -->
9459 <div style="display:inline"> 9464 <div style="display:inline">
9460 ( 9465 (
9461 <span class="optional">optional</span> 9466 <span class="optional">optional</span>
9462 <span class="enum" style="display: none; ">enumerated</span> 9467 <span class="enum" style="display: none; ">enumerated</span>
9463 <span id="typeTemplate"> 9468 <span id="typeTemplate">
9464 <span> 9469 <span>
9465 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 9470 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
9466 </span> 9471 </span>
9467 <span style="display: none; "> 9472 <span style="display: none; ">
9468 <span> 9473 <span>
9469 array of <span><span></span></span> 9474 array of <span><span></span></span>
9470 </span> 9475 </span>
9471 <span>paramType</span> 9476 <span>paramType</span>
9472 <span></span> 9477 <span></span>
9473 </span> 9478 </span>
9474 </span> 9479 </span>
9475 ) 9480 )
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after
9619 <var>filter</var> 9624 <var>filter</var>
9620 <em> 9625 <em>
9621 9626
9622 <!-- TYPE --> 9627 <!-- TYPE -->
9623 <div style="display:inline"> 9628 <div style="display:inline">
9624 ( 9629 (
9625 <span class="optional">optional</span> 9630 <span class="optional">optional</span>
9626 <span class="enum" style="display: none; ">enumerated</span> 9631 <span class="enum" style="display: none; ">enumerated</span>
9627 <span id="typeTemplate"> 9632 <span id="typeTemplate">
9628 <span> 9633 <span>
9629 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 9634 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
9630 </span> 9635 </span>
9631 <span style="display: none; "> 9636 <span style="display: none; ">
9632 <span> 9637 <span>
9633 array of <span><span></span></span> 9638 array of <span><span></span></span>
9634 </span> 9639 </span>
9635 <span>paramType</span> 9640 <span>paramType</span>
9636 <span></span> 9641 <span></span>
9637 </span> 9642 </span>
9638 </span> 9643 </span>
9639 ) 9644 )
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
9773 </div> 9778 </div>
9774 </dl> 9779 </dl>
9775 9780
9776 </div> <!-- /description --> 9781 </div> <!-- /description -->
9777 </div><div class="apiItem"> 9782 </div><div class="apiItem">
9778 <a name="event-onSendHeaders"></a> 9783 <a name="event-onSendHeaders"></a>
9779 <h4>onSendHeaders</h4> 9784 <h4>onSendHeaders</h4>
9780 9785
9781 <div class="summary"> 9786 <div class="summary">
9782 <!-- Note: intentionally longer 80 columns --> 9787 <!-- Note: intentionally longer 80 columns -->
9783 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onSendHeaders</span><span class="subdued">.addListener</span>(function(<span>o bject details</span>) <span class="subdued">{...}</span><span>, RequestFilter fi lter, array of string extraInfoSpec</span>); 9788 <span class="subdued">chrome.webRequest.</span><span>onSendHeade rs</span><span class="subdued">.addListener</span>(function(<span>object details </span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array o f string extraInfoSpec</span>);
9784 </div> 9789 </div>
9785 9790
9786 <div class="description"> 9791 <div class="description">
9787 <p class="todo" style="display: none; ">Undocumented.</p> 9792 <p class="todo" style="display: none; ">Undocumented.</p>
9788 <p>Fired just before a request is going to be sent to the server (modifications of prvious onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).</p> 9793 <p>Fired just before a request is going to be sent to the server (modifications of prvious onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).</p>
9789 9794
9790 <!-- LISTENER PARAMETERS --> 9795 <!-- LISTENER PARAMETERS -->
9791 <div> 9796 <div>
9792 <h4>Listener parameters</h4> 9797 <h4>Listener parameters</h4>
9793 <dl> 9798 <dl>
(...skipping 596 matching lines...) Expand 10 before | Expand all | Expand 10 after
10390 <var>requestHeaders</var> 10395 <var>requestHeaders</var>
10391 <em> 10396 <em>
10392 10397
10393 <!-- TYPE --> 10398 <!-- TYPE -->
10394 <div style="display:inline"> 10399 <div style="display:inline">
10395 ( 10400 (
10396 <span class="optional">optional</span> 10401 <span class="optional">optional</span>
10397 <span class="enum" style="display: none; ">enumerated</span> 10402 <span class="enum" style="display: none; ">enumerated</span>
10398 <span id="typeTemplate"> 10403 <span id="typeTemplate">
10399 <span> 10404 <span>
10400 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 10405 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
10401 </span> 10406 </span>
10402 <span style="display: none; "> 10407 <span style="display: none; ">
10403 <span> 10408 <span>
10404 array of <span><span></span></span> 10409 array of <span><span></span></span>
10405 </span> 10410 </span>
10406 <span>paramType</span> 10411 <span>paramType</span>
10407 <span></span> 10412 <span></span>
10408 </span> 10413 </span>
10409 </span> 10414 </span>
10410 ) 10415 )
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
10486 <var>filter</var> 10491 <var>filter</var>
10487 <em> 10492 <em>
10488 10493
10489 <!-- TYPE --> 10494 <!-- TYPE -->
10490 <div style="display:inline"> 10495 <div style="display:inline">
10491 ( 10496 (
10492 <span class="optional">optional</span> 10497 <span class="optional">optional</span>
10493 <span class="enum" style="display: none; ">enumerated</span> 10498 <span class="enum" style="display: none; ">enumerated</span>
10494 <span id="typeTemplate"> 10499 <span id="typeTemplate">
10495 <span> 10500 <span>
10496 <a href="experimental.webRequest.html#type-RequestFilter ">RequestFilter</a> 10501 <a href="webRequest.html#type-RequestFilter">RequestFilt er</a>
10497 </span> 10502 </span>
10498 <span style="display: none; "> 10503 <span style="display: none; ">
10499 <span> 10504 <span>
10500 array of <span><span></span></span> 10505 array of <span><span></span></span>
10501 </span> 10506 </span>
10502 <span>paramType</span> 10507 <span>paramType</span>
10503 <span></span> 10508 <span></span>
10504 </span> 10509 </span>
10505 </span> 10510 </span>
10506 ) 10511 )
(...skipping 996 matching lines...) Expand 10 before | Expand all | Expand 10 after
11503 <var>requestHeaders</var> 11508 <var>requestHeaders</var>
11504 <em> 11509 <em>
11505 11510
11506 <!-- TYPE --> 11511 <!-- TYPE -->
11507 <div style="display:inline"> 11512 <div style="display:inline">
11508 ( 11513 (
11509 <span class="optional">optional</span> 11514 <span class="optional">optional</span>
11510 <span class="enum" style="display: none; ">enumerated</span> 11515 <span class="enum" style="display: none; ">enumerated</span>
11511 <span id="typeTemplate"> 11516 <span id="typeTemplate">
11512 <span> 11517 <span>
11513 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 11518 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
11514 </span> 11519 </span>
11515 <span style="display: none; "> 11520 <span style="display: none; ">
11516 <span> 11521 <span>
11517 array of <span><span></span></span> 11522 array of <span><span></span></span>
11518 </span> 11523 </span>
11519 <span>paramType</span> 11524 <span>paramType</span>
11520 <span></span> 11525 <span></span>
11521 </span> 11526 </span>
11522 </span> 11527 </span>
11523 ) 11528 )
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after
11571 <var>responseHeaders</var> 11576 <var>responseHeaders</var>
11572 <em> 11577 <em>
11573 11578
11574 <!-- TYPE --> 11579 <!-- TYPE -->
11575 <div style="display:inline"> 11580 <div style="display:inline">
11576 ( 11581 (
11577 <span class="optional">optional</span> 11582 <span class="optional">optional</span>
11578 <span class="enum" style="display: none; ">enumerated</span> 11583 <span class="enum" style="display: none; ">enumerated</span>
11579 <span id="typeTemplate"> 11584 <span id="typeTemplate">
11580 <span> 11585 <span>
11581 <a href="experimental.webRequest.html#type-HttpHeaders"> HttpHeaders</a> 11586 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
11582 </span> 11587 </span>
11583 <span style="display: none; "> 11588 <span style="display: none; ">
11584 <span> 11589 <span>
11585 array of <span><span></span></span> 11590 array of <span><span></span></span>
11586 </span> 11591 </span>
11587 <span>paramType</span> 11592 <span>paramType</span>
11588 <span></span> 11593 <span></span>
11589 </span> 11594 </span>
11590 </span> 11595 </span>
11591 ) 11596 )
(...skipping 305 matching lines...) Expand 10 before | Expand all | Expand 10 after
11897 _uff=0; 11902 _uff=0;
11898 urchinTracker(); 11903 urchinTracker();
11899 } 11904 }
11900 catch(e) {/* urchinTracker not available. */} 11905 catch(e) {/* urchinTracker not available. */}
11901 </script> 11906 </script>
11902 <!-- end analytics --> 11907 <!-- end analytics -->
11903 </div> 11908 </div>
11904 </div> <!-- /gc-footer --> 11909 </div> <!-- /gc-footer -->
11905 </div> <!-- /gc-container --> 11910 </div> <!-- /gc-container -->
11906 </body></html> 11911 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/types.html ('k') | chrome/common/extensions/extension_permission_set.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698