Docs4dev
Docs
web_extensions / latest / api / management.html

management

Get information about installed add-ons.

With the management API you can:

  • get information about installed add-ons
  • enable/disable add-ons
  • uninstall add-ons
  • find out which permission warnings are given for particular add-ons or manifests
  • get notifications of add-ons being installed, uninstalled, enabled, or disabled.

Most of these operations require the "management" API permission. Operations that don't provide access to other add-ons don't require this permission.

Types

management.ExtensionInfo

An object that contains information about an installed add-on.

Functions

management.getAll()

Returns information about all installed add-ons.

management.get()

Returns information about a particular add-on, given its ID.

management.getSelf()

Returns information about the calling add-on.

management.install()

Installs a particular theme, given its URL at addons.mozilla.org.

management.uninstall()

Uninstalls a particular add-on, given its ID.

management.uninstallSelf()

Uninstalls the calling add-on.

management.getPermissionWarningsById()

Get the set of permission warnings for a particular add-on, given its ID.

management.getPermissionWarningsByManifest()

Get the set of permission warnings that would be displayed for the given manifest string.

management.setEnabled()

Enable/disable a particular add-on, given its ID.

Events

management.onInstalled

Fired when an add-on is installed.

management.onUninstalled

Fired when an add-on is uninstalled.

management.onEnabled

Fired when an add-on is enabled.

management.onDisabled

Fired when an add-on is disabled.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
ExtensionInfo Yes 79 51 ? Yes No ? ? 51 ? No ?
get Yes 79 56 ? Yes No ? ? 56 ? No ?
getAll Yes 79
55Before version 56, only extensions whose 'type' is 'theme' are returned.
? Yes No ? ?
55Before version 56, only extensions whose 'type' is 'theme' are returned.
? No ?
getPermissionWarningsById Yes 79 No ? Yes No ? ? No ? No ?
getPermissionWarningsByManifest Yes 79 No ? Yes No ? ? No ? No ?
getSelf Yes 79 51 ? No No ? ? 51 ? No ?
install No No
63The installable file pointed to by url must be a theme, and not a normal browser extension.
? No No ? ?
63The installable file pointed to by url must be a theme, and not a normal browser extension.
? No ?
onDisabled Yes 79
55Before version 56, only extensions whose type is 'theme' are supported.
? Yes No ? ?
55Before version 56, only extensions whose type is 'theme' are supported.
? No ?
onEnabled Yes 79
55Before version 56, only extensions whose type is 'theme' are supported.
? Yes No ? ?
55Before version 56, only extensions whose type is 'theme' are supported.
? No ?
onInstalled Yes 79
55Before version 56, only extensions whose type is 'theme' are supported.
? Yes No ? ?
55Before version 56, only extensions whose type is 'theme' are supported.
? No ?
onUninstalled Yes 79
55["Before version 56, only extensions whose type is 'theme' are supported.", "This event is not fired when the extension is in the \"pending uninstall\" state. The event is fired as expected once the extension is completely removed (for example, when the about:addons tab is closed)."]
? Yes No ? ?
55["Before version 56, only extensions whose type is 'theme' are supported.", "This event is not fired when the extension is in the \"pending uninstall\" state. The event is fired as expected once the extension is completely removed (for example, when the about:addons tab is closed)."]
? No ?
setEnabled Yes 79
55Only extensions whose 'type' is 'theme' can be enabled and disabled.
? Yes No ? ?
55Only extensions whose 'type' is 'theme' can be enabled and disabled.
? No ?
uninstall Yes 79 No ? Yes No ? ? No ? No ?
uninstallSelf Yes 79 51 ? Yes No ? ? 51 ? No ?

Example extensions

Note: This API is based on Chromium's chrome.management API. This documentation is derived from management.json in the Chromium code.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/management