Fired when the extension is first installed, when the extension is updated to a new version, and when the browser is updated to a new version.
Note that runtime.onInstalled
is not the same as management.onInstalled
. The runtime.onInstalled
event is fired only for your extension. The browser.management.onInstalled
event is fired for any extensions.
Syntax
browser.runtime.onInstalled.addListener(listener) browser.runtime.onInstalled.removeListener(listener) browser.runtime.onInstalled.hasListener(listener)
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. Returnstrue
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 arguments:
details
- An object with the following properties:
-
id
Optionalstring
. The ID of the imported shared module extension that updated. This is present only if thereason
value isshared_module_update
.previousVersion
Optionalstring
. The previous version of the extension that was just updated. This is present only if thereason
value isupdate
.reason
- An
runtime.OnInstalledReason
value stating the reason that this event is being dispatched. temporary
boolean
. True if the add-on was installed temporarily (for example, using the "about:debugging" page in Firefox). False otherwise.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | 22 | Yes | 52 1 | 52 1 | 15 |
details.id | 22 | Yes | No | No | 15 |
details.previousVersion | 22 | Yes | 55 | 55 | 15 |
details.reason | 22 | Yes | 52 | 52 | 15 |
details.temporary | No | No | 55 | 55 | No |
Examples
When the extension is installed, log the install reason and open http://chilloutandwatchsomecatgifs.com/:
function handleInstalled(details) { console.log(details.reason); browser.tabs.create({ url: "http://chilloutandwatchsomecatgifs.com/" }); } browser.runtime.onInstalled.addListener(handleInstalled);
This API is based on Chromium's chrome.runtime
API. This documentation is derived from runtime.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.
// 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.