history.onVisitRemoved
Fired when a page is removed completely from the browser history.
- If all visits to a single page are removed (for example, using
history.deleteUrl
), then this event is fired once. - If a range of visits is removed (for example, using
history.deleteRange
or a browser feature like "Clear Recent History"), then it is fired once for each page whose visits all fall within the cleared range. - If the browser's entire history is cleared (for example, using
history.deleteAll
), then it is fired only once.
Syntax
browser.history.onVisitRemoved.addListener(listener)
browser.history.onVisitRemoved.removeListener(listener)
browser.history.onVisitRemoved.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)
- Check whether
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
callback
-
Function that will be called when this event occurs. The function will be passed the following argument:
removed
object
. Details of the removal. This is an object containing two properties: a booleanallHistory
and an arrayurls
.-
- If this event is firing because all history was cleared,
allHistory
will betrue
andurls
will be an empty array. - Otherwise,
allHistory
will befalse
andurls
will contain one item, which is the URL of the removed page.
- If this event is firing because all history was cleared,
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
onVisitRemoved | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support50 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
function onRemoved(removed) {
if (removed.allHistory) {
console.log("All history removed");
} else if (removed.urls.length) {
console.log("URL removed: " + removed.urls[0]);
}
}
browser.history.onVisitRemoved.addListener(onRemoved);
Acknowledgements
This API is based on Chromium's chrome.history
API. This documentation is derived from history.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.