/usr/share/gtk-doc/html/zeitgeist-1.0/ZeitgeistIndex.html is in libzeitgeist-doc 0.3.18-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ZeitgeistIndex</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="API Documentation for the Zeitgeist Client Library">
<link rel="up" href="ch04.html" title="API for Zeitgeist Extensions">
<link rel="prev" href="ch04.html" title="API for Zeitgeist Extensions">
<link rel="next" href="ZeitgeistDataSource.html" title="ZeitgeistDataSource">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">API Documentation for the Zeitgeist Client Library</th>
<td><a accesskey="n" href="ZeitgeistDataSource.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ZeitgeistIndex.synopsis" class="shortcut">Top</a>
|
<a href="#ZeitgeistIndex.description" class="shortcut">Description</a>
|
<a href="#ZeitgeistIndex.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="ZeitgeistIndex"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ZeitgeistIndex.top_of_page"></a>ZeitgeistIndex</span></h2>
<p>ZeitgeistIndex — Query the Zeitgeist Full Text Search Extension</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ZeitgeistIndex.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <zeitgeist.h>
<a class="link" href="ZeitgeistIndex.html#ZeitgeistIndex-struct" title="ZeitgeistIndex">ZeitgeistIndex</a>;
struct <a class="link" href="ZeitgeistIndex.html#ZeitgeistIndexClass" title="struct ZeitgeistIndexClass">ZeitgeistIndexClass</a>;
<a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="returnvalue">ZeitgeistIndex</span></a> * <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-new" title="zeitgeist_index_new ()">zeitgeist_index_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()">zeitgeist_index_search</a> (<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *event_templates</code></em>,
<em class="parameter"><code><span class="type">guint32</span> offset</code></em>,
<em class="parameter"><code><span class="type">guint32</span> num_events</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> result_type</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="returnvalue">ZeitgeistResultSet</span></a> * <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-finish" title="zeitgeist_index_search_finish ()">zeitgeist_index_search_finish</a> (<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *res</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-with-relevancies" title="zeitgeist_index_search_with_relevancies ()">zeitgeist_index_search_with_relevancies</a>
(<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *event_templates</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistStorageState"><span class="type">ZeitgeistStorageState</span></a> storage_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> offset</code></em>,
<em class="parameter"><code><span class="type">guint32</span> num_events</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> result_type</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="returnvalue">ZeitgeistResultSet</span></a>* <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-with-relevancies-finish" title="zeitgeist_index_search_with_relevancies_finish ()">zeitgeist_index_search_with_relevancies_finish</a>
(<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *res</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> **relevancies</code></em>,
<em class="parameter"><code><span class="type">gint</span> *relevancies_size</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ZeitgeistIndex.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----ZeitgeistIndex
</pre>
</div>
<div class="refsect1">
<a name="ZeitgeistIndex.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ZeitgeistIndex.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ZeitgeistIndex-struct"></a><h3>ZeitgeistIndex</h3>
<pre class="programlisting">typedef struct _ZeitgeistIndex ZeitgeistIndex;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ZeitgeistIndexClass"></a><h3>struct ZeitgeistIndexClass</h3>
<pre class="programlisting">struct ZeitgeistIndexClass {
GObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-index-new"></a><h3>zeitgeist_index_new ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="returnvalue">ZeitgeistIndex</span></a> * zeitgeist_index_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> instance. The index will start to connect to
Zeitgeist asynchronously. You can however start calling methods on the
returned instance immediately, any method calls issued before the connection
has been established will simply be queued and executed once the connection
is up.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A reference to a newly allocated index. Free with <code class="function">g_object_unref()</code>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-index-search"></a><h3>zeitgeist_index_search ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> zeitgeist_index_search (<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *event_templates</code></em>,
<em class="parameter"><code><span class="type">guint32</span> offset</code></em>,
<em class="parameter"><code><span class="type">guint32</span> num_events</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> result_type</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Perform a full text search possibly restricted to a <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>
and/or set of event templates.
</p>
<p>
The default boolean operator is <code class="literal">AND</code>. Thus the query
<span class="emphasis"><em>foo bar</em></span> will be interpreted as
<span class="emphasis"><em>foo AND bar</em></span>. To exclude a term from the result
set prepend it with a minus sign - eg <span class="emphasis"><em>foo -bar</em></span>.
Phrase queries can be done by double quoting the string
<span class="emphasis"><em>"foo is a bar"</em></span>. You can truncate terms by appending
a *.
</p>
<p>
There are a few keys you can prefix to a term or phrase to search within
a specific set of metadata. They are used like
<span class="emphasis"><em>key:value</em></span>. The keys <span class="emphasis"><em>name</em></span> and
<span class="emphasis"><em>title</em></span> search strictly within the text field of the
event subjects. The key <span class="emphasis"><em>app</em></span> searches within the
application name or description that is found in the actor attribute of
the events. Lastly you can use the <span class="emphasis"><em>site</em></span> key to search
within the domain name of the subject URIs.
</p>
<p>
You can also control the results with the boolean operators
<span class="emphasis"><em>AND</em></span> and <span class="emphasis"><em>OR</em></span> and you may
use brackets, ( and ), to control the operator precedence.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The <a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> you want to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
<td>The search string to send to Zeitgeist</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_range</code></em> :</span></p></td>
<td>Restrict matched events to ones within this time range. If you
are not interested in restricting the timerange pass
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-anytime" title="zeitgeist_time_range_new_anytime ()"><code class="function">zeitgeist_time_range_new_anytime()</code></a> as Zeitgeist will detect this
and optimize the query accordingly</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_templates</code></em> :</span></p></td>
<td>Restrict matches events to ones matching these
templates</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>Offset into the result set to read events from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_events</code></em> :</span></p></td>
<td>Maximal number of events to retrieve</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result_type</code></em> :</span></p></td>
<td>The <a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> determining the sort order.
You may pass <a class="link" href="zeitgeist-1.0-Enumerations.html#ZEITGEIST-RESULT-TYPE-RELEVANCY:CAPS"><span class="type">ZEITGEIST_RESULT_TYPE_RELEVANCY</span></a> to this method
to have the results ordered by relevancy calculated in relation
to <em class="parameter"><code>query</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>A <span class="type">GCancellable</span> used to cancel the call or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>A <span class="type">GAsyncReadyCallback</span> to invoke when the search results are ready</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data to pass back with <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-index-search-finish"></a><h3>zeitgeist_index_search_finish ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="returnvalue">ZeitgeistResultSet</span></a> * zeitgeist_index_search_finish (<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *res</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Retrieve the result from an asynchronous query started with
<a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a>.
</p>
<p>
The total hit count of the query will be available via the returned
result set by calling <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-estimated-matches" title="zeitgeist_result_set_estimated_matches ()"><code class="function">zeitgeist_result_set_estimated_matches()</code></a>. This will
often be bigger than the actual number of events held in the result set,
which is limited by the <em class="parameter"><code>num_events</code></em> parameter passed to
<a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The <a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> to retrieve results from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>res</code></em> :</span></p></td>
<td>The <span class="type">GAsyncResult</span> you received in the <span class="type">GAsyncReadyCallback</span> you passed
to <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A place to store a <span class="type">GError</span> or <code class="literal">NULL</code> in case you want to ignore errors</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> containing the
<a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a>s matching the query. You must free the
result set with <code class="function">g_object_unref()</code>. The events held in the result set
will automatically be unreffed when it is finalized.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-index-search-with-relevancies"></a><h3>zeitgeist_index_search_with_relevancies ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> zeitgeist_index_search_with_relevancies
(<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *event_templates</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistStorageState"><span class="type">ZeitgeistStorageState</span></a> storage_state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> offset</code></em>,
<em class="parameter"><code><span class="type">guint32</span> num_events</code></em>,
<em class="parameter"><code><a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> result_type</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Perform a full text search possibly restricted to a <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>
and/or set of event templates. As opposed to <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a>, this
call will also return numeric relevancies of the events
in the <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a>.
</p>
<p>
See <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a> for more details on how to create the query.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The <a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> you want to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
<td>The search string to send to Zeitgeist</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_range</code></em> :</span></p></td>
<td>Restrict matched events to ones within this time range. If you
are not interested in restricting the timerange pass
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-anytime" title="zeitgeist_time_range_new_anytime ()"><code class="function">zeitgeist_time_range_new_anytime()</code></a> as Zeitgeist will detect this
and optimize the query accordingly</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_templates</code></em> :</span></p></td>
<td>Restrict matched events to ones matching these
templates</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>storage_state</code></em> :</span></p></td>
<td>Filter the events by availability of the storage medium.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>Offset into the result set to read events from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_events</code></em> :</span></p></td>
<td>Maximal number of events to retrieve</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result_type</code></em> :</span></p></td>
<td>The <a class="link" href="zeitgeist-1.0-Enumerations.html#ZeitgeistResultType"><span class="type">ZeitgeistResultType</span></a> determining the sort order.
You may pass <a class="link" href="zeitgeist-1.0-Enumerations.html#ZEITGEIST-RESULT-TYPE-RELEVANCY:CAPS"><span class="type">ZEITGEIST_RESULT_TYPE_RELEVANCY</span></a> to this method
to have the results ordered by relevancy calculated in relation
to <em class="parameter"><code>query</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>A <span class="type">GCancellable</span> used to cancel the call or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>A <span class="type">GAsyncReadyCallback</span> to invoke when the search results are ready</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data to pass back with <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-index-search-with-relevancies-finish"></a><h3>zeitgeist_index_search_with_relevancies_finish ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="returnvalue">ZeitgeistResultSet</span></a>* zeitgeist_index_search_with_relevancies_finish
(<em class="parameter"><code><a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *res</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> **relevancies</code></em>,
<em class="parameter"><code><span class="type">gint</span> *relevancies_size</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Retrieve the result from an asynchronous query started with
<a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-with-relevancies" title="zeitgeist_index_search_with_relevancies ()"><code class="function">zeitgeist_index_search_with_relevancies()</code></a>.
</p>
<p>
The total hit count of the query will be available via the returned
result set by calling <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-estimated-matches" title="zeitgeist_result_set_estimated_matches ()"><code class="function">zeitgeist_result_set_estimated_matches()</code></a>. This will
often be bigger than the actual number of events held in the result set,
which is limited by the <em class="parameter"><code>num_events</code></em> parameter passed to
<a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-with-relevancies" title="zeitgeist_index_search_with_relevancies ()"><code class="function">zeitgeist_index_search_with_relevancies()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The <a class="link" href="ZeitgeistIndex.html" title="ZeitgeistIndex"><span class="type">ZeitgeistIndex</span></a> to retrieve results from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>res</code></em> :</span></p></td>
<td>The <span class="type">GAsyncResult</span> you received in the <span class="type">GAsyncReadyCallback</span> you passed
to <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search-with-relevancies" title="zeitgeist_index_search_with_relevancies ()"><code class="function">zeitgeist_index_search_with_relevancies()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>relevancies</code></em> :</span></p></td>
<td>Location for the newly allocated array
with relevancies. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>relevancies_size</code></em> :</span></p></td>
<td>Location for the size of the newly allocated array. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A place to store a <span class="type">GError</span> or <code class="literal">NULL</code> in case you want to ignore errors</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> containing the
<a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a>s matching the query. You must free the
result set with <code class="function">g_object_unref()</code>. The events held in the result set
will automatically be unreffed when it is finalized.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|