Search completed in 1.08 seconds.
nsINavHistoryResultObserver
toolkit/components/places/
nsinavhistoryservice.idlscriptable lets clients observe changes to a result as the result updates itself according to bookmark and history system events.
... 1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 11.0 (firefox 11.0 / thunderbird 11.0 / seamonkey 2.8) note: in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1), this interface replaced the older
nsinavhistoryresultviewer interface, which only allowed one client at a time.
... method overview void batching(in boolean atogglemode); void containerclosed(in
nsinavhistorycontainerresultnode acontainernode); deprecated since gecko 2.0 obsolete since gecko 11.0 void containeropened(in
nsinavhistorycontainerresultnode acontainernode); deprecated since gecko 2.0 obsolete since gecko 11.0 void containerstatechanged(in
nsinavhistorycontainerresultnode acontainernode, in unsigned long aoldstate, in unsigned long anewstate); void invalidatecontainer(in
nsinavhistorycontainerresultnode acontainernode); void nodeannotationchanged(in
nsinavhistoryresultnode anode, in autf8string aannoname); void nodedateaddedchanged(in
nsinavhistoryresultnode anode, in prtime anewvalue); void nodehistorydetailschanged(in
nsinavhistoryresultnode anode, in prtime anewvisitdate, in unsigned ...
...And 23 more matches
nsINavHistoryResultViewer
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable lets
nsinavhistoryresult instances notify places views of changes in the results.
... removed in gecko 2.0 and replaced with the
nsinavhistoryresultobserver interface, which is similar but allows multiple clients to observe the result at once.
... method overview void containerclosed(in
nsinavhistorycontainerresultnode acontainernode); void containeropened(in
nsinavhistorycontainerresultnode acontainernode); void invalidatecontainer(in
nsinavhistorycontainerresultnode acontainernode); void nodeannotationchanged(in
nsinavhistoryresultnode anode, in autf8string aannoname); void nodedateaddedchanged(in
nsinavhistoryresultnode anode, in prtime anewvalue); ...
...And 21 more matches
nsINavHistoryService
toolkit/components/places/
nsinavhistoryservice.idlscriptable this interface provides complex query functions, more fine-grained getters and setters.
...to use this service, use: var historyservice = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.
nsinavhistoryservice); method overview astring getpagetitle(in nsiuri auri); void markpageasfollowedbookmark(in nsiuri auri); void markpageasfollowedlink(in nsiuri auri); void markpageastyped(in nsiuri auri); boolean canadduri(in nsiuri auri); long long addvisit(in nsiuri auri, in prtime atime, in nsiuri areferringuri, in long atransitiontype, in boolean...
... aisredirect, in long long asessionid); obsolete since gecko 22.0
nsinavhistoryquery getnewquery();
nsinavhistoryqueryoptions getnewqueryoptions();
nsinavhistoryresult executequery(in
nsinavhistoryquery aquery, in
nsinavhistoryqueryoptions options);
nsinavhistoryresult executequeries([array,size_is(aquerycount)] in
nsinavhistoryquery aqueries, in unsigned long aquerycount, in
nsinavhistoryqueryoptions options); void querystringtoqueries(in autf8string aquerystring, [array, size_is(aresultcount)] out
nsinavhistoryquery aqueries, out unsigned long aresultcount, out
nsinavhistoryqueryoptions options); autf8string queriestoquerystring([array, size_is(aquerycount)] in
nsinavhistoryquery aqueries, in unsigned long aquerycount, in
nsinavhistoryqueryoptions...
...And 11 more matches
nsINavHistoryResultNode
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable this is the base class for all places history result nodes, containing the uri, title, and other general information.
... parent
nsinavhistorycontainerresultnode identifies the parent result node in the result set.
... parentresult
nsinavhistoryresult the history-result to which this node belongs.
...And 9 more matches
nsINavHistoryResult
toolkit/components/places/
nsinavhistoryservice.idlscriptable describes the result of a history or bookmark query.
...more specifically, the
nsinavhistoryresultviewer interface provides the view component of the pattern, and
nsinavhistoryresultviewobserver is the controller.
... the result indicates to the view when something changes by using the
nsinavhistoryresultviewer interface.
...And 8 more matches
nsINavHistoryQueryOptions
toolkit/components/places/
nsinavhistoryservice.idlscriptable represents the global options for executing a query.
... 1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 13.0 (firefox 13.0 / thunderbird 13.0 / seamonkey 2.10) method overview
nsinavhistoryqueryoptions clone(); attributes attribute type description applyoptionstocontainers boolean if true, the query options are only applied to the containers.
... results_as_date_query 3 returns
nsinavhistoryqueryresultnode nodes for each predefined date range where we had visits.
...And 6 more matches
nsINavHistoryContainerResultNode
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable a foundation for the interfaces that provide a description of a query result on the places service that describes a container (which is any kind of grouping, including bookmark folders).
... 1.0 66 introduced gecko 1.9 inherits from:
nsinavhistoryresultnode last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview
nsinavhistoryresultnode findnodebydetails(in autf8string auristring, in prtime atime, in long long aitemid, in boolean arecursive);
nsinavhistoryresultnode getchild(in unsigned long aindex); unsigned long getchildindex(in
nsinavhistoryresultnode anode); attributes attribute type description childcount unsigned long the number of child nodes; accessing this throws an ns_error_not_available exception of containeropen is false.
...
nsinavhistoryresultnode findnodebydetails( in autf8string auristring, in prtime atime, in long long aitemid, in boolean recursive ); parameters auristring the uri attribute value to match on.
...And 4 more matches
nsINavHistoryQueryResultNode
toolkit/components/places/
nsinavhistoryservice.idlscriptable used for places queries and as a base class for bookmark folders.
... 1.0 66 introduced gecko 1.8 inherits from:
nsinavhistorycontainerresultnode last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) note: if you request that places not be expanded in the options that generated the node, the node will report that it has no children and will never try to populate itself.
... method overview void getqueries([optional] out unsigned long querycount, [retval,array,size_is(querycount)] out
nsinavhistoryquery queries); attributes attribute type description folderitemid long long for both simple folder nodes and simple-folder-query nodes, this is set to the concrete itemid of the folder.
...And 4 more matches
nsINavHistoryQuery
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable encapsulates all the query parameters you're likely to need when building up history ui.
... 1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) the
nsinavhistoryquery is not intended to be a super-general query mechanism.
...this is important because, if the user has their profile on a networked drive, query latency can be non-negligible method overview
nsinavhistoryquery clone(); void getfolders([optional ]out unsigned long count, [retval,array,size_is(count)] out long long folders); void gettransitions([optional] out unsigned long count, [retval,array,size_is(count)] out unsigned long transitions); void setfolders([const,array, size_is(foldercount)] in long long folders, in unsigned long foldercount); void settransitions([const,array, size_is(count)] in unsigned long transitions, in unsigned long count); attributes attribute type description absolutebegintime prtime read only: retrieves the begin time value that the currently...
...And 3 more matches
nsINavHistoryResultTreeViewer
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable this interface provides a predefined view adaptor for interfacing places query results with a tree.
... 1.0 66 introduced gecko 1.8 inherits from:
nsinavhistoryresultobserver last changed in gecko 1.9 (firefox 3) this object removes itself from the associated result when the tree is detached; this prevents circular references.
...method overview
nsinavhistoryresultnode nodefortreeindex(in unsigned long aindex); unsigned long treeindexfornode(in
nsinavhistoryresultnode anode); attributes attribute type description collapseduplicates boolean controls whether duplicate adjacent elements are collapsed into a single item in the tree.
...And 3 more matches
nsINavHistoryFullVisitResultNode
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable this interface describes a result from a result_type_full_visit query on the places service.
... this includes more detailed information than the result_type_visit query (which returns
nsinavhistoryvisitresultnode, and as such takes more time to look up.
... 1.0 66 introduced gecko 1.9 inherits from:
nsinavhistoryvisitresultnode last changed in gecko 1.9 (firefox 3) the information returned in this interface is not commonly used, hence its separation into a separate query type for efficiency.
...And 2 more matches
nsINavHistoryObserver
toolkit/components/places/
nsinavhistoryservice.idlscriptable this interface is similar to the nsirdfobserver class, but is used to observe interactions on the global history.
... using onbeforedeleteuri() in gecko 1.9.1 if you wish to support onbeforedeleteuri() in applications based on gecko 1.9.1, you must implement your observer's queryinterface() method to match on both
nsinavhistoryobserver and
nsinavhistoryobserver_mozilla_1_9_1_additions, as shown below.
... queryinterface: function(iid) { if (iid.equals(ci.
nsinavhistoryobserver) || iid.equals(ci.
nsinavhistoryobserver_mozilla_1_9_1_additions) || iid.equals(ci.nsisupports)) { return this; } throw cr.ns_error_no_interface; } see also
nsinavhistoryresult ...
nsINavHistoryVisitResultNode
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable this interface describes a result from a result_type_visit query on the places service.
... 1.0 66 introduced gecko 1.9 inherits from:
nsinavhistoryresultnode last changed in gecko 1.9 (firefox 3) attributes attribute type description sessionid long long the session id of the visit, used for session grouping when a tree view is sorted by date.
... see also
nsinavhistoryresultnode ...
nsINavHistoryBatchCallback
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable please add a summary to this article.
... 1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void runbatched(in nsisupports auserdata); methods runbatched() void runbatched( in nsisupports auserdata ); parameters auserdata see also
nsinavhistoryservice.runinbatchmode() nsinavbookmarksservice.runinbatchmode() ...
nsINavHistoryResultViewObserver
toolkit/components/places/public/
nsinavhistoryservice.idlscriptable this interface is used by clients of the history results to define domain-specific handling of specific nsitreeview methods that the history result doesn't implement.
Displaying Places information using views
use them to display
nsinavhistoryresult objects to the user.
... see querying places for information about obtaining and using
nsinavhistoryresult objects, which this page assumes you are familiar with.
... an
nsinavhistoryresult instance provides the data for a view.
...And 34 more matches
Querying Places
executing a query places queries have several basic parts: the query object:
nsinavhistoryquery, holds the search parameters the query options:
nsinavhistoryqueryoptions, allows configuration of the search result the history service:
nsinavhistoryservice, executes the query the first first step is to create the query and options, and fill them with the parameters you want.
... use
nsinavhistoryservice.getnewquery() and
nsinavhistoryservice.getnewqueryoptions() to retrieve empty objects.
... the defaults for these objects will result in a query that returns all of your browser history in a flat list: chromeutils.definemodulegetter(this, "placesutils", "resource://gre/modules/placesutils.jsm"); // no query options set will get all history, sorted in database order, // which is
nsinavhistoryqueryoptions.sort_by_none.
...And 19 more matches
Using the Places history service
nsinavhistoryservice: complex query functions, more fine-grained getters and setters.
... creating the history service the places history service's contract id is "@mozilla.org/browser/nav-history-service;1": var historyservice = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.
nsinavhistoryservice); it also responds to the old contract id for url bar autocomplete "@mozilla.org/autocomplete/search;1?name=history" and the contract id for the old history system (since it is backwards-compatible) "@mozilla.org/browser/global-history;2".
...new code should use
nsinavhistoryservice.setpagedetails.
...And 16 more matches
nsIPlacesView
method overview
nsinavhistoryresultnode[] getdragableselection();
nsinavhistoryresultnode[][] getremovableselectionranges();
nsinavhistoryresult getresult();
nsinavhistorycontainerresultnode getresultnode();
nsinavhistoryresultnode[] getselectionnodes(); void selectall(); attributes attribute type description hasselection boolean whether or not...
... selectednode
nsinavhistoryresultnode the selected node in the view.
... methods getdragableselection() returns an array of selected
nsinavhistoryresultnode objects that can be dragged from the view.
...And 14 more matches
Index
to use this service, use: 790
nsinavhistorybatchcallback interfaces, interfaces:scriptable, needscontent, xpcom interface reference no summary!
... 791
nsinavhistorycontainerresultnode developing mozilla, extensions, interfaces, places, xpcom, xpcom api reference returns a node matching specified details.
... 792
nsinavhistoryfullvisitresultnode developing mozilla, extensions, interfaces, interfaces:scriptable, places, xpcom, xpcom api reference, xpcom interface reference the information returned in this interface is not commonly used, hence its separation into a separate query type for efficiency.
...And 13 more matches
Places Developer Guide
var history = cc["@mozilla.org/browser/nav-history-service;1"] .getservice(ci.
nsinavhistoryservice); var query = history.getnewquery(); query.setfolders([myfolderid], 1); var result = history.executequery(query, history.getnewqueryoptions()); // the root property of a query result is an object representing the folder you specified above.
... if (type == ci.
nsinavhistoryresultnode.result_type_uri) { var uri = childnode.uri; } else if (type == ci.
nsinavhistoryresultnode.result_type_folder) { childnode.queryinterface(ci.
nsinavhistorycontainerresultnode); childnode.containeropen = true; // now you can iterate over a subfolder's children } } ther available node types are documented in the idl.
...var bookmarks = cc["@mozilla.org/browser/nav-bookmarks-service;1"] .getservice(ci.nsinavbookmarksservice); var history = cc["@mozilla.org/browser/nav-history-service;1"] .getservice(ci.
nsinavhistoryservice); var query = history.getnewquery(); // specify folders to be searched var folders = [bookmarks.toolbarfolder, bookmarks.bookmarksmenufolder, bookmarks.unfiledbookmarksfolder]; query.setfolders(folders, folders.length); // specify terms to search for, matches against title, url and tags query.searchterms = "firefox"; var options = history.getnewqueryoptions(); options.querytype = options.qu...
...And 9 more matches
Places utilities for JavaScript
placesutils method overview nsiuri createfixeduri(string aspec); string getformattedstring(string key, string params); string getstring(string key); boolean nodeisfolder(
nsinavhistoryresultnode anode); boolean nodeisbookmark(
nsinavhistoryresultnode anode); boolean nodeisseparator(
nsinavhistoryresultnode anode); boolean nodeisvisit(
nsinavhistoryresultnode anode); boolean nodeisuri(
nsinavhistoryresultnode anode); boolean nodeisquery(
nsinavhistoryresultnode anode); boolean nodeisreadonly(
nsinavhistoryresultnode anode); ...
... boolean nodeishost(
nsinavhistoryresultnode anode); boolean nodeiscontainer(
nsinavhistoryresultnode anode); boolean nodeisdynamiccontainer(
nsinavhistoryresultnode anode); boolean nodeislivemarkcontainer(
nsinavhistoryresultnode anode); obsolete since gecko 21 boolean nodeislivemarkitem(
nsinavhistoryresultnode anode); obsolete since gecko 21 boolean isreadonlyfolder(
nsinavhistoryresultnode anode); int getindexofnode(
nsinavhistoryresultnode anode); string wrapnode(
nsinavhistoryresultnode anode, string atype, nsiuri aoverrideuri); array unwrapnodes(string blob, string atype); nsitransaction maketransaction(string data, string type,
nsinavhistoryresultnode container, int index, boolean copy);
nsinavhistoryres...
...ct getannotationsforuri(nsiuri auri); array object getannotationsforitem(int aitemid); void setannotationsforuri(nsiuri auri, object aannos); void setannotationsforuri(int aitemid, object aannos); getviewfornode(nsidomnode anode); void markpageastyped(string aurl); void markpageasfollowedbookmark(string aurl); boolean checkurlsecurity(
nsinavhistoryresultnode aurinode); string getquerystringforfolder(int afolderid); string getdescriptionfromdocument(nsidomdocument doc); string setpostdataforbookmark(int aboomarkid, string apostdata); string getpostdataforbookmark(int aboomarkid); array string geturlandpostdataforkeyword(string akeyword); string getitemdescription(int aitemid); ns...
...And 4 more matches
nsIBrowserHistory
movepagesbytimeframe(in long long abegintime, in long long aendtime); void removepagesfromhost(in autf8string ahost, in boolean aentiredomain); void removevisitsbytimeframe(in long long abegintime, in long long aendtime); void unregisteropenpage(in nsiuri auri); obsolete since gecko 9.0 note: the markpageasfollowedlink and markpageastyped methods were moved to
nsinavhistoryservice in gecko 22.0 so that all markpageas* methods can be found in one interface.
... note: the count attribute was removed in gecko 15.0 because it was only used to determine if there were any entries at all anyway, so the
nsinavhistoryservice.hashistoryentries attribute is better for this.
...you should use
nsinavhistoryservice.markpageasfollowedlink() instead.
...And 2 more matches
Retrieving part of the bookmarks tree
first, you need to get an empty query and options objects from the history service: var historyservice = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.
nsinavhistoryservice); var options = historyservice.getnewqueryoptions(); var query = historyservice.getnewquery(); find the folder you want to get known folder ids are retrieved from the bookmarks service.
...configure the query to get a hierarchical bookmarks result, pass the folder id to setfolders in your query object: query.setfolders([toolbarfolder], 1); run the query the executequery and executequeries functions will return an
nsinavhistoryresult object containing the results of your query: var result = historyservice.executequery(query, options); get the results when you are querying for exactly one folder grouped by folder with no fancy query parameters such as keywords or date ranges (as in this example), the root of the result will be an
nsinavhistorycontainerresultnode corresponding to your folder.
... if you have a complex query the root will be a
nsinavhistoryqueryresultnode.
...complete code listing var historyservice = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.
nsinavhistoryservice); var options = historyservice.getnewqueryoptions(); var query = historyservice.getnewquery(); var bookmarksservice = components.classes["@mozilla.org/browser/nav-bookmarks-service;1"] .getservice(components.interfaces.nsinavbookmarksservice); var toolbarfolder = bookmarksservice.toolbarfolder; query.setfolders([toolbarfolder], 1); var result = historyse...
nsIDynamicContainer
method overview void oncontainermoved(in long long aitemid, in long long anewparent, in long anewindex); void oncontainernodeclosed(in
nsinavhistorycontainerresultnode acontainer); void oncontainernodeopening(in
nsinavhistorycontainerresultnode acontainer, in
nsinavhistoryqueryoptions aoptions); void oncontainerremoving(in long long aitemid); methods oncontainermoved() this method is called when the given container has just been moved, in case the service needs to do any bookkeeping.
...void oncontainernodeclosed( in
nsinavhistorycontainerresultnode acontainer ); parameters acontainer the container node of the container being closed.
...void oncontainernodeopening( in
nsinavhistorycontainerresultnode acontainer, in
nsinavhistoryqueryoptions aoptions ); parameters acontainer the container node for the container being opened.
... see also places
nsinavhistorycontainerresultnode
nsinavhistoryqueryoptions nsinavbookmarksservice.createdynamiccontainer() ...
History Service Design
view the service interface definition:
nsinavhistoryservice.idl.
... places core history service (
nsinavhistoryservice.idl) is the core of places, every other places service depends on it to correctly work, so it gets always initialized at application startup.
... a places query is made of of a query object (
nsinavhistoryquery) and a query options object (
nsinavhistoryqueryoptions) that defines the constraints results must obey to.
nsINavBookmarksService
ince gecko 2.0 void removefolder(in long long afolder); obsolete since gecko 2.0 void removefolderchildren(in long long aitemid); void removeitem(in long long aitemid); void removeobserver(in nsinavbookmarkobserver observer); void replaceitem(in print64 folder, in nsiuri item, in nsiuri newitem); obsolete since gecko 1.9 void runinbatchmode(in
nsinavhistorybatchcallback acallback, in nsisupports auserdata); void setfolderreadonly(in long long afolder, in boolean areadonly); void setfoldertitle(in print64 folder, in astring title); obsolete since gecko 1.9 void setitemdateadded(in long long aitemid, in prtime adateadded); void setitemguid(in long long aitemid, in astring aguid); obsolete since gecko 14.0 ...
... void runinbatchmode( in
nsinavhistorybatchcallback acallback, in nsisupports auserdata ); parameters acallback
nsinavhistorybatchcallback interface to call.
... see also places manipulating bookmarks using places nsitransaction nsinavbookmarkobserver
nsinavhistorybatchcallback ...
Mozilla
use them to display
nsinavhistoryresult objects to the user.
... see querying places for information about obtaining and using
nsinavhistoryresult objects, which this page assumes you are familiar with.
Limitations of frame scripts
for example:
nsinavhistoryservice nsinavbookmarksservice observers in the content process as noted in observers in the chrome process, most observers should be registered in the chrome process and will not work in the content process.
Limitations of frame scripts
for example:
nsinavhistoryservice nsinavbookmarksservice observers in the content process as noted in observers in the chrome process, most observers should be registered in the chrome process and will not work in the content process.