runtime.onInstalled

Syntax

browser.runtime.onInstalled.addListener(listener)
browser.runtime.onInstalled.removeListener(listener)
browser.runtime.onInstalled.hasListener(listener)

Events have three functions:

addListener(listener)

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

The function called when this event occurs. The function is passed these arguments:

details

An object with the following properties:

id Optional

string. The ID of the imported shared module extension that updated. This is present only if the reason value is shared_module_update.

previousVersion Optional

string. The previous version of the extension just updated. This is only present if the reason value is update.

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 or using web-ext run. False otherwise.

Examples

When the extension is installed, log the install reason and open https://example.com:

function handleInstalled(details) {
  console.log(details.reason);
  browser.tabs.create({
    url: "https://example.com",
  });
}

browser.runtime.onInstalled.addListener(handleInstalled);

Example extensions

• runtime-examples
• userScripts-mv3

Browser compatibility