runtime.onInstalled

Fired when the add-on is first installed, when the add-on is updated to a new version, and when the browser is updated to a new version.

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. 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 arguments:

details
An object with the following properties:
reason
An runtime.OnInstalledReason value stating the reason that this event is being dispatched.
previousVersionOptional
string. Indicates the previous version of the extension that was just updated. This is present only if the reason value is update.
idOptional
string. Indicates the ID of the imported shared module extension that updated. This is present only if the reason value is shared_module_update.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes No No 33

Examples

When the add-on 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);

Acknowledgements

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,