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

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/common/extensions/api/declarative_web_request.json ('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.</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>
563 <var>resourceType</var> 575 <var>to</var>
564 <em> 576 <em>
565 <!-- TYPE --> 577 <!-- TYPE -->
566 <div style="display:inline"> 578 <div style="display:inline">
567 ( 579 (
568 <span class="optional">optional</span>
569 <span id="typeTemplate"> 580 <span id="typeTemplate">
570 <span> 581 <span>
571 <span>
572 array of <span><span>
573 <span>
574 <span>string</span> 582 <span>string</span>
575 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
576 </span>
577 </span></span>
578 </span>
579 </span> 583 </span>
580 </span> 584 </span>
581 ) 585 )
582 </div> 586 </div>
583 </em> 587 </em>
584 </dt> 588 </dt>
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> 589 <dd>Destination pattern.</dd>
586 <!-- OBJECT PROPERTIES --> 590 <!-- OBJECT PROPERTIES -->
587 <!-- OBJECT METHODS --> 591 <!-- OBJECT METHODS -->
588 <!-- OBJECT EVENT FIELDS --> 592 <!-- OBJECT EVENT FIELDS -->
589 <!-- FUNCTION PARAMETERS --> 593 <!-- FUNCTION PARAMETERS -->
590 </div> 594 </div>
591 </div><div> 595 </div><div>
592 <div> 596 <div>
593 <dt> 597 <dt>
594 <var>instanceType</var> 598 <var>perlCaptureGroupStyle</var>
595 <em> 599 <em>
596 <!-- TYPE --> 600 <!-- TYPE -->
597 <div style="display:inline"> 601 <div style="display:inline">
598 ( 602 (
599 <span class="enum">enumerated</span> 603 <span class="optional">optional</span>
600 <span id="typeTemplate"> 604 <span id="typeTemplate">
601 <span> 605 <span>
602 <span>string</span> 606 <span>boolean</span>
603 <span>["declarativeWebRequest.RequestMatcher"]</span>
604 </span> 607 </span>
605 </span> 608 </span>
606 ) 609 )
607 </div> 610 </div>
608 </em> 611 </em>
609 </dt> 612 </dt>
610 <dd class="todo"> 613 <dd>If set to true, capture groups are referenced in the perl syntax ( $1, $2, ...) instead of the RE2 syntax (\1, \2, ...). Defaults to false.</dd>
611 Undocumented.
612 </dd>
613 <!-- OBJECT PROPERTIES --> 614 <!-- OBJECT PROPERTIES -->
614 <!-- OBJECT METHODS --> 615 <!-- OBJECT METHODS -->
615 <!-- OBJECT EVENT FIELDS --> 616 <!-- OBJECT EVENT FIELDS -->
616 <!-- FUNCTION PARAMETERS --> 617 <!-- FUNCTION PARAMETERS -->
617 </div> 618 </div>
618 </div> 619 </div>
619 </dl> 620 </dl>
620 </dd> 621 </dd>
621 <!-- OBJECT METHODS --> 622 <!-- OBJECT METHODS -->
622 <!-- OBJECT EVENT FIELDS --> 623 <!-- OBJECT EVENT FIELDS -->
623 <!-- FUNCTION PARAMETERS --> 624 <!-- FUNCTION PARAMETERS -->
624 </div> 625 </div>
625 </div><div class="apiItem"> 626 </div><div class="apiItem">
626 <a name="type-CancelRequest"></a> 627 <a name="type-RequestMatcher"></a>
627 <h4>CancelRequest</h4> 628 <h4>RequestMatcher</h4>
628 <div> 629 <div>
629 <dt> 630 <dt>
630 <em> 631 <em>
631 <!-- TYPE --> 632 <!-- TYPE -->
632 <div style="display:inline"> 633 <div style="display:inline">
633 ( 634 (
634 <span id="typeTemplate"> 635 <span id="typeTemplate">
635 <span> 636 <span>
636 <span>object</span> 637 <span>object</span>
637 </span> 638 </span>
638 </span> 639 </span>
639 ) 640 )
640 </div> 641 </div>
641 </em> 642 </em>
642 </dt> 643 </dt>
643 <dd>Declarative event action that cancels a network request.</dd> 644 <dd>Matches network events by various criteria.</dd>
644 <!-- OBJECT PROPERTIES --> 645 <!-- OBJECT PROPERTIES -->
645 <dd> 646 <dd>
646 <dl> 647 <dl>
647 <div> 648 <div>
648 <div> 649 <div>
649 <dt> 650 <dt>
651 <var>url</var>
652 <em>
653 <!-- TYPE -->
654 <div style="display:inline">
655 (
656 <span class="optional">optional</span>
657 <span id="typeTemplate">
658 <span>
659 <a>events.UrlFilter</a>
660 </span>
661 </span>
662 )
663 </div>
664 </em>
665 </dt>
666 <dd>Matches if the condition of the UrlFilter are fulfilled for the UR L of the request.</dd>
667 <!-- OBJECT PROPERTIES -->
668 <!-- OBJECT METHODS -->
669 <!-- OBJECT EVENT FIELDS -->
670 <!-- FUNCTION PARAMETERS -->
671 </div>
672 </div><div>
673 <div>
674 <dt>
675 <var>resourceType</var>
676 <em>
677 <!-- TYPE -->
678 <div style="display:inline">
679 (
680 <span class="optional">optional</span>
681 <span id="typeTemplate">
682 <span>
683 <span>
684 array of <span><span>
685 <span>
686 <span>string</span>
687 <span>["main_frame", "sub_frame", "stylesheet", "script" , "image", "object", "xmlhttprequest", "other"]</span>
688 </span>
689 </span></span>
690 </span>
691 </span>
692 </span>
693 )
694 </div>
695 </em>
696 </dt>
697 <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>
698 <!-- OBJECT PROPERTIES -->
699 <!-- OBJECT METHODS -->
700 <!-- OBJECT EVENT FIELDS -->
701 <!-- FUNCTION PARAMETERS -->
702 </div>
703 </div><div>
704 <div>
705 <dt>
650 <var>instanceType</var> 706 <var>instanceType</var>
651 <em> 707 <em>
652 <!-- TYPE --> 708 <!-- TYPE -->
653 <div style="display:inline"> 709 <div style="display:inline">
654 ( 710 (
655 <span class="enum">enumerated</span> 711 <span class="enum">enumerated</span>
656 <span id="typeTemplate"> 712 <span id="typeTemplate">
657 <span> 713 <span>
658 <span>string</span> 714 <span>string</span>
659 <span>["declarativeWebRequest.CancelRequest"]</span> 715 <span>["declarativeWebRequest.RequestMatcher"]</span>
660 </span> 716 </span>
661 </span> 717 </span>
662 ) 718 )
663 </div> 719 </div>
664 </em> 720 </em>
665 </dt> 721 </dt>
666 <dd class="todo"> 722 <dd class="todo">
667 Undocumented. 723 Undocumented.
668 </dd> 724 </dd>
669 <!-- OBJECT PROPERTIES --> 725 <!-- OBJECT PROPERTIES -->
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after
807 <!-- OBJECT PROPERTIES --> 863 <!-- OBJECT PROPERTIES -->
808 <dd> 864 <dd>
809 <dl> 865 <dl>
810 </dl> 866 </dl>
811 </dd> 867 </dd>
812 <!-- OBJECT METHODS --> 868 <!-- OBJECT METHODS -->
813 <!-- OBJECT EVENT FIELDS --> 869 <!-- OBJECT EVENT FIELDS -->
814 <!-- FUNCTION PARAMETERS --> 870 <!-- FUNCTION PARAMETERS -->
815 </div> 871 </div>
816 </div><div class="apiItem"> 872 </div><div class="apiItem">
873 <a name="type-CancelRequest"></a>
874 <h4>CancelRequest</h4>
875 <div>
876 <dt>
877 <em>
878 <!-- TYPE -->
879 <div style="display:inline">
880 (
881 <span id="typeTemplate">
882 <span>
883 <span>object</span>
884 </span>
885 </span>
886 )
887 </div>
888 </em>
889 </dt>
890 <dd>Declarative event action that cancels a network request.</dd>
891 <!-- OBJECT PROPERTIES -->
892 <dd>
893 <dl>
894 <div>
895 <div>
896 <dt>
897 <var>instanceType</var>
898 <em>
899 <!-- TYPE -->
900 <div style="display:inline">
901 (
902 <span class="enum">enumerated</span>
903 <span id="typeTemplate">
904 <span>
905 <span>string</span>
906 <span>["declarativeWebRequest.CancelRequest"]</span>
907 </span>
908 </span>
909 )
910 </div>
911 </em>
912 </dt>
913 <dd class="todo">
914 Undocumented.
915 </dd>
916 <!-- OBJECT PROPERTIES -->
917 <!-- OBJECT METHODS -->
918 <!-- OBJECT EVENT FIELDS -->
919 <!-- FUNCTION PARAMETERS -->
920 </div>
921 </div>
922 </dl>
923 </dd>
924 <!-- OBJECT METHODS -->
925 <!-- OBJECT EVENT FIELDS -->
926 <!-- FUNCTION PARAMETERS -->
927 </div>
928 </div><div class="apiItem">
817 <a name="type-declarativeWebRequest.SetRequestHeader"></a> 929 <a name="type-declarativeWebRequest.SetRequestHeader"></a>
818 <h4>declarativeWebRequest.SetRequestHeader</h4> 930 <h4>declarativeWebRequest.SetRequestHeader</h4>
819 <div> 931 <div>
820 <dt> 932 <dt>
821 <em> 933 <em>
822 <!-- TYPE --> 934 <!-- TYPE -->
823 <div style="display:inline"> 935 <div style="display:inline">
824 ( 936 (
825 <span id="typeTemplate"> 937 <span id="typeTemplate">
826 <span> 938 <span>
(...skipping 349 matching lines...) Expand 10 before | Expand all | Expand 10 after
1176 _uff=0; 1288 _uff=0;
1177 urchinTracker(); 1289 urchinTracker();
1178 } 1290 }
1179 catch(e) {/* urchinTracker not available. */} 1291 catch(e) {/* urchinTracker not available. */}
1180 </script> 1292 </script>
1181 <!-- end analytics --> 1293 <!-- end analytics -->
1182 </div> 1294 </div>
1183 </div> <!-- /gc-footer --> 1295 </div> <!-- /gc-footer -->
1184 </div> <!-- /gc-container --> 1296 </div> <!-- /gc-container -->
1185 </body></html> 1297 </body></html>
OLDNEW
« chrome/common/extensions/api/declarative_web_request.json ('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