history.onVisited

{{AddonSidebar}} 

Fired each time the user visits a page. A {{WebExtAPIRef("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(listener)
  • : 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. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

• listener

  • : The function called when this event occurs. The function is passed this argument:

    • result

      • : {{WebExtAPIRef('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, then HistoryItem.title will be empty. To get the titles of pages as soon as they are known, listen for {{WebExtAPIRef("history.onTitleChanged")}} .

Browser compatibility

{{Compat}} 

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);

{{WebExtExamples}} 

[!NOTE] This API is based on Chromium’s chrome.history API. This documentation is derived from history.json in the Chromium code.