runtime.onStartup

Fired when a profile that has this extension installed first starts up. This event is not fired when a private browsing/incognito profile is started, even if this extension is operating in 'split' incognito mode.

Syntax

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

Event Functions

All events have three functions:

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

Parameters

The only parameter is listener, used for any of the above functions.

listener

A function that will be called when this event occurs.

Browser compatibility

BCD tables only load in the browser

Examples

Open https://giphy.com/explore/cat when the browser starts up:

function handleStartup() {
  browser.tabs.create({
    url: "https://giphy.com/explore/cat"
  });
}

browser.runtime.onStartup.addListener(handleStartup);

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.