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.
Note:
When using an event page or background service worker, the extension must add a listener to runtime.onStartup on the event page for the event page to be executed at least once per browser session.
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
listenerto the calling event. removeListener(listener)-
Stop listening to the calling event. The
listenerargument is the listener to remove. hasListener(listener)-
Checks whether a
listeneris registered for the calling event. Returnstrueif it is listening,falseotherwise.
Parameters
The only parameter is listener, used for any of the above functions.
listener-
The function called when this event occurs.
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);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
onStartup
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
Note:
This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.json in the Chromium code.