nsIBrowserHistory

Implemented by: @mozilla.org/browser/nav-history-service;1. To use this service, use:

var browserHistory = Components.classes["@mozilla.org/browser/nav-history-service;1"]
                     .getService(Components.interfaces.nsIBrowserHistory);

Method overview

Attributes

Methods

This method adds a page to the history with specific time stamp information. It is called by history importing code and is used in the History migration tool.

void addPageWithDetails(
  in nsIURI aURI,
  in wstring aTitle,
  in long long aLastVisited
);

Parameters

aURI

The page that will be added to the history.

aTitle

The title of the page.

aLastVisited

When the page was last visited, in microseconds since the Unix epoch.

Designates the specified URL as coming from a link explicitly followed by the user (for example by clicking on it).

void markPageAsFollowedLink(
  in nsIURI aURI
);

Parameters

aURI

The URL that is to be marked as explicitly followed by the user.

This method designates the URL as having been explicitly typed in by the user, so it can be used as an autocomplete result. It is called by the URL bar when the user types in a URL. This can be and is called before the page is actually added to history, since the page isn't added until it actually starts loading. The typed flag affects the URL bar autocomplete. This will cause the transition type of the next visit of the URL to be marked as "typed."

void markPageAsTyped(
  in nsIURI aURI
);

Parameters

aURI

The page that is to be marked as typed by the user.

Mark a page as being currently open.

void registerOpenPage(
  in nsIURI aURI
);

Parameters

aURI

The page that is to be marked as currently open.

removeAllPages()

This method removes all the pages from the global history.

void removeAllPages();

Parameters

None.

Remarks

Visits are removed synchronously, but pages are expired asynchronously, off the main thread.

removePage()

This method removes all visits for a page from the history. The page itself is only deleted when it is not bookmarked and when it is not a place: URI. This method is called by the UI when the user deletes a history entry.

void removePage(
  in nsIURI aURI
);

Parameters

aURI

The added page which is to be removed.

Removes multiple pages from history using a batch.

void removePages(
  [array, size_is(aLength)] in nsIURI aURIs,
  in unsigned long aLength,
  in boolean aDoBatchNotify /* parameter removed in Gecko 9.0 */
);

Parameters

aURIs

An array of page URIs to be removed from history.

aLength

The number of pages listed in the aURIs array.

aDoBatchNotify Obsolete since Gecko 9.0

If set to true, the BeginUpdateBatch and EndUpdateBatch events are sent; otherwise, no notification of changes to the history is provided.  This parameter was removed in Gecko 9.0.

Removes all pages within the given timeframe, using a batch.

void removePagesByTimeframe(
  in long long aBeginTime,
  in long long aEndTime
);

Parameters

aBeginTime

The time of the first page to remove, in microseconds from epoch.

aEndTime

The time of the last page to remove, in microseconds from epoch.

removePagesFromHost()

This method removes all the pages from the given host. It is called from the UI when the user deletes a group associated with a host or domain. This method lets you delete pages from a specific host, or pages from all hosts in a given domain.

If aEntireDomain is true, it will assume aHost is a domain, and remove all pages from the entire domain.

void removePagesFromHost(
  in AUTF8String aHost,
  in boolean aEntireDomain
);

Parameters

aHost

The name of the host to be removed. An empty value for this parameter means local files and anything else without a hostname. You can also pass in the localized "(local files)" title given to you by a history query to remove all history information for local files.

aEntireDomain

If set to true, it will assume aHost is a domain, and remove all pages from the entire domain, including subdomains. Set to false otherwise.

Removes all visits within the given timeframe, using a batch. Any pages that become unvisited as a result are also deleted.

void removeVisitsByTimeframe(
  in long long aBeginTime,
  in long long aEndTime
);

Parameters

aBeginTime

The time of the first page to remove, in microseconds from epoch.

aEndTime

The time of the last page to remove, in microseconds from epoch.

Mark a page as no longer being open (either by closing the window or tab, or by navigating away from that page).

void unregisterOpenPage(
  in nsIURI aURI
);

Parameters

aURI

The page to unregister as an open page.

See also

• Places
• Using the Places history service
• nsIGlobalHistory2