management.uninstallSelf()
Uninstalls the calling add-on.
This API does not require the "management" API permission.
This is an asynchronous function that returns a Promise
.
Syntax
let uninstallingSelf = browser.management.uninstallSelf(
options // object
)
Parameters
optionsOptional
-
object
. Object which may two properties, both optional:showConfirmDialogOptional
-
Boolean. If
showConfirmDialog
istrue
, the browser will show a dialog asking the user to confirm that the add-on should be uninstalled. Defaults tofalse
. dialogMessageOptional
-
String. An extra message that will be displayed in the confirmation dialog.
Return value
A Promise
that will be rejected with an error message if the user canceled uninstall.
Browser compatibility
BCD tables only load in the browser
Examples
Uninstall the add-on, asking the user to confirm. In the callback, check whether the user canceled uninstallation.
Note that we haven't passed a fulfillment handler because if uninstallation succeeds, the add-on is no longer around to handle it.
function onCanceled(error) {
console.log(`Canceled: ${error}`);
}
let uninstalling = browser.management.uninstallSelf({
showConfirmDialog: true
});
uninstalling.then(null, onCanceled);
The same, but also adding a custom message to the dialog:
function onCanceled(error) {
console.log(`Canceled: ${error}`);
}
let uninstalling = browser.management.uninstallSelf({
showConfirmDialog: true,
dialogMessage: "Testing self-uninstall"
});
uninstalling.then(null, onCanceled);
Note:
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.