Revision control

Line Code
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
[
  {
    "namespace": "manifest",
    "types": [{
      "$extend": "Permission",
      "choices": [{
        "type": "string",
        "enum": [
          "telemetry"
        ]
      }]
    }]
  },
  {
    "namespace": "telemetry",
    "description": "Use the <code>browser.telemetry</code> API to send telemetry data to the Mozilla Telemetry service. Restricted to Mozilla privileged webextensions.",
    "types": [{
      "id": "ScalarType",
      "type": "string",
      "enum": ["count", "string", "boolean"],
      "description": "Type of scalar: 'count' for numeric values, 'string' for string values, 'boolean' for boolean values. Maps to <code>nsITelemetry.SCALAR_TYPE_*</code>."
    }, {
      "id": "ScalarData",
      "type": "object",
      "description": "Represents registration data for a Telemetry scalar.",
      "properties": {
        "kind": {
          "$ref": "ScalarType"
        },
        "keyed": {
          "type": "boolean",
          "optional": true,
          "default": false,
          "description": "True if this is a keyed scalar."
        },
        "record_on_release": {
          "type": "boolean",
          "optional": true,
          "default": false,
          "description": "True if this data should be recorded on release."
        },
        "expired": {
          "type": "boolean",
          "optional": true,
          "default": false,
          "description": "True if this scalar entry is expired. This allows recording it without error, but it will be discarded."
        }
      }
    }, {
      "id": "EventData",
      "type": "object",
      "description": "Represents registration data for a Telemetry event.",
      "properties": {
        "methods": {
          "type": "array",
          "items": { "type": "string" },
          "description": "List of methods for this event entry."
        },
        "objects": {
          "type": "array",
          "items": { "type": "string" },
          "description": "List of objects for this event entry."
        },
        "extra_keys": {
          "type": "array",
          "items": { "type": "string" },
          "description": "List of allowed extra keys for this event entry."
        },
        "record_on_release": {
          "type": "boolean",
          "optional": true,
          "default": false,
          "description": "True if this data should be recorded on release."
        },
        "expired": {
          "type": "boolean",
          "optional": true,
          "default": false,
          "description": "True if this event entry is expired. This allows recording it without error, but it will be discarded."
        }
      }
    }],
    "permissions": [
      "telemetry",
      "mozillaAddons"
    ],
    "functions": [{
      "name": "submitPing",
      "type": "function",
      "description": "Submits a custom ping to the Telemetry back-end. See <code>submitExternalPing</code> inside TelemetryController.jsm for more details.",
      "async": true,
      "parameters": [
        {
          "name": "type",
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$",
          "description": "The type of the ping."
        },
        {
          "name": "message",
          "type": "object",
          "additionalProperties": { "type": "any" },
          "description": "The data payload for the ping."
        },
        {
          "description": "Options object.",
          "name": "options",
          "type": "object",
          "properties": {
            "addClientId": {
              "type": "boolean",
              "optional": true,
              "default": false,
              "description": "True if the ping should contain the client id."
            },
            "addEnvironment": {
              "type": "boolean",
              "optional": true,
              "default": false,
              "description": "True if the ping should contain the environment data."
            },
            "overrideEnvironment": {
              "type": "object",
              "additionalProperties": { "type": "any" },
              "optional": true,
              "default": false,
              "description": "Set to override the environment data."
            },
            "usePingSender": {
              "type": "boolean",
              "optional": true,
              "default": false,
              "description": "If true, send the ping using the PingSender."
            }
          }
        }
      ]
    },
    {
      "name": "canUpload",
      "type": "function",
      "description": "Checks if Telemetry is enabled.",
      "parameters": [],
      "async": true
    },
    {
      "name": "scalarAdd",
      "type": "function",
      "description": "Adds the value to the given scalar.",
      "async": true,
      "parameters": [
        {
          "name": "name",
          "type": "string",
          "description": "The scalar name."
        },
        {
          "name": "value",
          "type": "integer",
          "minimum": 1,
          "description": "The numeric value to add to the scalar. Only unsigned integers supported."
        }
      ]
    },
    {
      "name": "scalarSet",
      "type": "function",
      "description": "Sets the named scalar to the given value. Throws if the value type doesn't match the scalar type.",
      "async": true,
      "parameters": [
        {
          "name": "name",
          "type": "string",
          "description": "The scalar name"
        },
        {
          "name": "value",
          "description": "The value to set the scalar to",
          "choices": [
            { "type": "string" },
            { "type": "boolean" },
            { "type": "integer" },
            { "type": "object", "additionalProperties": { "type": "any" } }
          ]
        }
      ]
    },
    {
      "name": "scalarSetMaximum",
      "type": "function",
      "description": "Sets the scalar to the maximum of the current and the passed value",
      "async": true,
      "parameters": [
        {
          "name": "name",
          "type": "string",
          "description": "The scalar name."
        },
        {
          "name": "value",
          "type": "integer",
          "minimum": 0,
          "description": "The numeric value to set the scalar to. Only unsigned integers supported."
        }
      ]
    },
    {
      "name": "recordEvent",
      "type": "function",
      "description": "Record an event in Telemetry. Throws when trying to record an unknown event.",
      "async": true,
      "parameters": [
        {
          "name": "category",
          "type": "string",
          "description": "The category name."
        },
        {
          "name": "method",
          "type": "string",
          "description": "The method name."
        },
        {
          "name": "object",
          "type": "string",
          "description": "The object name."
        },
        {
          "name": "value",
          "type": "integer",
          "optional": true,
          "description": "An optional string value to record."
        },
        {
          "name": "extra",
          "type": "object",
          "optional": true,
          "description": "An optional object of the form (string -> string). It should only contain registered extra keys.",
          "additionalProperties": { "type": "string" }
        }
      ]
    },

    {
      "name": "registerScalars",
      "type": "function",
      "description": "Register new scalars to record them from addons. See nsITelemetry.idl for more details.",
      "async": true,
      "parameters": [
        {
          "name": "category",
          "type": "string",
          "description": "The unique category the scalars are registered in."
        },
        {
          "name": "data",
          "type": "object",
          "additionalProperties": { "$ref": "ScalarData" },
          "description": "An object that contains registration data for multiple scalars. Each property name is the scalar name, and the corresponding property value is an object of ScalarData type."
        }
      ]
    },
    {
      "name": "registerEvents",
      "type": "function",
      "description": "Register new events to record them from addons. See nsITelemetry.idl for more details.",
      "async": true,
      "parameters": [
        {
          "name": "category",
          "type": "string",
          "description": "The unique category the events are registered in."
        },
        {
          "name": "data",
          "type": "object",
          "additionalProperties": { "$ref": "EventData" },
          "description": "An object that contains registration data for 1+ events. Each property name is the category name, and the corresponding property value is an object of EventData type."
        }
      ]
    },
    {
      "name": "setEventRecordingEnabled",
      "type": "function",
      "description": "Enable recording of events in a category. Events default to recording disabled. This allows to toggle recording for all events in the specified category.",
      "async": true,
      "parameters": [
        {
          "name": "category",
          "type": "string",
          "description": "The category name."
        },
        {
          "name": "enabled",
          "type": "boolean",
          "description": "Whether recording is enabled for events in that category."
        }
      ]
    }]
  }
]