Public Member Functions | Public Attributes

nsIBrowserHistory Interface Reference

import "nsIBrowserHistory.idl";

Inheritance diagram for nsIBrowserHistory:
Collaboration diagram for nsIBrowserHistory:

List of all members.

Public Member Functions

void addPageWithDetails (in nsIURI aURI, in wstring aTitle, in long long aLastVisited)
 addPageWithDetails
void removePage (in nsIURI aURI)
 removePage
void removePages ([array, size_is(aLength)] in nsIURI aURIs, in unsigned long aLength, in boolean aDoBatchNotify)
 removePages
void removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain)
 removePagesFromHost
void removePagesByTimeframe (in long long aBeginTime, in long long aEndTime)
 removePagesByTimeframe
void removeVisitsByTimeframe (in long long aBeginTime, in long long aEndTime)
 removeVisitsByTimeframe
void removeAllPages ()
 removeAllPages
void hidePage (in nsIURI aURI)
 hidePage
void markPageAsTyped (in nsIURI aURI)
 markPageAsTyped

Public Attributes

readonly attribute AUTF8String lastPageVisited
 lastPageVisited
readonly attribute PRUint32 count
 count

Member Function Documentation

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

addPageWithDetails

Adds a page to history with specific time stamp information. This is used in the History migrator.

void nsIBrowserHistory::hidePage ( in nsIURI  aURI  ) 

hidePage

Hide the specified URL from being enumerated (and thus displayed in the UI) If the page hasn't been visited yet, then it will be added as if it was visited, and then marked as hidden

void nsIBrowserHistory::markPageAsTyped ( in nsIURI  aURI  ) 

markPageAsTyped

Designate the url as having been explicitly typed in by the user, so it's okay to be an autocomplete result.

void nsIBrowserHistory::removeAllPages (  ) 

removeAllPages

Remove all pages from global history

void nsIBrowserHistory::removePage ( in nsIURI  aURI  ) 

removePage

Remove a page from history

void nsIBrowserHistory::removePages ( [array, size_is(aLength)] in nsIURI  aURIs,
in unsigned long  aLength,
in boolean  aDoBatchNotify 
)

removePages

Remove a bunch of pages from history Notice that this does not call observers for performance reasons, instead setting aDoBatchNotify true will send Begin/EndUpdateBatch

void nsIBrowserHistory::removePagesByTimeframe ( in long long  aBeginTime,
in long long  aEndTime 
)

removePagesByTimeframe

Remove all pages for a given timeframe. Limits are included: aBeginTime <= timeframe <= aEndTime Notice that this does not call observers for single deleted uris, instead it will send Begin/EndUpdateBatch

void nsIBrowserHistory::removePagesFromHost ( in AUTF8String  aHost,
in boolean  aEntireDomain 
)

removePagesFromHost

Removes all history information about pages from a given host. If aEntireDomain is set, we will also delete pages from sub hosts (so if we are passed in "microsoft.com" we delete "www.microsoft.com", "msdn.microsoft.com", etc.). An empty host name means local files and anything else with no host name. You can also pass in the localized "(local files)" title given to you from a history query to remove all history information from local files.

Note that this does not call observers for single deleted uris, but will send Begin/EndUpdateBatch.

void nsIBrowserHistory::removeVisitsByTimeframe ( in long long  aBeginTime,
in long long  aEndTime 
)

removeVisitsByTimeframe

Removes all visits in a given timeframe. Limits are included: aBeginTime <= timeframe <= aEndTime. Any place that becomes unvisited as a result will also be deleted.

Note that removal is performed in batch, so observers will not be notified of individual places that are deleted. Instead they will be notified onBeginUpdateBatch and onEndUpdateBatch.


Member Data Documentation

readonly attribute PRUint32 nsIBrowserHistory::count

count

Indicate if there are entries in global history For performance reasons this does not return the real number of entries

readonly attribute AUTF8String nsIBrowserHistory::lastPageVisited

lastPageVisited

The last page that was visited in a top-level window.


The documentation for this interface was generated from the following file: