Interface nsINavHistoryResultType

The result of a history/bookmark query.

Hierarchy

Properties

root: nsINavHistoryContainerResultNode

This is the root of the results. Remember that you need to open all containers for their contents to be valid.

When a result goes out of scope it will continue to observe changes till it is cycle collected. While the result waits to be collected it will stay in memory, and continue to update itself, potentially causing unwanted additional work. When you close the root node the result will stop observing changes, so it is good practice to close the root node when you are done with a result, since that will avoid unwanted performance hits.

sortingMode: number

Sorts all nodes recursively by the given parameter, one of nsINavHistoryQueryOptions.SORT_BY_* This will update the corresponding options for this result, so that re-using the current options/queries will always give you the current view.

suppressNotifications: boolean

Whether or not notifications on result changes are suppressed. Initially set to false.

Use this to avoid flickering and to improve performance when you do temporary changes to the result structure (e.g. when searching for a node recursively).

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Adds an observer for changes done in the result.

    See

    nsINavHistoryResultObserver

    Parameters

    • aObserver: nsINavHistoryResultObserver

      a result observer.

    • aOwnsWeak: boolean

      If false, the result will keep an owning reference to the observer, which must be removed using removeObserver. If true, the result will keep a weak reference to the observer, which must implement nsISupportsWeakReference.

    Returns void

  • Notifies you that a bunch of things are about to change, don't do any heavy-duty processing until onEndUpdateBatch is called.

    Returns void

  • Notifies you that we are done doing a bunch of things and you should go ahead and update UI, etc.

    Returns void

  • Removes an observer that was added by addObserver.

    Parameters

    • aObserver: nsINavHistoryResultObserver

      a result observer that was added by addObserver.

    Returns void

Generated using TypeDoc