-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathevents.html
978 lines (932 loc) · 45.7 KB
/
events.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
<link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
<link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
<link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
<link href="stable/static/css/api.css" rel="stylesheet" type="text/css">
<title>chrome.events - chrome插件中文开发文档(非官方)</title>
</head>
<body>
<a id="top"></a>
<div id="header">{Header content}</div>
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
</li>
</ul>
</div>
<div id="gc-container">
<div id="gc-sidebar">
<ul
class="level1 ">
<li class="level2">
<a href="getstarted.html" class="level2 ">Getting Started</a>
</li>
<li class="level2">
<a href="overview.html" class="level2 ">Overview</a>
</li>
<li class="level2">
<a href="whats_new.html" class="level2 ">What's New?</a>
</li>
<li class="level2">
<a href="devguide.html" class="level2 ">Developer's Guide</a>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Browser UI</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="browserAction.html" class="level4 ">Browser Actions</a>
</li>
<li class="level4">
<a href="contextMenus.html" class="level4 ">Context Menus</a>
</li>
<li class="level4">
<a href="notifications.html" class="level4 ">Desktop Notifications</a>
</li>
<li class="level4">
<a href="omnibox.html" class="level4 ">Omnibox</a>
</li>
<li class="level4">
<a href="options.html" class="level4 ">Options Pages</a>
</li>
<li class="level4">
<a href="override.html" class="level4 ">Override Pages</a>
</li>
<li class="level4">
<a href="pageAction.html" class="level4 ">Page Actions</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Browser Interaction</span>
<div class="toggleIndicator level3 toggled"></div>
</a>
<ul toggleable
class="level3 ">
<li class="level4">
<a href="bookmarks.html" class="level4 ">Bookmarks</a>
</li>
<li class="level4">
<a href="cookies.html" class="level4 ">Cookies</a>
</li>
<li class="level4">
<a href="devtools.html" class="level4 ">Developer Tools</a>
</li>
<li class="level4">
<a class="level4 selected">Events</a>
</li>
<li class="level4">
<a href="history.html" class="level4 ">History</a>
</li>
<li class="level4">
<a href="management.html" class="level4 ">Management</a>
</li>
<li class="level4">
<a href="tabs.html" class="level4 ">Tabs</a>
</li>
<li class="level4">
<a href="windows.html" class="level4 ">Windows</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Implementation</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="a11y.html" class="level4 ">Accessibility</a>
</li>
<li class="level4">
<a href="event_pages.html" class="level4 ">Event Pages</a>
</li>
<li class="level4">
<a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
</li>
<li class="level4">
<a href="content_scripts.html" class="level4 ">Content Scripts</a>
</li>
<li class="level4">
<a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
</li>
<li class="level4">
<a href="i18n.html" class="level4 ">Internationalization</a>
</li>
<li class="level4">
<a href="messaging.html" class="level4 ">Message Passing</a>
</li>
<li class="level4">
<a href="permissions.html" class="level4 ">Optional Permissions</a>
</li>
<li class="level4">
<a href="npapi.html" class="level4 ">NPAPI Plugins</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Finishing</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="hosting.html" class="level4 ">Hosting</a>
</li>
<li class="level4">
<a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="level2">
<a href="tutorials.html" class="level2 ">Tutorials</a>
<ul
class="level2 ">
<li class="level3">
<a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
</li>
<li class="level3">
<a href="tut_debugging.html" class="level3 ">Debugging</a>
</li>
<li class="level3">
<a href="tut_analytics.html" class="level3 ">Google Analytics</a>
</li>
<li class="level3">
<a href="tut_oauth.html" class="level3 ">OAuth</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">Reference</span>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Formats</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="manifest.html" class="level4 ">Manifest Files</a>
</li>
<li class="level4">
<a href="match_patterns.html" class="level4 ">Match Patterns</a>
</li>
</ul>
</li>
<li class="level3">
<a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
</li>
<li class="level3">
<a href="api_index.html" class="level3 ">chrome.* APIs</a>
</li>
<li class="level3">
<a href="api_other.html" class="level3 ">Other APIs</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">More</span>
<ul
class="level2 ">
<li class="level3">
<a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
</li>
<li class="level3">
<a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
</li>
<li class="level3">
<a href="themes.html" class="level3 ">Themes</a>
</li>
</ul>
</li>
</ul>
</div>
<div id="gc-pagecontent">
<h1 class="page_title">chrome.events</h1>
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href=#declarative>Declarative Event Handlers</a>
<ol>
<li><a href=#rules>Rules</a></li><li><a href=#eventobjects>Event objects</a></li><li><a href=#addingrules>Adding rules</a></li><li><a href=#removingrules>Removing rules</a></li><li><a href=#retrievingrules>Retrieving rules</a></li>
</ol>
</li>
<li>
<a href=#filtered>Filtered events</a>
</li>
<li>
<a href="#apiReference">API reference: chrome.events</a>
<ol>
<li><a href="#types">Types</a><ol> <li> <a href="#type-Event">Event</a><ol><li> <a href="#Event-methods">Methods</a> <ol> <li><a href="#method-Event-addListener">addListener</a></li> <li><a href="#method-Event-removeListener">removeListener</a></li> <li><a href="#method-Event-hasListener">hasListener</a></li> <li><a href="#method-Event-hasListeners">hasListeners</a></li> <li><a href="#method-Event-addRules">addRules</a></li> <li><a href="#method-Event-getRules">getRules</a></li> <li><a href="#method-Event-removeRules">removeRules</a></li> </ol> </li></ol> </li> <li> <a href="#type-Rule">Rule</a> </li> <li> <a href="#type-UrlFilter">UrlFilter</a> </li></ol></li>
</ol>
</li>
</ol>
</div>
<p>
An <code>Event</code> is an object
that allows you to be notified
when something interesting happens.
Here's an example of using the
<code>chrome.tabs.onCreated</code> event
to be notified whenever there's a new tab:
</p>
<pre>
chrome.tabs.onCreated.<b>addListener(function(</b>tab<b>) {</b>
appendToLog('tabs.onCreated --'
+ ' window: ' + tab.windowId
+ ' tab: ' + tab.id
+ ' index: ' + tab.index
+ ' url: ' + tab.url);
<b>});</b>
</pre>
<p>
As the example shows,
you register for notification using <code>addListener()</code>.
The argument to <code>addListener()</code>
is always a function that you define to handle the event,
but the parameters to the function depend on
which event you're handling.
Checking the documentation for
<a href="tabs.html#event-onCreated"><code>chrome.tabs.onCreated</code></a>,
you can see that the function has a single parameter:
a <a href="tabs.html#type-Tab">Tab</a> object
that has details about the newly created tab.
</p>
<div class="doc-family extensions">
<h2 id="declarative">Declarative Event Handlers</h2>
<p>
The declarative event handlers provide a means to define rules consisting of
declarative conditions and actions. Conditions are evaluated in the browser
rather than the JavaScript engine which reduces roundtrip latencies and allows
for very high efficiency.
</p>
<p>Declarative event handlers are used for example in the <a
href="declarativeWebRequest.html">Declarative Web Request API</a> and possibly
further extension APIs in the future. This page describes the underlying
concepts of all declarative event handlers.
</p>
<h3 id="rules">Rules</h3>
<p>The simplest possible rule consists of one or more conditions and one or more
actions:</p>
<pre>
var rule = {
conditions: [ /* my conditions */ ],
actions: [ /* my actions */ ]
};
</pre>
<p>If any of the conditions is fulfilled, all actions are executed.</p>
<p>In addition to conditions and actions you may give each rule an identifier,
which simplifies unregistering previously registered rules, and a priority to
define precedences among rules. Priorities are only considered if rules conflict
each other or need to be executed in a specific order. Actions are executed in
decendending order of the priority of their rules.</p>
<pre>
var rule = {
id: "my rule", // optional, will be generated if not set.
priority: 100, // optional, defaults to 100.
conditions: [ /* my conditions */ ],
actions: [ /* my actions */ ]
};
</pre>
<h3 id="eventobjects">Event objects</h3>
<p>
<a href="events.html">Event objects</a> may support rules. These event objects
don't call a callback function when events happen but test whether any
registered rule has at least one fulfilled condition and execute the actions
associated with this rule. Event objects supporting the declarative API have
three relevant methods: <a href="#method-addRules"><code>addRules()</code></a>,
<a href="#method-removeRules"><code>removeRules()</code></a>, and
<a href="#method-getRules"><code>getRules()</code></a>.
</p>
<h3 id="addingrules">Adding rules</h3>
<p>
To add rules call the <code>addRules()</code> function of the event object. It
takes an array of rule instances as its first parameter and a callback function
that is called on completion.
</p>
<pre>
var rule_list = [rule1, rule2, ...];
function addRules(rule_list, function callback(details) {...});
</pre>
<p>
If the rules were inserted successfully, the <code>details</code> parameter
contains an array of inserted rules appearing in the same order as in the passed
<code>rule_list</code> where the optional parameters <code>id</code> and
<code>priority</code> were filled with the generated values. If any rule is
invalid, e.g., because it contained an invalid condition or action, none of the
rules are added and the <a
href="extension.html#property-lastError">lastError</a> variable is set when
the callback function is called. Each rule in <code>rule_list</code> must
contain a unique identifier that is not currently used by another rule or an
empty identifier.
</p>
<p class="note">
<strong>Note:</strong> Rules are persistent across browsing sessions. Therefore,
you should install rules during extension installation time using the
<code><a href="runtime.html#event-onInstalled">chrome.runtime.onInstalled</a></code>
event. Note that this event is also triggered when an extension is updated.
Therefore, you should first clear previously installed rules and then register
new rules.
</p>
<h3 id="removingrules">Removing rules</h3>
<p>
To remove rules call the <code>removeRules()</code> function. It accepts an
optional array of rule identifiers as its first parameter and a callback
function as its second parameter.
</p>
<pre>
var rule_ids = ["id1", "id2", ...];
function removeRules(rule_ids, function callback() {...});
</pre>
<p>
If <code>rule_ids</code> is an array of identifiers, all rules having
identifiers listed in the array are removed. If <code>rule_ids</code> lists an
identifier, that is unknown, this identifier is silently ignored. If
<code>rule_ids</code> is <code>undefined</code>, all registered rules of this
extension are removed. The <code>callback()</code> function is called when the
rules were removed.
</p>
<h3 id="retrievingrules">Retrieving rules</h3>
<p>
To retrieve a list of currently registered rules, call the
<code>getRules()</code> function. It accepts an optional array of rule
identifiers with the same semantics as <code>removeRules</code> and a callback
function.
</p>
<pre>
var rule_ids = ["id1", "id2", ...];
function getRules(rule_ids, function callback(details) {...});
</pre>
<p>
The <code>details</code> parameter passed to the <code>calback()</code> function
refers to an array of rules including filled optional parameters.
</p>
</div>
<div class="doc-family extensions">
<h2 id="filtered">Filtered events</h2>
<p>Filtered events are a mechanism that allows listeners to specify a subset of
events that they are interested in. A listener that makes use of a filter won't
be invoked for events that don't pass the filter, which makes the listening
code more declarative and efficient - an <a href="event_pages.html">event
page</a> page need not be woken up to handle events it doesn't care
about.</p>
<p>Filtered events are intended to allow a transition from manual filtering
code like this:</p>
<pre>
chrome.webNavigation.onCommitted.addListener(function(e) {
if (hasHostSuffix(e.url, 'google.com') ||
hasHostSuffix(e.url, 'google.com.au')) {
// ...
}
});
</pre>
<p>into this:</p>
<pre>
chrome.webNavigation.onCommitted.addListener(function(e) {
// ...
}, {url: [{hostSuffix: 'google.com'},
{hostSuffix: 'google.com.au'}]});
</pre>
<p>Events support specific filters that are meaningful to that event. The list
of filters that an event supports will be listed in the documentation for that
event in the "filters" section.</p>
<p>When matching URLs (as in the example above), event filters support the same
URL matching capabilities as expressable with a <a
href="events.html#type-UrlFilter">UrlFilter</a>, except for scheme and port
matching.</p>
</div>
<h2 id="apiReference">API Reference: chrome.events</h2>
<div class="api_reference">
<h3 id="types">Types</h3>
<div>
<h3 id="type-Event">Event</h3>
<div>
<dt><span class="type_name"> ( <span id="typeTemplate">object</span> )</span></dt>
<dd>
An object which allows the addition and removal of listeners for a Chrome event.
</dd> <h4 id="Event-methods">
Methods of <a href="#type-Event">Event</a>
</h4>
<dd><dl> <div>
<h4 id="method-Event-addListener">addListener</h4>
<div class="summary lower">
<span>Event.addListener</span>()
</div>
<div class="description">
<p>
Registers an event listener <em>callback</em> to an event.
</p> </div>
</div>
<div>
<h4 id="method-Event-removeListener">removeListener</h4>
<div class="summary lower">
<span>Event.removeListener</span>()
</div>
<div class="description">
<p>
Deregisters an event listener <em>callback</em> from an event.
</p> </div>
</div>
<div>
<h4 id="method-Event-hasListener">hasListener</h4>
<div class="summary">
<span>boolean Event.hasListener</span>()
</div>
<div class="description">
</div>
</div>
<div>
<h4 id="method-Event-hasListeners">hasListeners</h4>
<div class="summary">
<span>boolean Event.hasListeners</span>()
</div>
<div class="description">
</div>
</div>
<div>
<h4 id="method-Event-addRules">addRules</h4>
<div class="summary lower">
<span>Event.addRules</span>(<span>array of <a href="events.html#type-Rule">Rule</a> <span class="variable">rules</span></span>)
</div>
<div class="description">
<p>
Registers rules to handle events.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-addRules-rules"></a> <dt> <span class="variable">rules</span> <span class="property"> ( <span id="typeTemplate">array of <a href="events.html#type-Rule">Rule</a></span> ) </span> </dt> <dd> Rules to be registered. These do not replace previously registered rules. </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(array of <a href="events.html#type-Rule">Rule</a> rules) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-rules"></a> <dt> <span class="variable">rules</span> <span class="property"> ( <span id="typeTemplate">array of <a href="events.html#type-Rule">Rule</a></span> ) </span> </dt> <dd> Rules that were registered, the optional parameters are filled with values. </dd></div></dl>
</div>
</div>
<div>
<h4 id="method-Event-getRules">getRules</h4>
<div class="summary lower">
<span>Event.getRules</span>(<span class="optional">array of string <span class="variable">ruleIdentifiers</span></span>)
</div>
<div class="description">
<p>
Returns currently registered rules.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-getRules-ruleIdentifiers"></a> <dt> <span class="variable">ruleIdentifiers</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">array of string</span> ) </span> </dt> <dd> If an array is passed, only rules with identifiers contained in this array are returned. </dd></div>
</dl>
<h4>Callback function</h4><p> The <em>callback</em> parameter should specify a function that looks like this:</p><pre>function(array of <a href="events.html#type-Rule">Rule</a> rules) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-rules"></a> <dt> <span class="variable">rules</span> <span class="property"> ( <span id="typeTemplate">array of <a href="events.html#type-Rule">Rule</a></span> ) </span> </dt> <dd> Rules that were registered, the optional parameters are filled with values. </dd></div></dl>
</div>
</div>
<div>
<h4 id="method-Event-removeRules">removeRules</h4>
<div class="summary lower">
<span>Event.removeRules</span>(<span class="optional">array of string <span class="variable">ruleIdentifiers</span></span>)
</div>
<div class="description">
<p>
Unregisters currently registered rules.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-removeRules-ruleIdentifiers"></a> <dt> <span class="variable">ruleIdentifiers</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">array of string</span> ) </span> </dt> <dd> If an array is passed, only rules with identifiers contained in this array are unregistered. </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function() <span class="subdued">{...}</span>;</pre><dl> </dl>
</div>
</div>
</dl></dd>
</div>
</div>
<div>
<h3 id="type-Rule">Rule</h3>
<div>
<dt><span class="type_name"> ( <span id="typeTemplate">object</span> )</span></dt>
<dd>
Description of a declarative rule for handling events.
</dd> <h4 id="Rule-properties">
Properties of <a href="#type-Rule">Rule</a>
</h4>
<dd><dl> <div>
<a name="property-Rule-id"></a>
<dt>
<span class="variable">id</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Optional identifier that allows referencing this rule.
</dd>
</div>
<div>
<a name="property-Rule-conditions"></a>
<dt>
<span class="variable">conditions</span>
<span class="property">
(
<span id="typeTemplate">array of any</span>
)
</span>
</dt>
<dd>
List of conditions that can trigger the actions.
</dd>
</div>
<div>
<a name="property-Rule-actions"></a>
<dt>
<span class="variable">actions</span>
<span class="property">
(
<span id="typeTemplate">array of any</span>
)
</span>
</dt>
<dd>
List of actions that are triggered if one of the condtions is fulfilled.
</dd>
</div>
<div>
<a name="property-Rule-priority"></a>
<dt>
<span class="variable">priority</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">integer</span>
)
</span>
</dt>
<dd>
Optional priority of this rule. Defaults to 100.
</dd>
</div>
</dl></dd>
</div>
</div>
<div>
<h3 id="type-UrlFilter">UrlFilter</h3>
<div>
<dt><span class="type_name"> ( <span id="typeTemplate">object</span> )</span></dt>
<dd>
Filters URLs for various criteria. See <a href='#filtered'>event filtering</a>.
</dd> <h4 id="UrlFilter-properties">
Properties of <a href="#type-UrlFilter">UrlFilter</a>
</h4>
<dd><dl> <div>
<a name="property-UrlFilter-hostContains"></a>
<dt>
<span class="variable">hostContains</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the host name of the URL contains a specified string. To test whether a host name component has a prefix 'foo', use hostContains: '.foo'. This matches 'www.foobar.com' and 'foo.com', because an implicit dot is added at the beginning of the host name. Similarly, hostContains can be used to match against component suffix ('foo.') and to exactly match against components ('.foo.'). Suffix- and exact-matching for the last components need to be done separately using hostSuffix, because no implicit dot is added at the end of the host name.
</dd>
</div>
<div>
<a name="property-UrlFilter-hostEquals"></a>
<dt>
<span class="variable">hostEquals</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the host name of the URL is equal to a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-hostPrefix"></a>
<dt>
<span class="variable">hostPrefix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the host name of the URL starts with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-hostSuffix"></a>
<dt>
<span class="variable">hostSuffix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the host name of the URL ends with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-pathContains"></a>
<dt>
<span class="variable">pathContains</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the path segment of the URL contains a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-pathEquals"></a>
<dt>
<span class="variable">pathEquals</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the path segment of the URL is equal to a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-pathPrefix"></a>
<dt>
<span class="variable">pathPrefix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the path segment of the URL starts with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-pathSuffix"></a>
<dt>
<span class="variable">pathSuffix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the path segment of the URL ends with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-queryContains"></a>
<dt>
<span class="variable">queryContains</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the query segment of the URL contains a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-queryEquals"></a>
<dt>
<span class="variable">queryEquals</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the query segment of the URL is equal to a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-queryPrefix"></a>
<dt>
<span class="variable">queryPrefix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the query segment of the URL starts with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-querySuffix"></a>
<dt>
<span class="variable">querySuffix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the query segment of the URL ends with a specified string.
</dd>
</div>
<div>
<a name="property-UrlFilter-urlContains"></a>
<dt>
<span class="variable">urlContains</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number.
</dd>
</div>
<div>
<a name="property-UrlFilter-urlEquals"></a>
<dt>
<span class="variable">urlEquals</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number.
</dd>
</div>
<div>
<a name="property-UrlFilter-urlMatches"></a>
<dt>
<span class="variable">urlMatches</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the URL (without fragment identifier) matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the <a href="http://code.google.com/p/re2/wiki/Syntax">RE2 syntax</a>.
</dd>
</div>
<div>
<a name="property-UrlFilter-urlPrefix"></a>
<dt>
<span class="variable">urlPrefix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number.
</dd>
</div>
<div>
<a name="property-UrlFilter-urlSuffix"></a>
<dt>
<span class="variable">urlSuffix</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number.
</dd>
</div>
<div>
<a name="property-UrlFilter-schemes"></a>
<dt>
<span class="variable">schemes</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">array of string</span>
)
</span>
</dt>
<dd>
Matches if the scheme of the URL is equal to any of the schemes specified in the array.
</dd>
</div>
<div>
<a name="property-UrlFilter-ports"></a>
<dt>
<span class="variable">ports</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">array of integer or array of integer</span>
)
</span>
</dt>
<dd>
Matches if the port of the URL is contained in any of the specified port lists. For example <code>[80, 443, [1000, 1200]]</code> matches all requests on port 80, 443 and in the range 1000-1200.
</dd>
</div>
</dl></dd>
</div>
</div>
</div>
</div>
</div>
</body>
<script>
window.bootstrap = {
api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
[{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
};
</script>
<div id="gc-footer">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2012 Google
</p>
<script src="stable/static/js/branch.js" type="text/javascript"></script>
<script src="stable/static/js/sidebar.js" type="text/javascript"></script>
<script src="stable/static/js/prettify.js" type="text/javascript"></script>
<script>
(function() {
// Auto syntax highlight all pre tags.
var preElements = document.getElementsByTagName('pre');
for (var i = 0; i < preElements.length; i++)
preElements[i].classList.add('prettyprint');
prettyPrint();
})();
</script>
<div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
</div>
</div>
</html>