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
|
[
{
"namespace": "manifest",
"types": [
{
"$extend": "OptionalPermission",
"choices": [
{
"type": "string",
"enum": ["management"]
}
]
}
]
},
{
"namespace": "management",
"description": "The <code>browser.management</code> API provides ways to manage the list of extensions that are installed and running.",
"types": [
{
"id": "IconInfo",
"description": "Information about an icon belonging to an extension.",
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16."
},
"url": {
"type": "string",
"description": "The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append <code>?grayscale=true</code> to the URL."
}
}
},
{
"id": "ExtensionDisabledReason",
"description": "A reason the item is disabled.",
"type": "string",
"enum": ["unknown", "permissions_increase"]
},
{
"id": "ExtensionType",
"description": "The type of this extension, 'extension' or 'theme'.",
"type": "string",
"enum": ["extension", "theme"]
},
{
"id": "ExtensionInstallType",
"description": "How the extension was installed. One of<br><var>development</var>: The extension was loaded unpacked in developer mode,<br><var>normal</var>: The extension was installed normally via an .xpi file,<br><var>sideload</var>: The extension was installed by other software on the machine,<br><var>admin</var>: The extension was installed by policy,<br><var>other</var>: The extension was installed by other means.",
"type": "string",
"enum": ["development", "normal", "sideload", "admin", "other"]
},
{
"id": "ExtensionInfo",
"description": "Information about an installed extension.",
"type": "object",
"properties": {
"id": {
"description": "The extension's unique identifier.",
"type": "string"
},
"name": {
"description": "The name of this extension.",
"type": "string"
},
"shortName": {
"description": "A short version of the name of this extension.",
"type": "string",
"optional": true
},
"description": {
"description": "The description of this extension.",
"type": "string"
},
"version": {
"description": "The <a href='manifest/version'>version</a> of this extension.",
"type": "string"
},
"versionName": {
"description": "The <a href='manifest/version#version_name'>version name</a> of this extension if the manifest specified one.",
"type": "string",
"optional": true
},
"mayDisable": {
"description": "Whether this extension can be disabled or uninstalled by the user.",
"type": "boolean"
},
"enabled": {
"description": "Whether it is currently enabled or disabled.",
"type": "boolean"
},
"disabledReason": {
"description": "A reason the item is disabled.",
"$ref": "ExtensionDisabledReason",
"optional": true
},
"type": {
"description": "The type of this extension, 'extension' or 'theme'.",
"$ref": "ExtensionType"
},
"homepageUrl": {
"description": "The URL of the homepage of this extension.",
"type": "string",
"optional": true
},
"updateUrl": {
"description": "The update URL of this extension.",
"type": "string",
"optional": true
},
"optionsUrl": {
"description": "The url for the item's options page, if it has one.",
"type": "string"
},
"icons": {
"description": "A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smaller than what was declared, so you might consider using explicit width and height attributes on img tags referencing these images. See the <a href='manifest/icons'>manifest documentation on icons</a> for more details.",
"type": "array",
"optional": true,
"items": {
"$ref": "IconInfo"
}
},
"permissions": {
"description": "Returns a list of API based permissions.",
"type": "array",
"optional": true,
"items": {
"type": "string"
}
},
"hostPermissions": {
"description": "Returns a list of host based permissions.",
"type": "array",
"optional": true,
"items": {
"type": "string"
}
},
"installType": {
"description": "How the extension was installed.",
"$ref": "ExtensionInstallType"
}
}
}
],
"functions": [
{
"name": "getAll",
"type": "function",
"permissions": ["management"],
"description": "Returns a list of information about installed extensions.",
"async": "callback",
"parameters": [
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": [
{
"type": "array",
"name": "result",
"items": {
"$ref": "ExtensionInfo"
}
}
]
}
]
},
{
"name": "get",
"type": "function",
"permissions": ["management"],
"description": "Returns information about the installed extension that has the given ID.",
"async": "callback",
"parameters": [
{
"name": "id",
"$ref": "manifest.ExtensionID",
"description": "The ID from an item of $(ref:management.ExtensionInfo)."
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": [
{
"name": "result",
"$ref": "ExtensionInfo"
}
]
}
]
},
{
"name": "install",
"type": "function",
"requireUserInput": true,
"permissions": ["management"],
"description": "Installs and enables a theme extension from the given url.",
"async": "callback",
"parameters": [
{
"name": "options",
"type": "object",
"properties": {
"url": {
"$ref": "manifest.HttpURL",
"description": "URL pointing to the XPI file on addons.mozilla.org or similar."
},
"hash": {
"type": "string",
"optional": true,
"pattern": "^(sha256|sha512):[0-9a-fA-F]{64,128}$",
"description": "A hash of the XPI file, using sha256 or stronger."
}
}
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": [
{
"name": "result",
"type": "object",
"properties": {
"id": {
"$ref": "manifest.ExtensionID"
}
}
}
]
}
]
},
{
"name": "getSelf",
"type": "function",
"description": "Returns information about the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.",
"async": "callback",
"parameters": [
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "result",
"$ref": "ExtensionInfo"
}
]
}
]
},
{
"name": "uninstallSelf",
"type": "function",
"description": "Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.",
"async": "callback",
"parameters": [
{
"type": "object",
"name": "options",
"optional": true,
"properties": {
"showConfirmDialog": {
"type": "boolean",
"optional": true,
"description": "Whether or not a confirm-uninstall dialog should prompt the user. Defaults to false."
},
"dialogMessage": {
"type": "string",
"optional": true,
"description": "The message to display to a user when being asked to confirm removal of the extension."
}
}
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": []
}
]
},
{
"name": "setEnabled",
"type": "function",
"permissions": ["management"],
"description": "Enables or disables the given add-on.",
"async": "callback",
"parameters": [
{
"name": "id",
"type": "string",
"description": "ID of the add-on to enable/disable."
},
{
"name": "enabled",
"type": "boolean",
"description": "Whether to enable or disable the add-on."
},
{
"name": "callback",
"type": "function",
"optional": true,
"parameters": []
}
]
}
],
"events": [
{
"name": "onDisabled",
"type": "function",
"permissions": ["management"],
"description": "Fired when an addon has been disabled.",
"parameters": [
{
"name": "info",
"$ref": "ExtensionInfo"
}
]
},
{
"name": "onEnabled",
"type": "function",
"permissions": ["management"],
"description": "Fired when an addon has been enabled.",
"parameters": [
{
"name": "info",
"$ref": "ExtensionInfo"
}
]
},
{
"name": "onInstalled",
"type": "function",
"permissions": ["management"],
"description": "Fired when an addon has been installed.",
"parameters": [
{
"name": "info",
"$ref": "ExtensionInfo"
}
]
},
{
"name": "onUninstalled",
"type": "function",
"permissions": ["management"],
"description": "Fired when an addon has been uninstalled.",
"parameters": [
{
"name": "info",
"$ref": "ExtensionInfo"
}
]
}
]
}
]
|
