/usr/share/gtk-doc/html/libtracker-miner/libtracker-miner-TrackerMinerWeb.html is in libtracker-miner-doc 0.14.0-2ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TrackerMinerWeb</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Tracker Miner Library Reference Manual">
<link rel="up" href="ch02.html" title="Base abstract miner classes">
<link rel="prev" href="TrackerMiner.html" title="TrackerMiner">
<link rel="next" href="ch03.html" title="Miner classes for file system">
<meta name="generator" content="GTK-Doc V1.18 (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="TrackerMiner.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">Tracker Miner Library Reference Manual</th>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libtracker-miner-TrackerMinerWeb.synopsis" class="shortcut">Top</a>
|
<a href="#libtracker-miner-TrackerMinerWeb.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libtracker-miner-TrackerMinerWeb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libtracker-miner-TrackerMinerWeb.top_of_page"></a>TrackerMinerWeb</span></h2>
<p>TrackerMinerWeb — Abstract base class for miners using web services</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libtracker-miner-TrackerMinerWeb.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libtracker-miner/tracker-miner.h>
#define <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TRACKER-MINER-WEB-DBUS-INTERFACE:CAPS" title="TRACKER_MINER_WEB_DBUS_INTERFACE">TRACKER_MINER_WEB_DBUS_INTERFACE</a>
#define <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TRACKER-MINER-WEB-ERROR:CAPS" title="TRACKER_MINER_WEB_ERROR">TRACKER_MINER_WEB_ERROR</a>
#define <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TRACKER-MINER-WEB-ERROR-DOMAIN:CAPS" title="TRACKER_MINER_WEB_ERROR_DOMAIN">TRACKER_MINER_WEB_ERROR_DOMAIN</a>
typedef <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb">TrackerMinerWeb</a>;
<a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWebClass" title="TrackerMinerWebClass">TrackerMinerWebClass</a>;
enum <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWebError" title="enum TrackerMinerWebError">TrackerMinerWebError</a>;
<span class="returnvalue">void</span> <a class="link" href="libtracker-miner-TrackerMinerWeb.html#tracker-miner-web-associate" title="tracker_miner_web_associate ()">tracker_miner_web_associate</a> (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *association_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libtracker-miner-TrackerMinerWeb.html#tracker-miner-web-authenticate" title="tracker_miner_web_authenticate ()">tracker_miner_web_authenticate</a> (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libtracker-miner-TrackerMinerWeb.html#tracker-miner-web-dissociate" title="tracker_miner_web_dissociate ()">tracker_miner_web_dissociate</a> (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="libtracker-miner-TrackerMinerWeb.html#tracker-miner-web-error-quark" title="tracker_miner_web_error_quark ()">tracker_miner_web_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="libtracker-miner-TrackerMinerWeb.html#tracker-miner-web-get-association-data" title="tracker_miner_web_get_association_data ()">tracker_miner_web_get_association_data</a>
(<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerMinerWeb.description"></a><h2>Description</h2>
<p>
<a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> is an abstract base class for miners retrieving data
from web services. It's a very thin layer above <a class="link" href="TrackerMiner.html" title="TrackerMiner"><span class="type">TrackerMiner</span></a>, only
adding virtual methods needed to handle association with the remote
service.
</p>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerMinerWeb.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TRACKER-MINER-WEB-DBUS-INTERFACE:CAPS"></a><h3>TRACKER_MINER_WEB_DBUS_INTERFACE</h3>
<pre class="programlisting">#define TRACKER_MINER_WEB_DBUS_INTERFACE "org.freedesktop.Tracker1.MinerWeb"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TRACKER-MINER-WEB-ERROR:CAPS"></a><h3>TRACKER_MINER_WEB_ERROR</h3>
<pre class="programlisting">#define TRACKER_MINER_WEB_ERROR tracker_miner_web_error_quark ()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TRACKER-MINER-WEB-ERROR-DOMAIN:CAPS"></a><h3>TRACKER_MINER_WEB_ERROR_DOMAIN</h3>
<pre class="programlisting">#define TRACKER_MINER_WEB_ERROR_DOMAIN "TrackerMinerWeb"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TrackerMinerWeb"></a><h3>TrackerMinerWeb</h3>
<pre class="programlisting">typedef struct TrackerMinerWeb TrackerMinerWeb;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TrackerMinerWebClass"></a><h3>TrackerMinerWebClass</h3>
<pre class="programlisting">typedef struct {
TrackerMinerClass parent_class;
/* vmethods */
void (* authenticate) (TrackerMinerWeb *miner,
GError **error);
GHashTable* (* get_association_data) (TrackerMinerWeb *miner,
GError **error);
void (* associate) (TrackerMinerWeb *miner,
const GHashTable *association_data,
GError **error);
void (* dissociate) (TrackerMinerWeb *miner,
GError **error);
} TrackerMinerWebClass;
</pre>
<p>
For the <em class="parameter"><code>authenticate</code></em> function, a username/password can be used and
this should return an empty <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a>. If the authentication is
based on a token, the following keys <span class="emphasis"><em>must</em></span> be
returned in the <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a>:
</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
<span class="emphasis"><em>url</em></span>: the url to point the user to.
</p></li></ul></div>
<p>
</p>
<p>
Additionally, the miner <span class="emphasis"><em>may</em></span> define the
following keys:
</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
<span class="emphasis"><em>post_message</em></span>: a message to display after
the user completes the association process.
</p></li>
<li class="listitem"><p>
<span class="emphasis"><em>post_url</em></span>: a url to point the user to
after they have completed the association.
</p></li>
</ul></div>
<p>
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
If both <span class="emphasis"><em>post_message</em></span> and
<span class="emphasis"><em>post_url</em></span> are defined, the message will be
displayed before the url is opened.
</p>
</div>
<p>
</p>
<p>
For the <em class="parameter"><code>associate</code></em> function, in the case of a username/password
based authentication, the following keys must be defined:
</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
<span class="emphasis"><em>username</em></span>: the username.
</p></li>
<li class="listitem"><p>
<span class="emphasis"><em>password</em></span>: the password.
</p></li>
</ul></div>
<p>
</p>
<p>
In the case of a token based authentication, the <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a> can be
ignored since it will be empty.
</p>
<p>
For the <em class="parameter"><code>dissociate</code></em> function, miners <span class="emphasis"><em>must</em></span>
forget any user credentials stored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="TrackerMiner.html#TrackerMinerClass" title="TrackerMinerClass"><span class="type">TrackerMinerClass</span></a> <em class="structfield"><code><a name="TrackerMinerWebClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>parent object class</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TrackerMinerWebClass.authenticate"></a>authenticate</code></em> ()</span></p></td>
<td>called when a miner must authenticate against a
remote service</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TrackerMinerWebClass.get-association-data"></a>get_association_data</code></em> ()</span></p></td>
<td>called when one requests the miner's
associated data</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TrackerMinerWebClass.associate"></a>associate</code></em> ()</span></p></td>
<td>called when the miner is asked to associate a remote
service</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TrackerMinerWebClass.dissociate"></a>dissociate</code></em> ()</span></p></td>
<td>called when the miner is asked to revoke an
association with a remote service</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8.</p>
</div>
<hr>
<div class="refsect2">
<a name="TrackerMinerWebError"></a><h3>enum TrackerMinerWebError</h3>
<pre class="programlisting">typedef enum {
TRACKER_MINER_WEB_ERROR_WRONG_CREDENTIALS,
TRACKER_MINER_WEB_ERROR_TOKEN_EXPIRED,
TRACKER_MINER_WEB_ERROR_NO_CREDENTIALS,
TRACKER_MINER_WEB_ERROR_KEYRING,
TRACKER_MINER_WEB_ERROR_SERVICE,
TRACKER_MINER_WEB_ERROR_TRACKER
} TrackerMinerWebError;
</pre>
<p>
The following errors are possible during any of the performed
actions with a remote service.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-WRONG-CREDENTIALS:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_WRONG_CREDENTIALS</code></span></p></td>
<td>The credentials were
refused by the remote service
</td>
</tr>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-TOKEN-EXPIRED:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_TOKEN_EXPIRED</code></span></p></td>
<td>The remote service
token has expired
</td>
</tr>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-NO-CREDENTIALS:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_NO_CREDENTIALS</code></span></p></td>
<td>There are currenty no
credentials stored for this service
</td>
</tr>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-KEYRING:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_KEYRING</code></span></p></td>
<td>The credential storage failed to
retrieve the relevant information. See <code class="classname">TrackerPasswordProvider</code>
</td>
</tr>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-SERVICE:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_SERVICE</code></span></p></td>
<td>Could not contact the remote service
</td>
</tr>
<tr>
<td><p><a name="TRACKER-MINER-WEB-ERROR-TRACKER:CAPS"></a><span class="term"><code class="literal">TRACKER_MINER_WEB_ERROR_TRACKER</code></span></p></td>
<td>Could not contact the Tracker service
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-miner-web-associate"></a><h3>tracker_miner_web_associate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tracker_miner_web_associate (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *association_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Asks <em class="parameter"><code>miner</code></em> to associate with a remote service using
<em class="parameter"><code>association_data</code></em>. To know what data to put into <em class="parameter"><code>association_data</code></em>,
see <code class="classname">TrackerMinerWebClass</code> for more
information.
</p>
<p>
On failure <em class="parameter"><code>error</code></em> will be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>miner</code></em> :</span></p></td>
<td>a <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>association_data</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a> with the data to use for
associating with a remote service.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> callee-allocates][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-miner-web-authenticate"></a><h3>tracker_miner_web_authenticate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tracker_miner_web_authenticate (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Asks <em class="parameter"><code>miner</code></em> to authenticate with a remote service. On failure
<em class="parameter"><code>error</code></em> will be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>miner</code></em> :</span></p></td>
<td>a <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> callee-allocates][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-miner-web-dissociate"></a><h3>tracker_miner_web_dissociate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tracker_miner_web_dissociate (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Asks <em class="parameter"><code>miner</code></em> to dissociate from a remote service. At this point, the
miner should stop storing any credentials or sensitive information
which could be used to authenticate with the remote service.
</p>
<p>
On failure <em class="parameter"><code>error</code></em> will be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>miner</code></em> :</span></p></td>
<td>a <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> callee-allocates][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-miner-web-error-quark"></a><h3>tracker_miner_web_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> tracker_miner_web_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> used to identify miner web errors in GError
structures.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-miner-web-get-association-data"></a><h3>tracker_miner_web_get_association_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * tracker_miner_web_get_association_data
(<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a> *miner</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Asks <em class="parameter"><code>miner</code></em> to retrieve association_data for. The data returned in
the <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a> depends on the <em class="parameter"><code>miner</code></em> implementation and the type
of authentication. See <code class="classname">TrackerMinerWebClass</code>
for more information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>miner</code></em> :</span></p></td>
<td>a <a class="link" href="libtracker-miner-TrackerMinerWeb.html#TrackerMinerWeb" title="TrackerMinerWeb"><span class="type">TrackerMinerWeb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> callee-allocates][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><code class="literal">GHashTable</code></a> with the data. On failure <em class="parameter"><code>error</code></em> will be set
and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|