management.setEnabled()
Enables or disables the given add-on.
This function must usually be called in the context of a user action, such as the click handler for a button. The browser may also ask the user to confirm the change.
This API requires the "management" API permission.
It is an asynchronous function that returns a Promise
.
The function allows enabling/disabling of theme addons, but will return an error if used to enable or disable other types of web extension.
Syntax
var settingEnabled = browser.management.setEnabled(
id, // string
enabled // boolean
)
Parameters
Return value
A Promise
that will be fulfilled with no arguments when the add-on has been disabled or enabled.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
setEnabled | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support55
| OperaFull supportYes | SafariNo supportNo | Firefox for AndroidFull support55
|
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
Examples
Toggle enable/disable for the add-on whose ID is "my-add-on":
var id = "my-add-on";
function toggleEnabled(id) {
var getting = browser.management.get(id);
getting.then((info) => {
browser.management.setEnabled(id, !info.enabled);
});
}
toggleEnabled(id);
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.