history.onVisited
Fired each time the user visits a page. A history.HistoryItem
object is passed to the listener. This event fires before the page has loaded.
Syntax
browser.history.onVisited.addListener(listener) browser.history.onVisited.removeListener(listener) browser.history.onVisited.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 arguments:
result
-
history.HistoryItem
. An object representing the item in the browser's history.At the time that this event is sent, the browser doesn't yet know the title of the page. If the browser has visited this page before and has remembered its old title, then the
HistoryItem.title
object will contain the old title of the page. If the browser doesn't have a record of the page's old title, thenHistoryItem.title
will be empty. To get the titles of pages as soon as they are known, listen forhistory.onTitleChanged
.
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
onVisited |
Yes |
79 |
50
Before version 56, the result object's 'title' was always an empty string. From version 56 onwards, it is set to the last known title, if that is available, or an empty string otherwise.
|
? |
Yes |
No |
? |
? |
No |
? |
? |
? |
Examples
Listen for visits, and log the URL and visit time.
function onVisited(historyItem) { console.log(historyItem.url); console.log(new Date(historyItem.lastVisitTime)); } browser.history.onVisited.addListener(onVisited);
Note: 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.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history/onVisited