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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10449069: Support redirects by regular expression in declarative WebRequest API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Addressed comments Created 8 years, 6 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
« chrome/browser/extensions/api/declarative_webrequest/webrequest_action.cc ('K') | « chrome/common/extensions/api/declarative_web_request.json ('k') | chrome/renderer/resources/extensions/declarative_webrequest_custom_bindings.js » ('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>
(...skipping 205 matching lines...) Expand 10 before | Expand all | Expand 10 after
216 <ol> 216 <ol>
217 <li> 217 <li>
218 <a href="#event-onRequest">onRequest</a> 218 <a href="#event-onRequest">onRequest</a>
219 </li> 219 </li>
220 </ol> 220 </ol>
221 </li> 221 </li>
222 <li> 222 <li>
223 <a href="#types">Types</a> 223 <a href="#types">Types</a>
224 <ol> 224 <ol>
225 <li> 225 <li>
226 <a href="#type-declarativeWebRequest.RedirectByRegEx">declarativ eWebRequest.RedirectByRegEx</a>
227 <ol>
228 </ol>
229 </li><li>
226 <a href="#type-RequestMatcher">RequestMatcher</a> 230 <a href="#type-RequestMatcher">RequestMatcher</a>
227 <ol> 231 <ol>
228 </ol> 232 </ol>
229 </li><li> 233 </li><li>
230 <a href="#type-CancelRequest">CancelRequest</a>
231 <ol>
232 </ol>
233 </li><li>
234 <a href="#type-RedirectRequest">RedirectRequest</a> 234 <a href="#type-RedirectRequest">RedirectRequest</a>
235 <ol> 235 <ol>
236 </ol> 236 </ol>
237 </li><li> 237 </li><li>
238 <a href="#type-declarativeWebRequest.RedirectToTransparentImage" >declarativeWebRequest.RedirectToTransparentImage</a> 238 <a href="#type-declarativeWebRequest.RedirectToTransparentImage" >declarativeWebRequest.RedirectToTransparentImage</a>
239 <ol> 239 <ol>
240 </ol> 240 </ol>
241 </li><li> 241 </li><li>
242 <a href="#type-declarativeWebRequest.RedirectToEmptyDocument">de clarativeWebRequest.RedirectToEmptyDocument</a> 242 <a href="#type-declarativeWebRequest.RedirectToEmptyDocument">de clarativeWebRequest.RedirectToEmptyDocument</a>
243 <ol> 243 <ol>
244 </ol> 244 </ol>
245 </li><li> 245 </li><li>
246 <a href="#type-CancelRequest">CancelRequest</a>
247 <ol>
248 </ol>
249 </li><li>
246 <a href="#type-declarativeWebRequest.SetRequestHeader">declarati veWebRequest.SetRequestHeader</a> 250 <a href="#type-declarativeWebRequest.SetRequestHeader">declarati veWebRequest.SetRequestHeader</a>
247 <ol> 251 <ol>
248 </ol> 252 </ol>
249 </li><li> 253 </li><li>
250 <a href="#type-declarativeWebRequest.RemoveRequestHeader">declar ativeWebRequest.RemoveRequestHeader</a> 254 <a href="#type-declarativeWebRequest.RemoveRequestHeader">declar ativeWebRequest.RemoveRequestHeader</a>
251 <ol> 255 <ol>
252 </ol> 256 </ol>
253 </li><li> 257 </li><li>
254 <a href="#type-declarativeWebRequest.AddResponseHeader">declarat iveWebRequest.AddResponseHeader</a> 258 <a href="#type-declarativeWebRequest.AddResponseHeader">declarat iveWebRequest.AddResponseHeader</a>
255 <ol> 259 <ol>
(...skipping 204 matching lines...) Expand 10 before | Expand all | Expand 10 after
460 <dt> 464 <dt>
461 <a href="declarativeWebRequest.html#type-declarativeWebRequest.Redir ectToEmptyDocument">declarativeWebRequest.RedirectToEmptyDocument</a> 465 <a href="declarativeWebRequest.html#type-declarativeWebRequest.Redir ectToEmptyDocument">declarativeWebRequest.RedirectToEmptyDocument</a>
462 </dt> 466 </dt>
463 <dd class="todo"> 467 <dd class="todo">
464 Undocumented. 468 Undocumented.
465 </dd> 469 </dd>
466 </div> 470 </div>
467 </div><div> 471 </div><div>
468 <div> 472 <div>
469 <dt> 473 <dt>
474 <a href="declarativeWebRequest.html#type-declarativeWebRequest.Redir ectByRegEx">declarativeWebRequest.RedirectByRegEx</a>
475 </dt>
476 <dd class="todo">
477 Undocumented.
478 </dd>
479 </div>
480 </div><div>
481 <div>
482 <dt>
470 <a href="declarativeWebRequest.html#type-declarativeWebRequest.SetRe questHeader">declarativeWebRequest.SetRequestHeader</a> 483 <a href="declarativeWebRequest.html#type-declarativeWebRequest.SetRe questHeader">declarativeWebRequest.SetRequestHeader</a>
471 </dt> 484 </dt>
472 <dd class="todo"> 485 <dd class="todo">
473 Undocumented. 486 Undocumented.
474 </dd> 487 </dd>
475 </div> 488 </div>
476 </div><div> 489 </div><div>
477 <div> 490 <div>
478 <dt> 491 <dt>
479 <a href="declarativeWebRequest.html#type-declarativeWebRequest.Remov eRequestHeader">declarativeWebRequest.RemoveRequestHeader</a> 492 <a href="declarativeWebRequest.html#type-declarativeWebRequest.Remov eRequestHeader">declarativeWebRequest.RemoveRequestHeader</a>
(...skipping 25 matching lines...) Expand all
505 </div> <!-- /actions --> 518 </div> <!-- /actions -->
506 </div> <!-- /description --> 519 </div> <!-- /description -->
507 </div> <!-- /apiItem --> 520 </div> <!-- /apiItem -->
508 </div> <!-- /apiGroup --> 521 </div> <!-- /apiGroup -->
509 <!-- TYPES --> 522 <!-- TYPES -->
510 <div class="apiGroup"> 523 <div class="apiGroup">
511 <a name="types"></a> 524 <a name="types"></a>
512 <h3 id="types">Types</h3> 525 <h3 id="types">Types</h3>
513 <!-- iterates over all types --> 526 <!-- iterates over all types -->
514 <div class="apiItem"> 527 <div class="apiItem">
515 <a name="type-RequestMatcher"></a> 528 <a name="type-declarativeWebRequest.RedirectByRegEx"></a>
516 <h4>RequestMatcher</h4> 529 <h4>declarativeWebRequest.RedirectByRegEx</h4>
517 <div> 530 <div>
518 <dt> 531 <dt>
519 <em> 532 <em>
520 <!-- TYPE --> 533 <!-- TYPE -->
521 <div style="display:inline"> 534 <div style="display:inline">
522 ( 535 (
523 <span id="typeTemplate"> 536 <span id="typeTemplate">
524 <span> 537 <span>
525 <span>object</span> 538 <span>object</span>
526 </span> 539 </span>
527 </span> 540 </span>
528 ) 541 )
529 </div> 542 </div>
530 </em> 543 </em>
531 </dt> 544 </dt>
532 <dd>Matches network events by various criteria.</dd> 545 <dd>Redirects a request by applying a regular expression on the URL. T he regular expressions use the <a href="http://code.google.com/p/re2/wiki/Syntax ">RE2 syntax</a>.</dd>
533 <!-- OBJECT PROPERTIES --> 546 <!-- OBJECT PROPERTIES -->
534 <dd> 547 <dd>
535 <dl> 548 <dl>
536 <div> 549 <div>
537 <div> 550 <div>
538 <dt> 551 <dt>
539 <var>url</var> 552 <var>from</var>
540 <em> 553 <em>
541 <!-- TYPE --> 554 <!-- TYPE -->
542 <div style="display:inline"> 555 <div style="display:inline">
543 ( 556 (
544 <span class="optional">optional</span>
545 <span id="typeTemplate"> 557 <span id="typeTemplate">
546 <span> 558 <span>
547 <a>events.UrlFilter</a> 559 <span>string</span>
548 </span> 560 </span>
549 </span> 561 </span>
550 ) 562 )
551 </div> 563 </div>
552 </em> 564 </em>
553 </dt> 565 </dt>
554 <dd>Matches if the condition of the UrlFilter are fulfilled for the UR L of the request.</dd> 566 <dd>A match pattern that may contain capture groups. Capture groups ar e referenced in the Perl syntax ($1, $2, ...) instead of the RE2 syntax (\1, \2, ...) in order to be closer to JavaScript Regular Expressions.</dd>
555 <!-- OBJECT PROPERTIES --> 567 <!-- OBJECT PROPERTIES -->
556 <!-- OBJECT METHODS --> 568 <!-- OBJECT METHODS -->
557 <!-- OBJECT EVENT FIELDS --> 569 <!-- OBJECT EVENT FIELDS -->
558 <!-- FUNCTION PARAMETERS --> 570 <!-- FUNCTION PARAMETERS -->
559 </div> 571 </div>
560 </div><div> 572 </div><div>
561 <div> 573 <div>
562 <dt> 574 <dt>
575 <var>to</var>
576 <em>
577 <!-- TYPE -->
578 <div style="display:inline">
579 (
580 <span id="typeTemplate">
581 <span>
582 <span>string</span>
583 </span>
584 </span>
585 )
586 </div>
587 </em>
588 </dt>
589 <dd>Destination pattern.</dd>
590 <!-- OBJECT PROPERTIES -->
591 <!-- OBJECT METHODS -->
592 <!-- OBJECT EVENT FIELDS -->
593 <!-- FUNCTION PARAMETERS -->
594 </div>
595 </div>
596 </dl>
597 </dd>
598 <!-- OBJECT METHODS -->
599 <!-- OBJECT EVENT FIELDS -->
600 <!-- FUNCTION PARAMETERS -->
601 </div>
602 </div><div class="apiItem">
603 <a name="type-RequestMatcher"></a>
604 <h4>RequestMatcher</h4>
605 <div>
606 <dt>
607 <em>
608 <!-- TYPE -->
609 <div style="display:inline">
610 (
611 <span id="typeTemplate">
612 <span>
613 <span>object</span>
614 </span>
615 </span>
616 )
617 </div>
618 </em>
619 </dt>
620 <dd>Matches network events by various criteria.</dd>
621 <!-- OBJECT PROPERTIES -->
622 <dd>
623 <dl>
624 <div>
625 <div>
626 <dt>
627 <var>url</var>
628 <em>
629 <!-- TYPE -->
630 <div style="display:inline">
631 (
632 <span class="optional">optional</span>
633 <span id="typeTemplate">
634 <span>
635 <a>events.UrlFilter</a>
636 </span>
637 </span>
638 )
639 </div>
640 </em>
641 </dt>
642 <dd>Matches if the condition of the UrlFilter are fulfilled for the UR L of the request.</dd>
643 <!-- OBJECT PROPERTIES -->
644 <!-- OBJECT METHODS -->
645 <!-- OBJECT EVENT FIELDS -->
646 <!-- FUNCTION PARAMETERS -->
647 </div>
648 </div><div>
649 <div>
650 <dt>
563 <var>resourceType</var> 651 <var>resourceType</var>
564 <em> 652 <em>
565 <!-- TYPE --> 653 <!-- TYPE -->
566 <div style="display:inline"> 654 <div style="display:inline">
567 ( 655 (
568 <span class="optional">optional</span> 656 <span class="optional">optional</span>
569 <span id="typeTemplate"> 657 <span id="typeTemplate">
570 <span> 658 <span>
571 <span> 659 <span>
572 array of <span><span> 660 array of <span><span>
(...skipping 12 matching lines...) Expand all
585 <dd>Matches if the request type of a request is contained in the list. Requests that cannot match any of the types will be filtered out.</dd> 673 <dd>Matches if the request type of a request is contained in the list. Requests that cannot match any of the types will be filtered out.</dd>
586 <!-- OBJECT PROPERTIES --> 674 <!-- OBJECT PROPERTIES -->
587 <!-- OBJECT METHODS --> 675 <!-- OBJECT METHODS -->
588 <!-- OBJECT EVENT FIELDS --> 676 <!-- OBJECT EVENT FIELDS -->
589 <!-- FUNCTION PARAMETERS --> 677 <!-- FUNCTION PARAMETERS -->
590 </div> 678 </div>
591 </div><div> 679 </div><div>
592 <div> 680 <div>
593 <dt> 681 <dt>
594 <var>instanceType</var> 682 <var>instanceType</var>
595 <em>
596 <!-- TYPE -->
597 <div style="display:inline">
598 (
599 <span class="enum">enumerated</span>
600 <span id="typeTemplate">
601 <span>
602 <span>string</span>
603 <span>["declarativeWebRequest.RequestMatcher"]</span>
604 </span>
605 </span>
606 )
607 </div>
608 </em>
609 </dt>
610 <dd class="todo">
611 Undocumented.
612 </dd>
613 <!-- OBJECT PROPERTIES -->
614 <!-- OBJECT METHODS -->
615 <!-- OBJECT EVENT FIELDS -->
616 <!-- FUNCTION PARAMETERS -->
617 </div>
618 </div>
619 </dl>
620 </dd>
621 <!-- OBJECT METHODS -->
622 <!-- OBJECT EVENT FIELDS -->
623 <!-- FUNCTION PARAMETERS -->
624 </div>
625 </div><div class="apiItem">
626 <a name="type-CancelRequest"></a>
627 <h4>CancelRequest</h4>
628 <div>
629 <dt>
630 <em>
631 <!-- TYPE -->
632 <div style="display:inline">
633 (
634 <span id="typeTemplate">
635 <span>
636 <span>object</span>
637 </span>
638 </span>
639 )
640 </div>
641 </em>
642 </dt>
643 <dd>Declarative event action that cancels a network request.</dd>
644 <!-- OBJECT PROPERTIES -->
645 <dd>
646 <dl>
647 <div>
648 <div>
649 <dt>
650 <var>instanceType</var>
651 <em> 683 <em>
652 <!-- TYPE --> 684 <!-- TYPE -->
653 <div style="display:inline"> 685 <div style="display:inline">
654 ( 686 (
655 <span class="enum">enumerated</span> 687 <span class="enum">enumerated</span>
656 <span id="typeTemplate"> 688 <span id="typeTemplate">
657 <span> 689 <span>
658 <span>string</span> 690 <span>string</span>
659 <span>["declarativeWebRequest.CancelRequest"]</span> 691 <span>["declarativeWebRequest.RequestMatcher"]</span>
660 </span> 692 </span>
661 </span> 693 </span>
662 ) 694 )
663 </div> 695 </div>
664 </em> 696 </em>
665 </dt> 697 </dt>
666 <dd class="todo"> 698 <dd class="todo">
667 Undocumented. 699 Undocumented.
668 </dd> 700 </dd>
669 <!-- OBJECT PROPERTIES --> 701 <!-- OBJECT PROPERTIES -->
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after
807 <!-- OBJECT PROPERTIES --> 839 <!-- OBJECT PROPERTIES -->
808 <dd> 840 <dd>
809 <dl> 841 <dl>
810 </dl> 842 </dl>
811 </dd> 843 </dd>
812 <!-- OBJECT METHODS --> 844 <!-- OBJECT METHODS -->
813 <!-- OBJECT EVENT FIELDS --> 845 <!-- OBJECT EVENT FIELDS -->
814 <!-- FUNCTION PARAMETERS --> 846 <!-- FUNCTION PARAMETERS -->
815 </div> 847 </div>
816 </div><div class="apiItem"> 848 </div><div class="apiItem">
849 <a name="type-CancelRequest"></a>
850 <h4>CancelRequest</h4>
851 <div>
852 <dt>
853 <em>
854 <!-- TYPE -->
855 <div style="display:inline">
856 (
857 <span id="typeTemplate">
858 <span>
859 <span>object</span>
860 </span>
861 </span>
862 )
863 </div>
864 </em>
865 </dt>
866 <dd>Declarative event action that cancels a network request.</dd>
867 <!-- OBJECT PROPERTIES -->
868 <dd>
869 <dl>
870 <div>
871 <div>
872 <dt>
873 <var>instanceType</var>
874 <em>
875 <!-- TYPE -->
876 <div style="display:inline">
877 (
878 <span class="enum">enumerated</span>
879 <span id="typeTemplate">
880 <span>
881 <span>string</span>
882 <span>["declarativeWebRequest.CancelRequest"]</span>
883 </span>
884 </span>
885 )
886 </div>
887 </em>
888 </dt>
889 <dd class="todo">
890 Undocumented.
891 </dd>
892 <!-- OBJECT PROPERTIES -->
893 <!-- OBJECT METHODS -->
894 <!-- OBJECT EVENT FIELDS -->
895 <!-- FUNCTION PARAMETERS -->
896 </div>
897 </div>
898 </dl>
899 </dd>
900 <!-- OBJECT METHODS -->
901 <!-- OBJECT EVENT FIELDS -->
902 <!-- FUNCTION PARAMETERS -->
903 </div>
904 </div><div class="apiItem">
817 <a name="type-declarativeWebRequest.SetRequestHeader"></a> 905 <a name="type-declarativeWebRequest.SetRequestHeader"></a>
818 <h4>declarativeWebRequest.SetRequestHeader</h4> 906 <h4>declarativeWebRequest.SetRequestHeader</h4>
819 <div> 907 <div>
820 <dt> 908 <dt>
821 <em> 909 <em>
822 <!-- TYPE --> 910 <!-- TYPE -->
823 <div style="display:inline"> 911 <div style="display:inline">
824 ( 912 (
825 <span id="typeTemplate"> 913 <span id="typeTemplate">
826 <span> 914 <span>
(...skipping 349 matching lines...) Expand 10 before | Expand all | Expand 10 after
1176 _uff=0; 1264 _uff=0;
1177 urchinTracker(); 1265 urchinTracker();
1178 } 1266 }
1179 catch(e) {/* urchinTracker not available. */} 1267 catch(e) {/* urchinTracker not available. */}
1180 </script> 1268 </script>
1181 <!-- end analytics --> 1269 <!-- end analytics -->
1182 </div> 1270 </div>
1183 </div> <!-- /gc-footer --> 1271 </div> <!-- /gc-footer -->
1184 </div> <!-- /gc-container --> 1272 </div> <!-- /gc-container -->
1185 </body></html> 1273 </body></html>
OLDNEW
« chrome/browser/extensions/api/declarative_webrequest/webrequest_action.cc ('K') | « chrome/common/extensions/api/declarative_web_request.json ('k') | chrome/renderer/resources/extensions/declarative_webrequest_custom_bindings.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698