Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 1131527 of management.uninstall()

  • Revision slug: Mozilla/Add-ons/WebExtensions/API/management/uninstall
  • Revision title: management.uninstall()
  • Revision id: 1131527
  • Created:
  • Creator: wbamberg
  • Is current revision? Yes
  • Comment

Revision Content

{{AddonSidebar()}}

Uninstalls an add-on, given its ID.

This API requires the "management" API permission.

Syntax

chrome.management.uninstall(
  id,                   // string
  options,              // object
  function(info) {...}  // function
)

This API is also available as browser.management.uninstall() in a version that returns a promise.

Parameters

id
string. ID of the add-on to uninstall.
options{{optional_inline}}
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.
callback{{optional_inline}}
function. Callback function. If the user canceled uninstallation, then {{WebExtAPIRef("runtime.lastError")}} will be set and you can check for it in this callback.

Browser compatibility

{{WebExtBrowserCompat}}

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.

var id = "my-addon-id";

function uninstalling() {
  if (chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
  }
}

chrome.management.uninstall(id, uninstalling);

{{WebExtExamples}}

Acknowledgements

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.

Revision Source

<div>{{AddonSidebar()}}</div>

<p>Uninstalls an add-on, given its ID.</p>

<p>This API requires the "management" <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/permissions">API permission</a>.</p>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox brush:js">
chrome.management.uninstall(
  id,                   // string
  options,              // object
  function(info) {...}  // function
)
</pre>

<p>This API is also available as <code>browser.management.uninstall()</code> in a <a href="/en-US/Add-ons/WebExtensions/Using_the_JavaScript_APIs#Callbacks_and_promises">version that returns a promise</a>.</p>

<h3 id="Parameters">Parameters</h3>

<dl>
 <dt><code>id</code></dt>
 <dd><code>string</code>. ID of the add-on to uninstall.</dd>
 <dt><code>options{{optional_inline}}</code></dt>
 <dd><code>object</code>. Object which may contain a single property, <code>showConfirmDialog</code>. If <code>showConfirmDialog</code> is <code>true</code>, the browser will show a dialog asking the user to confirm that the add-on should be uninstalled.
 <ul>
  <li>If <code>id</code> is the calling add-on's ID,&nbsp;<code>showConfirmDialog</code> defaults to <code>false</code>.</li>
  <li>If <code>id</code> is a the ID of a different add-on, this option is ignored and the confirmation dialog is always shown.</li>
 </ul>
 </dd>
</dl>

<dl>
 <dt><code>callback{{optional_inline}}</code></dt>
 <dd><code>function</code>. Callback function. If the user canceled uninstallation, then {{WebExtAPIRef("runtime.lastError")}} will be set and you can check for it in this callback.</dd>
</dl>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>

<p>{{WebExtBrowserCompat}}</p>

<h2 id="Examples">Examples</h2>

<p>Uninstall the add-on whose ID is "my-addon-id", asking the user to confirm. In the callback, check whether the user canceled uninstallation.</p>

<pre class="brush: js">
var id = "my-addon-id";

function uninstalling() {
  if (chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
  }
}

chrome.management.uninstall(id, uninstalling);</pre>

<p>{{WebExtExamples}}</p>

<div class="note"><strong>Acknowledgements</strong>

<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/management#method-uninstall"><code>chrome.management</code></a> API. This documentation is derived from <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/management.json"><code>management.json</code></a> in the Chromium code.</p>

<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>

<div class="hidden">
<pre>
// Copyright 2015 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.
</pre>
</div>
Revert to this revision