import "nsINavHistoryService.idl";
Public Member Functions | |
| void | getFolders (out unsigned long count,[retval, array, size_is(count)] out long long folders) |
| void | setFolders ([const, array, size_is(folderCount)] in long long folders, in unsigned long folderCount) |
| nsINavHistoryQuery | clone () |
Public Attributes | |
| const unsigned long | TIME_RELATIVE_EPOCH = 0 |
| const unsigned long | TIME_RELATIVE_TODAY = 1 |
| const unsigned long | TIME_RELATIVE_NOW = 2 |
| attribute PRTime | beginTime |
| attribute unsigned long | beginTimeReference |
| readonly attribute boolean | hasBeginTime |
| readonly attribute PRTime | absoluteBeginTime |
| attribute PRTime | endTime |
| attribute unsigned long | endTimeReference |
| readonly attribute boolean | hasEndTime |
| readonly attribute PRTime | absoluteEndTime |
| attribute AString | searchTerms |
| readonly attribute boolean | hasSearchTerms |
| attribute long | minVisits |
| attribute long | maxVisits |
| attribute boolean | onlyBookmarked |
| attribute boolean | domainIsHost |
| attribute AUTF8String | domain |
| readonly attribute boolean | hasDomain |
| attribute boolean | uriIsPrefix |
| attribute nsIURI | uri |
| readonly attribute boolean | hasUri |
| attribute boolean | annotationIsNot |
| attribute AUTF8String | annotation |
| readonly attribute boolean | hasAnnotation |
| readonly attribute unsigned long | folderCount |
This is not intended to be a super-general query mechanism. This was designed so that most queries can be done in only one SQL query. This is important because, if the user has their profile on a networked drive, query latency can be non-negligible.
Definition at line 733 of file nsINavHistoryService.idl.
| nsINavHistoryQuery nsINavHistoryQuery::clone | ( | ) |
Creates a new query item with the same parameters of this one.
| void nsINavHistoryQuery::getFolders | ( | out unsigned long | count, | |
| [retval, array, size_is(count)] out long long | folders | |||
| ) |
Limit results to items that are in all of the given folders.
| void nsINavHistoryQuery::setFolders | ( | [const, array, size_is(folderCount)] in long long | folders, | |
| in unsigned long | folderCount | |||
| ) |
For the special result type RESULTS_AS_TAG_CONTENTS we can define only one folder that must be a tag folder. This is not recursive so results will be returned from the first level of that folder.
| readonly attribute PRTime nsINavHistoryQuery::absoluteBeginTime |
Definition at line 766 of file nsINavHistoryService.idl.
| readonly attribute PRTime nsINavHistoryQuery::absoluteEndTime |
Definition at line 771 of file nsINavHistoryService.idl.
| attribute AUTF8String nsINavHistoryQuery::annotation |
Definition at line 841 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQuery::annotationIsNot |
Test for existance or non-existance of a given annotation. We don't currently support >1 annotation name per query. If 'annotationIsNot' is true, we test for the non-existance of the specified annotation.
Testing for not annotation will do the same thing as a normal query and remove everything that doesn't have that annotation. Asking for things that DO have a given annotation is a little different. It also includes things that have never been visited. This allows place queries to be returned as well as anything else that may have been tagged with an annotation. This will only work for RESULTS_AS_URI since there will be no visits for these items.
Definition at line 840 of file nsINavHistoryService.idl.
| attribute PRTime nsINavHistoryQuery::beginTime |
Definition at line 763 of file nsINavHistoryService.idl.
| attribute unsigned long nsINavHistoryQuery::beginTimeReference |
Definition at line 764 of file nsINavHistoryService.idl.
| attribute AUTF8String nsINavHistoryQuery::domain |
This is the host or domain name (controlled by domainIsHost). When domainIsHost, domain only does exact matching on host names. Otherwise, it will return anything whose host name ends in 'domain'.
This one is a little different than most. Setting it to an empty string is a real query and will match any URI that has no host name (local files and such). Set this to NULL (in C++ use SetIsVoid) if you don't want domain matching.
Definition at line 809 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQuery::domainIsHost |
This controls the meaning of 'domain', and whether it is an exact match 'domainIsHost' = true, or hierarchical (= false).
Definition at line 797 of file nsINavHistoryService.idl.
| attribute PRTime nsINavHistoryQuery::endTime |
Definition at line 768 of file nsINavHistoryService.idl.
| attribute unsigned long nsINavHistoryQuery::endTimeReference |
Definition at line 769 of file nsINavHistoryService.idl.
| readonly attribute unsigned long nsINavHistoryQuery::folderCount |
Definition at line 849 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasAnnotation |
Definition at line 842 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasBeginTime |
Definition at line 765 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasDomain |
Definition at line 810 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasEndTime |
Definition at line 770 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasSearchTerms |
Definition at line 777 of file nsINavHistoryService.idl.
| readonly attribute boolean nsINavHistoryQuery::hasUri |
Definition at line 825 of file nsINavHistoryService.idl.
| attribute long nsINavHistoryQuery::maxVisits |
Definition at line 785 of file nsINavHistoryService.idl.
| attribute long nsINavHistoryQuery::minVisits |
Set lower or upper limits for how many times an item has been visited. The default is -1, and in that case all items are matched regardless of their visit count.
Definition at line 784 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQuery::onlyBookmarked |
When set, returns only bookmarked items, when unset, returns anything. Setting this is equivalent to listing all bookmark folders in the 'folders' parameter.
Definition at line 791 of file nsINavHistoryService.idl.
| attribute AString nsINavHistoryQuery::searchTerms |
Text search terms.
Definition at line 776 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryQuery::TIME_RELATIVE_EPOCH = 0 |
Time range for results (INCLUSIVE). The *TimeReference is one of the constants TIME_RELATIVE_* which indicates how to interpret the corresponding time value. TIME_RELATIVE_EPOCH (default): The time is relative to Jan 1 1970 GMT, (this is a normal PRTime) TIME_RELATIVE_TODAY: The time is relative to this morning at midnight. Normally used for queries relative to today. For example, a "past week" query would be today-6 days -> today+1 day TIME_RELATIVE_NOW: The time is relative to right now.
Note: PRTime is in MICROseconds since 1 Jan 1970. Javascript date objects are expressed in MILLIseconds since 1 Jan 1970.
As a special case, a 0 time relative to TIME_RELATIVE_EPOCH indicates that the time is not part of the query. This is the default, so an empty query will match any time. The has* functions return whether the corresponding time is considered.
You can read absolute*Time to get the time value that the currently loaded reference points + offset resolve to.
Definition at line 759 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryQuery::TIME_RELATIVE_NOW = 2 |
Definition at line 761 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryQuery::TIME_RELATIVE_TODAY = 1 |
Definition at line 760 of file nsINavHistoryService.idl.
| attribute nsIURI nsINavHistoryQuery::uri |
This is a URI to match, to, for example, find out every time you visited a given URI. Use uriIsPrefix to control whether this is an exact match.
Definition at line 824 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQuery::uriIsPrefix |
Controls the interpretation of 'uri'. When unset (default), the URI will request an exact match of the specified URI. When set, any history entry beginning in 'uri' will match. For example "http://bar.com/foo" will match "http://bar.com/foo" as well as "http://bar.com/foo/baz.gif".
Definition at line 818 of file nsINavHistoryService.idl.
1.5.8