Interface nsINavHistoryQueryOptionsType

This object represents the global options for executing a query.

Hierarchy

Properties

asyncEnabled: boolean

When this is true, the root container node generated by these options and its descendant containers will be opened asynchronously if they support it. This is false by default.

Note

Currently only bookmark folder containers support being opened asynchronously.

excludeItems: boolean

This option excludes all URIs and separators from a bookmarks query. This would be used if you just wanted a list of bookmark folders and queries (such as the left pane of the places page). Defaults to false.

excludeQueries: boolean

Set to true to exclude queries ("place:" URIs) from the query results. Simple folder queries (bookmark folder symlinks) will still be included. Defaults to false.

expandQueries: boolean

When set, allows items with "place:" URIs to appear as containers, with the container's contents filled in from the stored query. If not set, these will appear as normal items. Doesn't do anything if excludeQueries is set. Defaults to false.

Note that this has no effect on folder links, which are place: URIs returned by nsINavBookmarkService.GetFolderURI. These are always expanded and will appear as bookmark folders.

includeHidden: boolean

Some pages in history are marked "hidden" and thus don't appear by default in queries. These include automatic framed visits and redirects. Setting this attribute will return all pages, even hidden ones. Does nothing for bookmark queries. Defaults to false.

maxResults: number

This is the maximum number of results that you want. The query is executed, the results are sorted, and then the top 'maxResults' results are taken and returned. Set to 0 (the default) to get all results.

THIS DOES NOT WORK IN CONJUNCTION WITH SORTING BY TITLE. This is because sorting by title requires us to sort after using locale-sensetive sorting (as opposed to letting the database do it for us).

Instead, we get the result ordered by date, pick the maxResult most recent ones, and THEN sort by title.

queryType: number

The type of search to use when querying the DB; This attribute is only honored by query nodes. It is silently ignored for simple folder queries.

resultType: number

Sets the result type. One of RESULT_TYPE_* which includes how URIs are represented.

sortingMode: number

The sorting mode to be used for this query. mode is one of SORT_BY_*

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

  • Creates a new options item with the same parameters of this one.

    Returns nsINavHistoryQueryOptions

Generated using TypeDoc