nsISHistoryInternal

Methods

addEntry(aEntry, aPersist)

Add a new Entry to the History List

Parameters

aEntry - The entry to add
aPersist - If true this specifies that the entry should persist in the list. If false, this means that when new entries are added this element will not appear in the session history list.

updateIndex()

Update the index maintained by sessionHistory

replaceEntry(aIndex, aReplaceEntry)

Replace the nsISHEntry at a particular index

Parameters

aIndex - The index at which the entry should be replaced
aReplaceEntry - The replacement entry for the index.

notifyOnHistoryReload(aReloadURI, aReloadFlags)

Notifies all registered session history listeners about an impending
reload.

Parameters

aReloadURI The URI of the document to be reloaded.
aReloadFlags Flags that indicate how the document is to be refreshed. See constants on the nsIWebNavigation interface.

Returns

Whether the operation can proceed.

evictOutOfRangeContentViewers(aIndex)

Evict content viewers which don’t lie in the “safe” range around aIndex.
In practice, this should leave us with no more than gHistoryMaxViewers
viewers associated with this SHistory object.

Also make sure that the total number of content viewers in all windows is
not greater than our global max; if it is, evict viewers as appropriate.

Parameters

aIndex - The index around which the "safe" range is centered. In general, if you just navigated the history, aIndex should be the index history was navigated to.

evictExpiredContentViewerForEntry(aEntry)

Evict the content viewer associated with a bfcache entry
that has timed out.

evictAllContentViewers()

Evict all the content viewers in this session history

RemoveEntries(aIDs, aStartIndex)

Removes entries from the history if their docshellID is in
aIDs array.

Attributes

rootTransaction

Get the root transaction

rootDocShell

The toplevel docshell object to which this SHistory object belongs to.