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

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

Issue 8015004: webRequest.onAuthRequired listeners can provide authentication credentials. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Merge Created 9 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 943 matching lines...) Expand 10 before | Expand all | Expand 10 after
954 <a name="event-onAuthRequired"></a> 954 <a name="event-onAuthRequired"></a>
955 <h4>onAuthRequired</h4> 955 <h4>onAuthRequired</h4>
956 956
957 <div class="summary"> 957 <div class="summary">
958 <!-- Note: intentionally longer 80 columns --> 958 <!-- Note: intentionally longer 80 columns -->
959 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onAuthRequired</span><span class="subdued">.addListener</span>(function(<span> object details</span>) <span class="subdued">{...}</span><span>, RequestFilter f ilter, array of string extraInfoSpec</span>); 959 <span class="subdued">chrome.experimental.webRequest.</span><spa n>onAuthRequired</span><span class="subdued">.addListener</span>(function(<span> object details</span>) <span class="subdued">{...}</span><span>, RequestFilter f ilter, array of string extraInfoSpec</span>);
960 </div> 960 </div>
961 961
962 <div class="description"> 962 <div class="description">
963 <p class="todo" style="display: none; ">Undocumented.</p> 963 <p class="todo" style="display: none; ">Undocumented.</p>
964 <p>Fired when an authentication failure was received. Depending on whether the user provides credentials, the request is either reissued or canc elled.</p> 964 <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>
965 965
966 <!-- LISTENER PARAMETERS --> 966 <!-- LISTENER PARAMETERS -->
967 <div> 967 <div>
968 <h4>Listener parameters</h4> 968 <h4>Listener parameters</h4>
969 <dl> 969 <dl>
970 <div> 970 <div>
971 <div> 971 <div>
972 <dt> 972 <dt>
973 <var>details</var> 973 <var>details</var>
974 <em> 974 <em>
(...skipping 1177 matching lines...) Expand 10 before | Expand all | Expand 10 after
2152 <span> 2152 <span>
2153 array of <span><span> 2153 array of <span><span>
2154 <span style="display: none; "> 2154 <span style="display: none; ">
2155 <a> Type</a> 2155 <a> Type</a>
2156 </span> 2156 </span>
2157 <span> 2157 <span>
2158 <span style="display: none; "> 2158 <span style="display: none; ">
2159 array of <span><span></span></span> 2159 array of <span><span></span></span>
2160 </span> 2160 </span>
2161 <span>string</span> 2161 <span>string</span>
2162 <span>["responseHeaders"]</span> 2162 <span>["responseHeaders", "blocking"]</span>
2163 </span> 2163 </span>
2164 </span></span> 2164 </span></span>
2165 </span> 2165 </span>
2166 <span style="display: none; ">paramType</span> 2166 <span style="display: none; ">paramType</span>
2167 <span style="display: none; "></span> 2167 <span style="display: none; "></span>
2168 </span> 2168 </span>
2169 </span> 2169 </span>
2170 ) 2170 )
2171 </div> 2171 </div>
2172 2172
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
2210 <dd style="display: none; "> 2210 <dd style="display: none; ">
2211 <div></div> 2211 <div></div>
2212 </dd> 2212 </dd>
2213 2213
2214 </div> 2214 </div>
2215 </div> 2215 </div>
2216 </dl> 2216 </dl>
2217 </div> 2217 </div>
2218 2218
2219 <!-- LISTENER RETURN VALUE --> 2219 <!-- LISTENER RETURN VALUE -->
2220 <h4 style="display: none; ">Listener returns</h4> 2220 <h4>Listener returns</h4>
2221 <dl> 2221 <dl>
2222 <div style="display: none; "> 2222 <div>
2223 <div> 2223 <div>
2224 </div> 2224 <dt>
2225 <var style="display: none; ">paramName</var>
2226 <em>
2227
2228 <!-- TYPE -->
2229 <div style="display:inline">
2230 (
2231 <span class="optional">optional</span>
2232 <span class="enum" style="display: none; ">enumerated</span>
2233 <span id="typeTemplate">
2234 <span>
2235 <a href="experimental.webRequest.html#type-BlockingRespo nse">BlockingResponse</a>
2236 </span>
2237 <span style="display: none; ">
2238 <span>
2239 array of <span><span></span></span>
2240 </span>
2241 <span>paramType</span>
2242 <span></span>
2243 </span>
2244 </span>
2245 )
2246 </div>
2247
2248 </em>
2249 </dt>
2250 <dd class="todo" style="display: none; ">
2251 Undocumented.
2252 </dd>
2253 <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the e vent listener should return an object of this type.</dd>
2254 <dd style="display: none; ">
2255 This parameter was added in version
2256 <b><span></span></b>.
2257 You must omit this parameter in earlier versions,
2258 and you may omit it in any version. If you require this
2259 parameter, the manifest key
2260 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2261 can ensure that your extension won't be run in an earlier browser ve rsion.
2262 </dd>
2263
2264 <!-- OBJECT PROPERTIES -->
2265 <dd style="display: none; ">
2266 <dl>
2267 <div>
2268 <div>
2269 </div>
2270 </div>
2271 </dl>
2272 </dd>
2273
2274 <!-- OBJECT METHODS -->
2275 <dd style="display: none; ">
2276 <div></div>
2277 </dd>
2278
2279 <!-- OBJECT EVENT FIELDS -->
2280 <dd style="display: none; ">
2281 <div></div>
2282 </dd>
2283
2284 <!-- FUNCTION PARAMETERS -->
2285 <dd style="display: none; ">
2286 <div></div>
2287 </dd>
2288
2289 </div>
2225 </div> 2290 </div>
2226 </dl> 2291 </dl>
2227 2292
2228 </div> <!-- /description --> 2293 </div> <!-- /description -->
2229 </div><div class="apiItem"> 2294 </div><div class="apiItem">
2230 <a name="event-onBeforeRedirect"></a> 2295 <a name="event-onBeforeRedirect"></a>
2231 <h4>onBeforeRedirect</h4> 2296 <h4>onBeforeRedirect</h4>
2232 2297
2233 <div class="summary"> 2298 <div class="summary">
2234 <!-- Note: intentionally longer 80 columns --> 2299 <!-- Note: intentionally longer 80 columns -->
(...skipping 8292 matching lines...) Expand 10 before | Expand all | Expand 10 after
10527 <dd style="display: none; "> 10592 <dd style="display: none; ">
10528 <div></div> 10593 <div></div>
10529 </dd> 10594 </dd>
10530 10595
10531 <!-- FUNCTION PARAMETERS --> 10596 <!-- FUNCTION PARAMETERS -->
10532 <dd style="display: none; "> 10597 <dd style="display: none; ">
10533 <div></div> 10598 <div></div>
10534 </dd> 10599 </dd>
10535 10600
10536 </div> 10601 </div>
10537 </div> 10602 </div><div>
10538 </dl> 10603 <div>
10539 </dd> 10604 <dt>
10605 <var>authCredentials</var>
10606 <em>
10607
10608 <!-- TYPE -->
10609 <div style="display:inline">
10610 (
10611 <span class="optional">optional</span>
10612 <span class="enum" style="display: none; ">enumerated</span>
10613 <span id="typeTemplate">
10614 <span style="display: none; ">
10615 <a> Type</a>
10616 </span>
10617 <span>
10618 <span style="display: none; ">
10619 array of <span><span></span></span>
10620 </span>
10621 <span>object</span>
10622 <span style="display: none; "></span>
10623 </span>
10624 </span>
10625 )
10626 </div>
10627
10628 </em>
10629 </dt>
10630 <dd class="todo" style="display: none; ">
10631 Undocumented.
10632 </dd>
10633 <dd>Only used as a response to the onAuthRequired event. If set, the r equest is made using the supplied credentials.</dd>
10634 <dd style="display: none; ">
10635 This parameter was added in version
10636 <b><span></span></b>.
10637 You must omit this parameter in earlier versions,
10638 and you may omit it in any version. If you require this
10639 parameter, the manifest key
10640 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10641 can ensure that your extension won't be run in an earlier browser ve rsion.
10642 </dd>
10643
10644 <!-- OBJECT PROPERTIES -->
10645 <dd>
10646 <dl>
10647 <div>
10648 <div>
10649 <dt>
10650 <var>username</var>
10651 <em>
10652
10653 <!-- TYPE -->
10654 <div style="display:inline">
10655 (
10656 <span class="optional" style="display: none; ">optional</spa n>
10657 <span class="enum" style="display: none; ">enumerated</span>
10658 <span id="typeTemplate">
10659 <span style="display: none; ">
10660 <a> Type</a>
10661 </span>
10662 <span>
10663 <span style="display: none; ">
10664 array of <span><span></span></span>
10665 </span>
10666 <span>string</span>
10667 <span style="display: none; "></span>
10668 </span>
10669 </span>
10670 )
10671 </div>
10672
10673 </em>
10674 </dt>
10675 <dd class="todo">
10676 Undocumented.
10677 </dd>
10678 <dd style="display: none; ">
10679 Description of this parameter from the json schema.
10680 </dd>
10681 <dd style="display: none; ">
10682 This parameter was added in version
10683 <b><span></span></b>.
10684 You must omit this parameter in earlier versions,
10685 and you may omit it in any version. If you require this
10686 parameter, the manifest key
10687 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10688 can ensure that your extension won't be run in an earlier browser ve rsion.
10689 </dd>
10690
10691 <!-- OBJECT PROPERTIES -->
10692 <dd style="display: none; ">
10693 <dl>
10694 <div>
10695 <div>
10696 </div>
10697 </div>
10698 </dl>
10699 </dd>
10700
10701 <!-- OBJECT METHODS -->
10702 <dd style="display: none; ">
10703 <div></div>
10704 </dd>
10705
10706 <!-- OBJECT EVENT FIELDS -->
10707 <dd style="display: none; ">
10708 <div></div>
10709 </dd>
10710
10711 <!-- FUNCTION PARAMETERS -->
10712 <dd style="display: none; ">
10713 <div></div>
10714 </dd>
10715
10716 </div>
10717 </div><div>
10718 <div>
10719 <dt>
10720 <var>password</var>
10721 <em>
10722
10723 <!-- TYPE -->
10724 <div style="display:inline">
10725 (
10726 <span class="optional" style="display: none; ">optional</spa n>
10727 <span class="enum" style="display: none; ">enumerated</span>
10728 <span id="typeTemplate">
10729 <span style="display: none; ">
10730 <a> Type</a>
10731 </span>
10732 <span>
10733 <span style="display: none; ">
10734 array of <span><span></span></span>
10735 </span>
10736 <span>string</span>
10737 <span style="display: none; "></span>
10738 </span>
10739 </span>
10740 )
10741 </div>
10742
10743 </em>
10744 </dt>
10745 <dd class="todo">
10746 Undocumented.
10747 </dd>
10748 <dd style="display: none; ">
10749 Description of this parameter from the json schema.
10750 </dd>
10751 <dd style="display: none; ">
10752 This parameter was added in version
10753 <b><span></span></b>.
10754 You must omit this parameter in earlier versions,
10755 and you may omit it in any version. If you require this
10756 parameter, the manifest key
10757 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
10758 can ensure that your extension won't be run in an earlier browser ve rsion.
10759 </dd>
10760
10761 <!-- OBJECT PROPERTIES -->
10762 <dd style="display: none; ">
10763 <dl>
10764 <div>
10765 <div>
10766 </div>
10767 </div>
10768 </dl>
10769 </dd>
10770
10771 <!-- OBJECT METHODS -->
10772 <dd style="display: none; ">
10773 <div></div>
10774 </dd>
10775
10776 <!-- OBJECT EVENT FIELDS -->
10777 <dd style="display: none; ">
10778 <div></div>
10779 </dd>
10780
10781 <!-- FUNCTION PARAMETERS -->
10782 <dd style="display: none; ">
10783 <div></div>
10784 </dd>
10785
10786 </div>
10787 </div>
10788 </dl>
10789 </dd>
10790
10791 <!-- OBJECT METHODS -->
10792 <dd style="display: none; ">
10793 <div></div>
10794 </dd>
10795
10796 <!-- OBJECT EVENT FIELDS -->
10797 <dd style="display: none; ">
10798 <div></div>
10799 </dd>
10800
10801 <!-- FUNCTION PARAMETERS -->
10802 <dd style="display: none; ">
10803 <div></div>
10804 </dd>
10805
10806 </div>
10807 </div>
10808 </dl>
10809 </dd>
10540 10810
10541 <!-- OBJECT METHODS --> 10811 <!-- OBJECT METHODS -->
10542 <dd style="display: none; "> 10812 <dd style="display: none; ">
10543 <div></div> 10813 <div></div>
10544 </dd> 10814 </dd>
10545 10815
10546 <!-- OBJECT EVENT FIELDS --> 10816 <!-- OBJECT EVENT FIELDS -->
10547 <dd style="display: none; "> 10817 <dd style="display: none; ">
10548 <div></div> 10818 <div></div>
10549 </dd> 10819 </dd>
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
10593 _uff=0; 10863 _uff=0;
10594 urchinTracker(); 10864 urchinTracker();
10595 } 10865 }
10596 catch(e) {/* urchinTracker not available. */} 10866 catch(e) {/* urchinTracker not available. */}
10597 </script> 10867 </script>
10598 <!-- end analytics --> 10868 <!-- end analytics -->
10599 </div> 10869 </div>
10600 </div> <!-- /gc-footer --> 10870 </div> <!-- /gc-footer -->
10601 </div> <!-- /gc-container --> 10871 </div> <!-- /gc-container -->
10602 </body></html> 10872 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/test/data/extensions/api_test/webrequest/framework.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698