summaryrefslogtreecommitdiffstats
path: root/toolkit/components/messaging-system/schemas/TriggerActionSchemas/TriggerActionSchemas.json
blob: 6a7d2328d7a33eff5c7d4afb3c088a15e6003981 (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
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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/TriggerActionSchemas",
  "definitions": {
    "TriggerActionSchemas": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["openURL"]
            },
            "params": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of urls we should match against"
            },
            "patterns": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of Match pattern compatible strings to match against"
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens every time the user loads a new URL that matches the provided `hosts` or `patterns`"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["openArticleURL"]
            },
            "params": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of urls we should match against"
            },
            "patterns": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of Match pattern compatible strings to match against"
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens every time the user loads a document that is Reader Mode compatible"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["openBookmarkedURL"]
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens every time the user adds a bookmark from the URL bar star icon"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["frequentVisits"]
            },
            "params": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of urls we should match against"
            },
            "patterns": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of Match pattern compatible strings to match against"
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens every time a user navigates (or switches tab to) to any of the `hosts` or `patterns` arguments but additionally provides information about the number of accesses to the matched domain."
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["newSavedLogin"]
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens every time the user adds or updates a login"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["formAutofill"]
            }
          },
          "required": ["id"],
          "additionalProperties": false,
          "description": "Happens when the user saves, updates, or uses a credit card or address for form autofill"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["contentBlocking"]
            },
            "params": {
              "type": "array",
              "items": {
                "type": ["string", "integer"],
                "description": "Events that should trigger this message. String values correspond to ContentBlockingMilestone events and number values correspond to STATE_BLOCKED_* flags on nsIWebProgressListener."
              }
            }
          },
          "required": ["id", "params"],
          "additionalProperties": false,
          "description": "Happens every time Firefox blocks the loading of a page script/asset/resource that matches the one of the tracking behaviours specifid through params. See https://searchfox.org/mozilla-central/rev/8ccea36c4fb09412609fb738c722830d7098602b/uriloader/base/nsIWebProgressListener.idl#336"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["defaultBrowserCheck"]
            },
            "context": {
              "type": "object",
              "properties": {
                "source": {
                  "type": "string",
                  "enum": ["newtab"],
                  "description": "When the source of the trigger is home/newtab"
                },
                "willShowDefaultPrompt": {
                  "type": "boolean",
                  "description": "When the source of the trigger is startup"
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when starting the browser or navigating to about:home/newtab"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["captivePortalLogin"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when the user successfully goes through a captive portal authentication flow."
        },
        {
          "description": "Notify when a preference is added, removed or modified",
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["preferenceObserver"]
            },
            "params": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "Preference names to observe."
              }
            }
          },
          "additionalProperties": false,
          "required": ["id", "params"]
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["featureCalloutCheck"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Used to display Feature Callouts in Firefox View. Can only be used for Feature Callouts."
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["pdfJsFeatureCalloutCheck"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Used to display Feature Callouts on PDF.js pages. Can only be used for Feature Callouts."
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["nthTabClosed"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when the user closes n or more tabs in a session"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["activityAfterIdle"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when the user resumes activity after n milliseconds of inactivity (keyboard/mouse interactions and audio playback all count as activity)"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["cookieBannerDetected"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when Firefox detects a cookie consent banner that could otherwise be handled by Cookie Banner Handling"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["cookieBannerHandled"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when Firefox automatically engages with a cookie consent banner"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["messagesLoaded"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens as soon as a message is loaded"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": ["pageActionInUrlbar"]
            }
          },
          "additionalProperties": false,
          "required": ["id"],
          "description": "Happens when a page action appears in the urlbar. The specific page action(s) to watch can be specified by id in the targeting expression."
        }
      ]
    }
  }
}