W3cubDocs

/Web Extensions

management.uninstall()

Uninstalls an add-on, given its ID.

This API requires the "management" API permission.

This is an asynchronous function that returns a Promise.

Syntax

var uninstalling = browser.management.uninstall(
  id,                  // string
  options              // object
)

Parameters

id
string. ID of the add-on to uninstall.
optionsOptional
object. Object which may contain a single property, showConfirmDialog. If showConfirmDialog is true, the browser will show a dialog asking the user to confirm that the add-on should be uninstalled.
  • If id is the calling add-on's ID, showConfirmDialog defaults to false.
  • If id is a the ID of a different add-on, this option is ignored and the confirmation dialog is always shown.

Return value

A Promise that will be rejected with an error message if the user canceled uninstall.

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
uninstall
Yes
79
No
?
Yes
No
?
?
No
?
?
?

Examples

Uninstall the add-on whose ID is "my-addon-id", 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.

var id = "my-addon-id";

function onCanceled(error) {
  console.log(`Uninstall canceled: ${error}`);
}

var uninstalling = browser.management.uninstall(id);
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.

© 2005–2021 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/uninstall