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 1131247 of management.onDisabled()

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

Revision Content

{{AddonSidebar()}}

Fired when an add-on is disabled.

This API requires the "management" API permission.

Syntax

chrome.management.onDisabled.addListener(function(
  info // object
) {...})
chrome.management.onDisabled.removeListener(listener)
chrome.management.onDisabled.hasListener(listener)

This API is also available as browser.management.onDisabled.*.

Events have three functions:

addListener(callback)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Checks whether a listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

function

Callback function that will be called when this event occurs. The function will be passed the following argument:

info
ExtensionInfo: info about the add-on that was disabled.

Browser compatibility

{{WebExtBrowserCompat}}

Examples

Log the names of add-ons when they are disabled:

chrome.management.onDisabled.addListener((info) => {
  console.log(info.name + " was disabled");
});

{{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>Fired when an add-on is disabled.</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.onDisabled.addListener(function(
  info // object
) {...})
chrome.management.onDisabled.removeListener(listener)
chrome.management.onDisabled.hasListener(listener)
</pre>

<p>This API is also available as <code>browser.management.onDisabled.*</code>.</p>

<p>Events have three functions:</p>

<dl>
 <dt><code>addListener(callback)</code></dt>
 <dd>Adds a listener to this event.</dd>
 <dt><code>removeListener(listener)</code></dt>
 <dd>Stop listening to this event. The <code>listener</code> argument is the listener to remove.</dd>
 <dt><code>hasListener(listener)</code></dt>
 <dd>Checks whether a <code>listener</code> is registered for this event. Returns <code>true</code> if it is listening, <code>false</code> otherwise.</dd>
</dl>

<h2 id="addListener_syntax">addListener syntax</h2>

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

<dl>
 <dt><code>function</code></dt>
 <dd>
 <p>Callback function that will be called when this event occurs. The function will be passed the following argument:</p>

 <dl class="reference-values">
  <dt><code>info</code></dt>
  <dd><code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/management/ExtensionInfo">ExtensionInfo</a></code>: info about the add-on that was disabled.</dd>
 </dl>
 </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>Log the names of add-ons when they are disabled:</p>

<pre class="brush: js">
chrome.management.onDisabled.addListener((info) =&gt; {
&nbsp; console.log(info.name + " was disabled");
});</pre>

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

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

<p>This API is based on Chromium's <a class="external external-icon" href="https://developer.chrome.com/extensions/management#method-getSelf"><code>chrome.management</code></a> API. This documentation is derived from <a class="external external-icon" 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