summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/templates/private/event.html
blob: db0b114d5b7085efe558be3d31b09fb9e130aa9a (plain)
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
{{#event}}
<div>
  <h4 id="{{id}}">{{name}}</h4>
  {{+partials.warning_deprecated item:event/}}
  <div class="description">
    {{?description}}<p>
      {{{description}}}
    </p>{{/description}}
    {{?supportsRules}}
    <p>Provides the <a href="events.html#declarative">Declarative Event API</a>
    consisting of $ref:[events.Event.addRules addRules],
    $ref:[events.Event.removeRules removeRules], and $ref:[events.Event.getRules
    getRules].</p>
    <div class="summary">
      {{+partials.function_signature function:byName.addRules
                                     parentName:name
                                     api:api/}}
      {{+partials.function_signature function:byName.removeRules
                                     parentName:name
                                     api:api/}}
      {{+partials.function_signature function:byName.getRules
                                     parentName:name
                                     api:api/}}
    </div>
    {{?conditions}}
      <h4>Supported conditions</h4>
      <ul>
        {{#c:conditions}}<div><li>{{+partials.ref_link link:c/}}</li></div>{{/}}
      </ul>
    {{/conditions}}
    {{?actions}}
      <h4>Supported actions</h4>
      <ul>
        {{#a:actions}}<div><li>{{+partials.ref_link link:a/}}</li></div>{{/}}
      </ul>
    {{/actions}}
    {{/supportsRules}}
    {{?filters}}
      <h4>Filters</h4>
      <dl>
        {{#f:filters +partials.parameter_full parameter:f/}}
      </dl>
    {{/filters}}
    {{?supportsListeners}}
      {{+partials.function function:byName.addListener
                           parentName:name
                           api:api
                           parentId:id/}}
    {{/supportsListeners}}
  </div>
</div>
{{/event}}