runtime.onSuspend
Sent to the event page just before it is unloaded. This gives the extension an opportunity to do some cleanup. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete.
Note:
If something prevents the event page from being unloaded, the runtime.onSuspendCanceled event will be sent and the page won't be unloaded.
Syntax
browser.runtime.onSuspend.addListener(listener)
browser.runtime.onSuspend.removeListener(listener)
browser.runtime.onSuspend.hasListener(listener)
Events have three functions:
addListener(listener)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Checks whether a
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener-
The function called when this event occurs.
Examples
Listen for suspend events:
function handleSuspend() {
console.log("Suspending event page");
// handle cleanup
}
browser.runtime.onSuspend.addListener(handleSuspend);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
onSuspend
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- See implementation notes.
Note:
This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.json in the Chromium code.