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.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
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
ExtensionInfo | Yes | No | 51 * | 51 * | Yes |
get | Yes | No | 56 | 56 | Yes |
getAll | Yes | No | 55 * | 55 * | Yes |
getPermissionWarningsById | Yes | No | No | No | Yes |
getPermissionWarningsByManifest | Yes | No | No | No | Yes |
getSelf | Yes | No | 51 | 51 | No |
onDisabled | Yes | No | No | No | Yes |
onEnabled | Yes | No | No | No | Yes |
onInstalled | Yes | No | No | No | Yes |
onUninstalled | Yes | No | No | No | Yes |
setEnabled | Yes | No | 55 * | 55 * | Yes |
uninstall | Yes | No | No | No | Yes |
uninstallSelf | Yes * | No | 51 | 51 | Yes * |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
None.
Example extensions
This API is based on Chromium's chrome.management
API. This documentation is derived from management.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// Copyright 2012 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.