Path: blob/main/files/en-us/mozilla/add-ons/webextensions/api/management/uninstall/index.md
6581 views
------{{AddonSidebar()}}
Uninstalls an add-on, given its ID.
This API requires the "management" API permission.
This is an asynchronous function that returns a Promise.
Syntax
Parameters
id:
string. ID of the add-on to uninstall.
options{{optional_inline}}:
object. Object which may contain a single property,showConfirmDialog. IfshowConfirmDialogistrue, the browser will show a dialog asking the user to confirm that the add-on should be uninstalled.
If
idis the calling add-on's ID,showConfirmDialogdefaults tofalse.If
idis a the ID of a different add-on, theshowConfirmDialogoption 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
{{Compat}}
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.
{{WebExtExamples}}
Note: This API is based on Chromium's
chrome.managementAPI. This documentation is derived frommanagement.jsonin the Chromium code.