Revision 1131261 of management.setEnabled()

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

<p>Enables or disables the given add-on.</p>

<p>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.</p>

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

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

<pre class="syntaxbox brush:js">
chrome.management.setEnabled(
  id,              // string
  enabled,         // boolean
  function() {...} // function
)
</pre>

<p>This API is also available as <code>browser.management.setEnabled()</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 enable/disable.</dd>
 <dt><code>enabled</code></dt>
 <dd><code>boolean</code>. Whether to enable or disable the add-on.</dd>
</dl>

<dl>
 <dt><code>callback{{optional_inline}}</code></dt>
 <dd><code>function</code>. Called when the add-on has been enabled or disable. The function is passed no arguments.</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>Toggle enable/disable for the add-on whose ID is "my-add-on":</p>

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

function toggleEnabled(id) {
  chrome.management.get(id, (info) =&gt; {
    chrome.management.setEnabled(id, !info.enabled);
  });
}

toggleEnabled(id);
</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-setEnabled"><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>