mozilla

Compare Revisions

nsINavHistoryService

Change Revisions

Revision 83231:

Revision 83231 by Sheppy on

Revision 83232:

Revision 83232 by Bomfog on

Title:
nsINavHistoryService
nsINavHistoryService
Slug:
XPCOM_Interface_Reference/nsINavHistoryService
XPCOM_Interface_Reference/nsINavHistoryService
Tags:
Extensions, XPCOM, Interfaces, Interfaces:Scriptable, Places, "Developing Mozilla", "XPCOM API Reference", "XPCOM Interface Reference"
Extensions, XPCOM, Interfaces, Interfaces:Scriptable, Places, "Developing Mozilla", "XPCOM API Reference", "XPCOM Interface Reference"
Content:

Revision 83231
Revision 83232
nn11      The
11      The <code>nsINavHistoryService</code> interface provides co12    </p><code>nsINavHistoryService</code> interface provides comp
>mplex query functions, more fine-grained getters and setters.>lex query functions, more fine-grained getters and setters.
12    </p>
n18      Inherits from: <a href="en/NsISupports">nsISupports</a>n18      Inherits from:
19    </p><a href="/en/nsISupports" title="en/nsISupports">nsISuppo
 >rts</a>
19    </p>20    <p>
20    <p>21      Implemented by:
21      Implemented by: <code>"@mozilla.org/browser/nav-history-ser22    </p><code>"@mozilla.org/browser/nav-history-service;1"</code>
>vice;1"</code>. To use this service, use:>. To use this service, use:
22    </p>
n29    </h2>n29    </h2><code>AString <a href="#getPageTitle.28.29">getPageTitle
 ></a>(in <a href="/en/nsIURI" title="en/nsIURI">nsIURI</a> aURI);<
 >/code><code>void <a href="#markPageAsFollowedBookmark.28.29">mark
 >PageAsFollowedBookmark</a>(in <a href="/en/nsIURI" title="en/nsIU
 >RI">nsIURI</a> aURI);</code><code>boolean <a href="#canAddURI.28.
 >29">canAddURI</a>(in <a href="/en/nsIURI" title="en/nsIURI">nsIUR
 >I</a> aURI);</code><code>void <a href="#setPageDetails.28.29">set
 >PageDetails</a>(in <a href="/en/nsIURI" title="en/nsIURI">nsIURI<
 >/a> aURI, in AString aTitle, in unsigned long aVisitCount, in boo
 >lean aHidden, in boolean aTyped);</code><code>long long <a href="
 >#addVisit.28.29">addVisit</a>(in <a href="/en/nsIURI" title="en/n
 >sIURI">nsIURI</a> aURI, in PRTime aTime, in long long aReferringV
 >isit, in long aTransitionType, in boolean aIsRedirect, in long lo
 >ng aSessionID);</code><code><a href="/en/nsINavHistoryQuery" titl
 >e="en/nsINavHistoryQuery">nsINavHistoryQuery</a> <a href="#getNew
 >Query.28.29">getNewQuery</a>();</code><code><a href="/en/nsINavHi
 >storyQueryOptions" title="en/nsINavHistoryQueryOptions">nsINavHis
 >toryQueryOptions</a> <a href="#getNewQueryOptions.28.29">getNewQu
 >eryOptions</a>();</code><code><a href="/en/nsINavHistoryResult" t
 >itle="en/nsINavHistoryResult">nsINavHistoryResult</a> <a href="#e
 >xecuteQuery.28.29">executeQuery</a>(in <a href="/en/nsINavHistory
 >Query" title="en/nsINavHistoryQuery">nsINavHistoryQuery</a> aQuer
 >y, in <a href="/en/nsINavHistoryQueryOptions" title="en/nsINavHis
 >toryQueryOptions">nsINavHistoryQueryOptions</a> options);</code><
 >code><a href="/en/nsINavHistoryResult" title="en/nsINavHistoryRes
 >ult">nsINavHistoryResult</a> <a href="#executeQueries.28.29">exec
 >uteQueries</a>({{ mediawiki.external('array,size_is(aQueryCount)'
 >) }} in <a href="/en/nsINavHistoryQuery" title="en/nsINavHistoryQ
 >uery">nsINavHistoryQuery</a> aQueries, in unsigned long aQueryCou
 >nt, in <a href="/en/nsINavHistoryQueryOptions" title="en/nsINavHi
 >storyQueryOptions">nsINavHistoryQueryOptions</a> options);</code>
 ><code>void <a href="#queryStringToQueries.28.29">queryStringToQue
 >ries</a>(in <a href="/en/AUTF8String" title="en/AUTF8String">AUTF
 >8String</a> aQueryString, {{ mediawiki.external('array, size_is(a
 >ResultCount)') }} out <a href="/en/nsINavHistoryQuery" title="en/
 >nsINavHistoryQuery">nsINavHistoryQuery</a> aQueries, out unsigned
 > long aResultCount, out <a href="/en/nsINavHistoryQueryOptions" t
 >itle="en/nsINavHistoryQueryOptions">nsINavHistoryQueryOptions</a>
 > options);</code><code><a href="/en/AUTF8String" title="en/AUTF8S
 >tring">AUTF8String</a> <a href="#queriesToQueryString.28.29">quer
 >iesToQueryString</a>({{ mediawiki.external('array, size_is(aQuery
 >Count)') }} in <a href="/en/nsINavHistoryQuery" title="en/nsINavH
 >istoryQuery">nsINavHistoryQuery</a> aQueries, in unsigned long aQ
 >ueryCount, in <a href="/en/nsINavHistoryQueryOptions" title="en/n
 >sINavHistoryQueryOptions">nsINavHistoryQueryOptions</a> options);
 ></code><code>void <a href="#addObserver.28.29">addObserver</a>(in
 > <a href="/en/nsINavHistoryObserver" title="en/nsINavHistoryObser
 >ver">nsINavHistoryObserver</a> observer, in boolean ownsWeak);</c
 >ode><code>void <a href="#removeObserver.28.29">removeObserver</a>
 >(in <a href="/en/nsINavHistoryObserver" title="en/nsINavHistoryOb
 >server">nsINavHistoryObserver</a> observer);</code><code>void <a 
 >href="#runInBatchMode.28.29">runInBatchMode</a>(in <a href="/en/N
 >sINavHistoryBatchCallback" title="en/NsINavHistoryBatchCallback">
 >nsINavHistoryBatchCallback</a> aCallback, in <a href="/en/nsISupp
 >orts" title="en/nsISupports">nsISupports</a> aClosure);</code><co
 >de>void <a href="#importHistory.28.29">importHistory</a>(in <a hr
 >ef="/en/nsIFile" title="en/nsIFile">nsIFile</a> file);</code>
n34            <code>AString <a href="#getPageTitle.28.29">getPageTin34            &nbsp;
>tle</a>(in <a href="en/NsIURI">nsIURI</a> aURI);</code> 
35          </td>
36        </tr>
37        <tr>
38          <td>35          </td>
39            <code>void <a href="#markPageAsFollowedBookmark.28.2936        </tr>
>">markPageAsFollowedBookmark</a>(in <a href="en/NsIURI">nsIURI</a 
>> aURI);</code> 
37      </tbody>
38      <tbody>
39        <tr>
40          </td>40          <td>
41        </tr>41            &nbsp;
42        <tr>
43          <td>42          </td>
44            <code>boolean <a href="#canAddURI.28.29">canAddURI</a43        </tr>
>>(in <a href="en/NsIURI">nsIURI</a> aURI);</code> 
44        <tr>
45          </td>45          <td>
46        </tr>46            &nbsp;
47        <tr>
48          <td>47          </td>
49            <code>void <a href="#setPageDetails.28.29">setPageDet48        </tr>
>ails</a>(in <a href="en/NsIURI">nsIURI</a> aURI, in AString aTitl 
>e, in unsigned long aVisitCount, in boolean aHidden, in boolean a 
>Typed);</code> 
49        <tr>
50          </td>50          <td>
51        </tr>51            &nbsp;
52        <tr>
53          <td>52          </td>
54            <code>long long <a href="#addVisit.28.29">addVisit</a53        </tr>
>>(in <a href="en/NsIURI">nsIURI</a> aURI, in PRTime aTime, in lon 
>g long aReferringVisit, in long aTransitionType, in boolean aIsRe 
>direct, in long long aSessionID);</code> 
54        <tr>
55          </td>55          <td>
56        </tr>56            &nbsp;
57        <tr>
58          <td>57          </td>
59            <code><a href="en/NsINavHistoryQuery">nsINavHistoryQu58        </tr>
>ery</a> <a href="#getNewQuery.28.29">getNewQuery</a>();</code> 
59        <tr>
60          </td>60          <td>
61        </tr>61            &nbsp;
62        <tr>
63          <td>62          </td>
64            <code><a href="en/NsINavHistoryQueryOptions">nsINavHi63        </tr>
>storyQueryOptions</a> <a href="#getNewQueryOptions.28.29">getNewQ 
>ueryOptions</a>();</code> 
64        <tr>
65          </td>65          <td>
66        </tr>66            &nbsp;
67        <tr>
68          <td>67          </td>
69            <code><a href="en/NsINavHistoryResult">nsINavHistoryR68        </tr>
>esult</a> <a href="#executeQuery.28.29">executeQuery</a>(in <a hr 
>ef="en/NsINavHistoryQuery">nsINavHistoryQuery</a> aQuery, in <a h 
>ref="en/NsINavHistoryQueryOptions">nsINavHistoryQueryOptions</a>  
>options);</code> 
69        <tr>
70          </td>70          <td>
71        </tr>71            &nbsp;
72        <tr>
73          <td>72          </td>
74            <code><a href="en/NsINavHistoryResult">nsINavHistoryR73        </tr>
>esult</a> <a href="#executeQueries.28.29">executeQueries</a>({{ m 
>ediawiki.external('array,size_is(aQueryCount)') }} in <a href="en 
>/NsINavHistoryQuery">nsINavHistoryQuery</a> aQueries, in unsigned 
> long aQueryCount, in <a href="en/NsINavHistoryQueryOptions">nsIN 
>avHistoryQueryOptions</a> options);</code> 
74        <tr>
75          </td>75          <td>
76        </tr>76            &nbsp;
77        <tr>
78          <td>77          </td>
79            <code>void <a href="#queryStringToQueries.28.29">quer78        </tr>
>yStringToQueries</a>(in <a href="en/AUTF8String">AUTF8String</a>  
>aQueryString, {{ mediawiki.external('array, size_is(aResultCount) 
>') }} out <a href="en/NsINavHistoryQuery">nsINavHistoryQuery</a>  
>aQueries, out unsigned long aResultCount, out <a href="en/NsINavH 
>istoryQueryOptions">nsINavHistoryQueryOptions</a> options);</code 
>> 
79        <tr>
80          </td>80          <td>
81        </tr>81            &nbsp;
82        <tr>
83          <td>82          </td>
84            <code><a href="en/AUTF8String">AUTF8String</a> <a hre83        </tr>
>f="#queriesToQueryString.28.29">queriesToQueryString</a>({{ media 
>wiki.external('array, size_is(aQueryCount)') }} in <a href="en/Ns 
>INavHistoryQuery">nsINavHistoryQuery</a> aQueries, in unsigned lo 
>ng aQueryCount, in <a href="en/NsINavHistoryQueryOptions">nsINavH 
>istoryQueryOptions</a> options);</code> 
84        <tr>
85          </td>85          <td>
86        </tr>86            &nbsp;
87        <tr>
88          <td>87          </td>
89            <code>void <a href="#addObserver.28.29">addObserver</88        </tr>
>a>(in <a href="en/NsINavHistoryObserver">nsINavHistoryObserver</a 
>> observer, in boolean ownsWeak);</code> 
89        <tr>
90          </td>90          <td>
91        </tr>91            &nbsp;
92        <tr>
93          <td>92          </td>
94            <code>void <a href="#removeObserver.28.29">removeObse93        </tr>
>rver</a>(in <a href="en/NsINavHistoryObserver">nsINavHistoryObser 
>ver</a> observer);</code> 
94        <tr>
95          </td>95          <td>
96        </tr>96            &nbsp;
97        <tr>
98          <td>97          </td>
99            <code>void <a href="#runInBatchMode.28.29">runInBatch98        </tr>
>Mode</a>(in <a href="en/NsINavHistoryBatchCallback">nsINavHistory 
>BatchCallback</a> aCallback, in <a href="en/NsISupports">nsISuppo 
>rts</a> aClosure);</code> 
99        <tr>
100          </td>100          <td>
101        </tr>101            &nbsp;
102        <tr>
103          <td>102          </td>
104            <code>void <a href="#importHistory.28.29">importHisto103        </tr>
>ry</a>(in <a href="en/NsIFile">nsIFile</a> file);</code> 
104        <tr>
105          <td>
106            &nbsp;
n111    </h2>n113    </h2><code>hasHistoryEntries</code><code>boolean</code><code>
 >True</code> if there is any history. This can be used in UI to de
 >termine whether the "clear history" button should be enabled or n
 >ot. This is much better than using <code>BrowserHistory.count</co
 >de> since that can be very slow if there is a lot of history (it 
 >must enumerate each item). This is pretty fast. <code>historyDisa
 >bled</code><code>boolean</code><code>True</code> if history is di
 >sabled. currently, history is disabled if the <code>browser.histo
 >ry_expire_days</code> pref is <code>"0"</code>.
n127            <code>hasHistoryEntries</code>n129            &nbsp;
128          </td>
129          <td>130          </td>
130            <code>boolean</code>131        </tr>
132      </tbody>
133      <tbody>
134        <tr>
131          </td>135          <td>
136            &nbsp;
132          <td>137          </td>
133            <code>True</code> if there is any history. This can b
>e used in UI to determine whether the "clear history" button shou 
>ld be enabled or not. This is much better than using <code>Browse 
>rHistory.count</code> since that can be very slow if there is a l 
>ot of history (it must enumerate each item). This is pretty fast. 
134          </td>138          <td>
135        </tr>139            &nbsp;
136        <tr>
137          <td>140          </td>
138            <code>historyDisabled</code>141        </tr>
142        <tr>
139          </td>143          <td>
144            &nbsp;
140          <td>145          </td>
141            <code>boolean</code>146        </tr>
147        <tr>
142          </td>148          <td>
149            &nbsp;
143          <td>150          </td>
144            <code>True</code> if history is disabled. currently, 151          <td>
>history is disabled if the <code>browser.history_expire_days</cod 
>e> pref is <code>"0"</code>. 
152            &nbsp;
n151    </h2>n159    </h2><code>TRANSITION_LINK</code><code>TRANSITION_TYPED</code
 >><code>TRANSITION_BOOKMARK</code><code>TRANSITION_EMBED</code><co
 >de>TRANSITION_REDIRECT_PERMANENT</code><code>TRANSITION_REDIRECT_
 >TEMPORARY</code><code>TRANSITION_DOWNLOAD</code>
n167            <code>TRANSITION_LINK</code>n175            &nbsp;
176          </td>
168          </td>177        </tr>
178      </tbody>
179      <tbody>
180        <tr>
n178            <code>TRANSITION_TYPED</code>n190            &nbsp;
191          </td>
179          </td>192        </tr>
193        <tr>
nn198            This transition is set when the user typed a URL into
 > the URL bar to get to the page.
199          </td>
200        </tr>
201        <tr>
202          <td>
203            &nbsp;
204          </td>
205        </tr>
206        <tr>
207          <td>
208            3
209          </td>
210          <td>
n189            <code>TRANSITION_BOOKMARK</code>n216            &nbsp;
190          </td>
191          <td>217          </td>
192            3
193          </td>
194          <td>
195            This transition is set when the user followed a bookm
>ark to get to the page. 
196          </td>
197        </tr>
198        <tr>218        </tr>
199          <td>219        <tr>
200            <code>TRANSITION_EMBED</code>
201          </td>
n211            <code>TRANSITION_REDIRECT_PERMANENT</code>n229            &nbsp;
230          </td>
212          </td>231        </tr>
232        <tr>
n222            <code>TRANSITION_REDIRECT_TEMPORARY</code>n242            &nbsp;
243          </td>
223          </td>244        </tr>
245        <tr>
n233            <code>TRANSITION_DOWNLOAD</code>n255            &nbsp;
256          </td>
234          </td>257        </tr>
258        <tr>
n263        <tt>aURI</tt>n287        <code>aURI</code>
nn303      This method is just like
279      This method is just like <code>markPageAsTyped</code> (in {304    </p><code>markPageAsTyped</code> (in {{ Interface("nsIBrowser
>{ Interface("nsIBrowserHistory") }}, also implemented by the hist>History") }}, also implemented by the history service), but for b
>ory service), but for bookmarks. It declares that the given URI i>ookmarks. It declares that the given URI is being opened as a res
>s being opened as a result of following a bookmark. If this URI i>ult of following a bookmark. If this URI is loaded soon after thi
>s loaded soon after this message has been received, that transiti>s message has been received, that transition will be marked as fo
>on will be marked as following a bookmark.>llowing a bookmark.
280    </p>
n291        <tt>aURI</tt>n315        <code>aURI</code>
n301      This method checks if the given URI would be added to the hn325      This method checks if the given URI would be added to the h
>istory or not. Many types of URIs, such as <code>"chrome:"</code>>istory or not. Many types of URIs, such as
> URIs, are not stored when <code>addURI</code> is called. This fu 
>nction allows you to determine whether it will be or not. 
326    </p><code>"chrome:"</code> URIs, are not stored when <code>ad
 >dURI</code> is called. This function allows you to determine whet
 >her it will be or not.
302    </p>327    <p>
303    <p>328      You don't have to worry about calling this,
304      You don't have to worry about calling this, <code>addPageTo329    </p><code>addPageToSession</code>/<code>addURI</code> will al
>Session</code>/<code>addURI</code> will always check before actua>ways check before actually adding the page. This function is publ
>lly adding the page. This function is public because some compone>ic because some components may want to check if this page would g
>nts may want to check if this page would go in the history (i.e. >o in the history (i.e. for annotations).
>for annotations). 
305    </p>
n316        <tt>aURI</tt>n340        <code>aURI</code>
nn350      Returns
326      Returns <code>true</code> if this URI would be added to the351    </p><code>true</code> if this URI would be added to the histo
> history, otherwise returns <code>false</code>.>ry, otherwise returns <code>false</code>.
327    </p>
n332      This method sets the full information for a given page. If n356      This method sets the full information for a given page. If 
>the page does not exist, it will be added to the database. If it >the page does not exist, it will be added to the database. If it 
>does, the existing values <b>will be overwritten</b>. This is an >does, the existing values <strong>will be overwritten</strong>. T
>updated version of <code>addPageWithDetails</code> for backup/res>his is an updated version of
>tore type operations. 
333    </p>357    </p><code>addPageWithDetails</code> for backup/restore type o
 >perations.
n348        <tt>aURI</tt>n372        <code>aURI</code>
n354        <tt>aTitle</tt>n378        <code>aTitle</code>
n360        <tt>aVisitCount</tt>n384        <code>aVisitCount</code>
361      </dt>
362      <dd>
363        The number of times this page has been visited. Setting t
>his to <code>"0"</code> may make the page invisible in some views 
>. 
364      </dd>
365      <dt>385      </dt>
366        <tt>aHidden</tt>
367      </dt>
368      <dd>
369        Whether the page is hidden or not. If the page has only <
>code>TRANSITION_EMBED</code> visits, this will be <code>true</cod 
>e>, otherwise it will be <code>false</code>. 
370      </dd>386      <dd>
387        The number of times this page has been visited. Setting t
 >his to
388      </dd>
389      <dd>
390        <code>"0"</code> may make the page invisible in some view
 >s.
391      </dd>
392      <dt>
393        <code>aHidden</code>
371      <dt>394      </dt>
395      <dd>
396        Whether the page is hidden or not. If the page has only
397      </dd>
398      <dd>
399        <code>TRANSITION_EMBED</code> visits, this will be <code>
 >true</code>, otherwise it will be <code>false</code>.
400      </dd>
401      <dt>
372        <tt>aTyped</tt>402        <code>aTyped</code>
n399        <tt>aURI</tt>n429        <code>aURI</code>
n405        <tt>aTime</tt>n435        <code>aTime</code>
n411        <tt>aReferringVisit</tt>n441        <code>aReferringVisit</code>
412      </dt>
413      <dd>
414        The ID of the visit that generated this one. Use <code>"0
>"</code> for no referrer. This must be a valid visit already in t 
>he Database or <code>"0"</code>. 
415      </dd>
416      <dt>442      </dt>
417        <tt>aTransitionType</tt>
418      </dt>
419      <dd>
420        The type of transition: one of <code>TRANSITION_*</code> 
>defined above. 
421      </dd>443      <dd>
444        The ID of the visit that generated this one. Use
445      </dd>
446      <dd>
447        <code>"0"</code> for no referrer. This must be a valid vi
 >sit already in the Database or <code>"0"</code>.
448      </dd>
449      <dt>
450        <code>aTransitionType</code>
422      <dt>451      </dt>
452      <dd>
453        The type of transition: one of
454      </dd>
455      <dd>
456        <code>TRANSITION_*</code> defined above.
457      </dd>
458      <dt>
423        <tt>aIsRedirect</tt>459        <code>aIsRedirect</code>
n429        <tt>aSessionID</tt>n465        <code>aSessionID</code>
466      </dt>
430      </dt>467      <dd>
468        The session ID that this page belongs to. Use
431      <dd>469      </dd>
432        The session ID that this page belongs to. Use <code>"0"</470      <dd>
>code> for no session. 
471        <code>"0"</code> for no session.
nn478      Returns the ID of the created visit. This will be
439      Returns the ID of the created visit. This will be <code>"0"479    </p><code>"0"</code> if the URI is not valid for adding to hi
></code> if the URI is not valid for adding to history (<code>canA>story (<code>canAddURI = false</code>).
>ddURI = false</code>). 
440    </p>
nn484      This method returns a new query object that you can pass to
445      This method returns a new query object that you can pass to485    </p><code>executeQuer{{ mediawiki.external('y/ies') }}</code>
> <code>executeQuer{{ mediawiki.external('y/ies') }}</code> method> methods. It will be initialized to all empty (so using it will g
>s. It will be initialized to all empty (so using it will give you>ive you all history).
> all history). 
446    </p>
nn505      This method returns a new options object that you can pass 
 >to
466      This method returns a new options object that you can pass 506    </p><code>executeQuer{{ mediawiki.external('y/ies') }}</code>
>to <code>executeQuer{{ mediawiki.external('y/ies') }}</code> meth> methods after setting the desired options.
>ods after setting the desired options. 
467    </p>
n500        <tt>aQuery</tt>n539        <code>aQuery</code>
n506        <tt>options</tt>n545        <code>options</code>
nn561      This method is similar to
522      This method is similar to <a href="#executeQuery.28.29">exe562    </p><a href="#executeQuery.28.29">executeQuery</a> method. It
>cuteQuery</a> method. It executes an array of queries. All of the> executes an array of queries. All of the query objects are ORed 
> query objects are ORed together. Within a query, all the terms a>together. Within a query, all the terms are ANDed together as in 
>re ANDed together as in <a href="#executeQuery.28.29">executeQuer><a href="#executeQuery.28.29">executeQuery</a> method.
>y</a> method. 
523    </p>
n536        <tt>aQueries</tt>n575        <code>aQueries</code>
n542        <tt>aQueryCount</tt>n581        <code>aQueryCount</code>
n548        <tt>options</tt>n587        <code>options</code>
nn603      This method converts a query URI-like string to an array of
 > actual query objects for use to
564      This method converts a query URI-like string to an array of604    </p><a href="#executeQueries.28.29">executeQueries</a> method
> actual query objects for use to <a href="#executeQueries.28.29">>. The output query array may be empty if there is no information.
>executeQueries</a> method. The output query array may be empty if> However, there will always be an options structure returned (if 
> there is no information. However, there will always be an option>nothing is defined, it will just have the default values).
>s structure returned (if nothing is defined, it will just have th 
>e default values). 
565    </p>
n579        <tt>aQueryString</tt>n618        <code>aQueryString</code>
n585        <tt>aQueries</tt>n624        <code>aQueries</code>
n591        <tt>aResultCount</tt>n630        <code>aResultCount</code>
n597        <tt>options</tt>n636        <code>options</code>
n607      This method converts a query into an equivalent string thatn646      This method converts a query into an equivalent string that
> can be persisted. Inverse of <a href="#queryStringToQueries.28.2> can be persisted. Inverse of
>9">queryStringToQueries</a> method. 
608    </p>647    </p><a href="#queryStringToQueries.28.29">queryStringToQuerie
 >s</a> method.
n621        <tt>aQueries</tt>n660        <code>aQueries</code>
n627        <tt>aQueryCount</tt>n666        <code>aQueryCount</code>
n633        <tt>options</tt>n672        <code>options</code>
n649      This method adds a history observer. If <code>ownsWeak</codn688      This method adds a history observer. If
>e> is <code>false</code>, the history service will keep an owning 
> reference to the observer. If <code>ownsWeak</code> is <code>tru 
>e</code>, then <code>aObserver</code> must implement {{ Interface 
>("nsISupportsWeakReference") }}, and the history service will kee 
>p a weak reference to the observer. 
650    </p>689    </p><code>ownsWeak</code> is <code>false</code>, the history 
 >service will keep an owning reference to the observer. If <code>o
 >wnsWeak</code> is <code>true</code>, then <code>aObserver</code> 
 >must implement {{ Interface("nsISupportsWeakReference") }}, and t
 >he history service will keep a weak reference to the observer.
n662        <tt>observer</tt>n701        <code>observer</code>
n668        <tt>ownsWeak</tt>n707        <code>ownsWeak</code>
708      </dt>
669      </dt>709      <dd>
710        The owning reference state
670      <dd>711      </dd>
671        The owning reference state <code>(boolean)</code>.712      <dd>
713        <code>(boolean)</code>.
n690        <tt>observer</tt>n732        <code>observer</code>
n713        <tt>aCallback</tt>n755        <code>aCallback</code>
n719        <tt>aClosure</tt>n761        <code>aClosure</code>
n741        <tt>file</tt>n783        <code>file</code>
t750    <ul>t792    <div style="margin-left: 2em">
751      <li>793      <a href="/en/Places" title="en/Places">Places</a> <a href="
 >/en/Using_the_Places_history_service" title="en/Using_the_Places_
 >history_service">Using the Places history service</a> <a href="/e
 >n/Querying_Places" title="en/Querying_Places">Querying Places</a>
 > <a href="/en/NsINavHistoryBatchCallback" title="en/NsINavHistory
 >BatchCallback">nsINavHistoryBatchCallback</a> <a href="/en/nsINav
 >HistoryContainerResultNode" title="en/nsINavHistoryContainerResul
 >tNode">nsINavHistoryContainerResultNode</a> <a href="/en/nsINavHi
 >storyFullVisitResultNode" title="en/nsINavHistoryFullVisitResultN
 >ode">nsINavHistoryFullVisitResultNode</a> <a href="/en/nsINavHist
 >oryObserver" title="en/nsINavHistoryObserver">nsINavHistoryObserv
 >er</a> <a href="/en/nsINavHistoryQuery" title="en/nsINavHistoryQu
 >ery">nsINavHistoryQuery</a> <a href="/en/nsINavHistoryQueryOption
 >s" title="en/nsINavHistoryQueryOptions">nsINavHistoryQueryOptions
 ></a> <a href="/en/nsINavHistoryQueryResultNode" title="en/nsINavH
 >istoryQueryResultNode">nsINavHistoryQueryResultNode</a> <a href="
 >/en/nsINavHistoryResult" title="en/nsINavHistoryResult">nsINavHis
 >toryResult</a> <a href="/en/nsINavHistoryResultNode" title="en/ns
 >INavHistoryResultNode">nsINavHistoryResultNode</a> <a href="/en/n
 >sINavHistoryResultTreeViewer" title="en/nsINavHistoryResultTreeVi
 >ewer">nsINavHistoryResultTreeViewer</a> <a href="/en/nsINavHistor
 >yResultViewObserver" title="en/nsINavHistoryResultViewObserver">n
 >sINavHistoryResultViewObserver</a> <a href="/en/nsINavHistoryResu
 >ltViewer" title="en/nsINavHistoryResultViewer">nsINavHistoryResul
 >tViewer</a> <a href="/en/nsINavHistoryVisitResultNode" title="en/
 >nsINavHistoryVisitResultNode">nsINavHistoryVisitResultNode</a>
752        <a href="en/Places">Places</a>
753      </li>794    </div>
754      <li>
755        <a href="en/Using_the_Places_history_service">Using the P
>laces history service</a> 
756      </li>
757      <li>
758        <a href="en/Querying_Places">Querying Places</a>
759      </li>
760      <li>
761        <a href="en/NsINavHistoryBatchCallback">nsINavHistoryBatc
>hCallback</a> 
762      </li>
763      <li>
764        <a href="en/NsINavHistoryContainerResultNode">nsINavHisto
>ryContainerResultNode</a> 
765      </li>
766      <li>
767        <a href="en/NsINavHistoryFullVisitResultNode">nsINavHisto
>ryFullVisitResultNode</a> 
768      </li>
769      <li>
770        <a href="en/NsINavHistoryObserver">nsINavHistoryObserver<
>/a> 
771      </li>
772      <li>
773        <a href="en/NsINavHistoryQuery">nsINavHistoryQuery</a>
774      </li>
775      <li>
776        <a href="en/NsINavHistoryQueryOptions">nsINavHistoryQuery
>Options</a> 
777      </li>
778      <li>
779        <a href="en/NsINavHistoryQueryResultNode">nsINavHistoryQu
>eryResultNode</a> 
780      </li>
781      <li>
782        <a href="en/NsINavHistoryResult">nsINavHistoryResult</a>
783      </li>
784      <li>
785        <a href="en/NsINavHistoryResultNode">nsINavHistoryResultN
>ode</a> 
786      </li>
787      <li>
788        <a href="en/NsINavHistoryResultTreeViewer">nsINavHistoryR
>esultTreeViewer</a> 
789      </li>
790      <li>
791        <a href="en/NsINavHistoryResultViewObserver">nsINavHistor
>yResultViewObserver</a> 
792      </li>
793      <li>
794        <a href="en/NsINavHistoryResultViewer">nsINavHistoryResul
>tViewer</a> 
795      </li>
796      <li>
797        <a href="en/NsINavHistoryVisitResultNode">nsINavHistoryVi
>sitResultNode</a> 
798      </li>
799    </ul>

Back to History