/usr/share/gtk-doc/html/evolution-util/EPhotoCache.html is in evolution-dev 3.10.4-0ubuntu1.
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 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EPhotoCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch15.html" title="(Unsorted Sections)">
<link rel="prev" href="EPaned.html" title="EPaned">
<link rel="next" href="EPhotoSource.html" title="EPhotoSource">
<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="EPaned.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch15.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">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="EPhotoSource.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EPhotoCache.synopsis" class="shortcut">Top</a>
|
<a href="#EPhotoCache.description" class="shortcut">Description</a>
|
<a href="#EPhotoCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EPhotoCache.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EPhotoCache.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="EPhotoCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EPhotoCache.top_of_page"></a>EPhotoCache</span></h2>
<p>EPhotoCache — Search for photos by email address</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EPhotoCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <e-util/e-util.h>
struct <a class="link" href="EPhotoCache.html#EPhotoCache-struct" title="struct EPhotoCache">EPhotoCache</a>;
<a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="returnvalue">EPhotoCache</span></a> * <a class="link" href="EPhotoCache.html#e-photo-cache-new" title="e_photo_cache_new ()">e_photo_cache_new</a> (<em class="parameter"><code><a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a> *client_cache</code></em>);
<a class="link" href="EClientCache.html" title="EClientCache"><span class="returnvalue">EClientCache</span></a> * <a class="link" href="EPhotoCache.html#e-photo-cache-ref-client-cache" title="e_photo_cache_ref_client_cache ()">e_photo_cache_ref_client_cache</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EPhotoCache.html#e-photo-cache-add-photo-source" title="e_photo_cache_add_photo_source ()">e_photo_cache_add_photo_source</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="EPhotoCache.html#e-photo-cache-list-photo-sources" title="e_photo_cache_list_photo_sources ()">e_photo_cache_list_photo_sources</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EPhotoCache.html#e-photo-cache-remove-photo-source" title="e_photo_cache_remove_photo_source ()">e_photo_cache_remove_photo_source</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EPhotoCache.html#e-photo-cache-add-photo" title="e_photo_cache_add_photo ()">e_photo_cache_add_photo</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GBytes</span> *bytes</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EPhotoCache.html#e-photo-cache-remove-photo" title="e_photo_cache_remove_photo ()">e_photo_cache_remove_photo</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EPhotoCache.html#e-photo-cache-get-photo-sync" title="e_photo_cache_get_photo_sync ()">e_photo_cache_get_photo_sync</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EPhotoCache.html#e-photo-cache-get-photo" title="e_photo_cache_get_photo ()">e_photo_cache_get_photo</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</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>);
<span class="returnvalue">gboolean</span> <a class="link" href="EPhotoCache.html#e-photo-cache-get-photo-finish" title="e_photo_cache_get_photo_finish ()">e_photo_cache_get_photo_finish</a> (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EPhotoCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EPhotoCache
</pre>
</div>
<div class="refsect1">
<a name="EPhotoCache.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EPhotoCache implements
<a href="../libebackend/EExtensible.html">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EPhotoCache.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EPhotoCache.html#EPhotoCache--client-cache" title='The "client-cache" property'>client-cache</a>" <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="EPhotoCache.description"></a><h2>Description</h2>
<p>
<a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> finds photos associated with an email address.
</p>
<p>
A limited internal cache is employed to speed up frequently searched
email addresses. The exact caching semantics are private and subject
to change.
</p>
</div>
<div class="refsect1">
<a name="EPhotoCache.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EPhotoCache-struct"></a><h3>struct EPhotoCache</h3>
<pre class="programlisting">struct EPhotoCache;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-new"></a><h3>e_photo_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="returnvalue">EPhotoCache</span></a> * e_photo_cache_new (<em class="parameter"><code><a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a> *client_cache</code></em>);</pre>
<p>
Creates a new <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-ref-client-cache"></a><h3>e_photo_cache_ref_client_cache ()</h3>
<pre class="programlisting"><a class="link" href="EClientCache.html" title="EClientCache"><span class="returnvalue">EClientCache</span></a> * e_photo_cache_ref_client_cache (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);</pre>
<p>
Returns the <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a> passed to <a class="link" href="EPhotoCache.html#e-photo-cache-new" title="e_photo_cache_new ()"><code class="function">e_photo_cache_new()</code></a>.
</p>
<p>
The returned <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a> is referenced for thread-safety and must be
unreferenced with <code class="function">g_object_unref()</code> when finished with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-add-photo-source"></a><h3>e_photo_cache_add_photo_source ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_photo_cache_add_photo_source (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>);</pre>
<p>
Adds <em class="parameter"><code>photo_source</code></em> as a potential source of photos.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_source</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-list-photo-sources"></a><h3>e_photo_cache_list_photo_sources ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * e_photo_cache_list_photo_sources (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);</pre>
<p>
Returns a list of photo sources for <em class="parameter"><code>photo_cache</code></em>.
</p>
<p>
The sources returned in the list are referenced for thread-safety.
They must each be unreferenced with <code class="function">g_object_unref()</code> when finished
with them. Free the returned list itself with <code class="function">g_list_free()</code>.
</p>
<p>
An easy way to free the list property in one step is as follows:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function">g_list_free_full</span> <span class="gtkdoc opt">(</span>list<span class="gtkdoc opt">,</span> g_object_unref<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a sorted list of photo sources</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-remove-photo-source"></a><h3>e_photo_cache_remove_photo_source ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_photo_cache_remove_photo_source (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>);</pre>
<p>
Removes <em class="parameter"><code>photo_source</code></em> as a potential source of photos.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_source</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>photo_source</code></em> was found and removed, <code class="literal">FALSE</code> if not</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-add-photo"></a><h3>e_photo_cache_add_photo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_photo_cache_add_photo (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GBytes</span> *bytes</code></em>);</pre>
<p>
Adds a cache entry for <em class="parameter"><code>email_address</code></em>, such that subsequent photo requests
for <em class="parameter"><code>email_address</code></em> will yield a <span class="type">GMemoryInputStream</span> loaded with <em class="parameter"><code>bytes</code></em>
without consulting available photo sources.
</p>
<p>
The <em class="parameter"><code>bytes</code></em> argument can also be <code class="literal">NULL</code> to indicate no photo is available for
<em class="parameter"><code>email_address</code></em>. Subsequent photo requests for <em class="parameter"><code>email_address</code></em> will yield no
input stream.
</p>
<p>
The entry may be removed without notice however, subject to <em class="parameter"><code>photo_cache</code></em>'s
internal caching policy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>email_address</code></em> :</span></p></td>
<td>an email address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bytes</code></em> :</span></p></td>
<td>a <span class="type">GBytes</span> containing photo data, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-remove-photo"></a><h3>e_photo_cache_remove_photo ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_photo_cache_remove_photo (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>);</pre>
<p>
Removes the cache entry for <em class="parameter"><code>email_address</code></em>, if such an entry exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>email_address</code></em> :</span></p></td>
<td>an email address</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if a cache entry was found and removed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-get-photo-sync"></a><h3>e_photo_cache_get_photo_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_photo_cache_get_photo_sync (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Searches available photo sources for a photo associated with
<em class="parameter"><code>email_address</code></em>.
</p>
<p>
If a match is found, a <span class="type">GInputStream</span> from which to read image data is
returned through the <em class="parameter"><code>out_stream</code></em> return location. If no match is found,
the <em class="parameter"><code>out_stream</code></em> return location is set to <code class="literal">NULL</code>.
</p>
<p>
The return value indicates whether the search completed successfully,
not whether a match was found. If an error occurs, the function will
set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>email_address</code></em> :</span></p></td>
<td>an email address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_stream</code></em> :</span></p></td>
<td>return location for a <span class="type">GInputStream</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether the search completed successfully</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-get-photo"></a><h3>e_photo_cache_get_photo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_photo_cache_get_photo (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *email_address</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>
Asynchronously searches available photo sources for a photo associated
with <em class="parameter"><code>email_address</code></em>.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can then
call <a class="link" href="EPhotoCache.html#e-photo-cache-get-photo-finish" title="e_photo_cache_get_photo_finish ()"><code class="function">e_photo_cache_get_photo_finish()</code></a> to get the result of the operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>email_address</code></em> :</span></p></td>
<td>an email address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, 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 call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-cache-get-photo-finish"></a><h3>e_photo_cache_get_photo_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_photo_cache_get_photo_finish (<em class="parameter"><code><a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="EPhotoCache.html#e-photo-cache-get-photo" title="e_photo_cache_get_photo ()"><code class="function">e_photo_cache_get_photo()</code></a>.
</p>
<p>
If a match was found, a <span class="type">GInputStream</span> from which to read image data is
returned through the <em class="parameter"><code>out_stream</code></em> return location. If no match was found,
the <em class="parameter"><code>out_stream</code></em> return location is set to <code class="literal">NULL</code>.
</p>
<p>
The return value indicates whether the search completed successfully,
not whether a match was found. If an error occurred, the function will
set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_cache</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_stream</code></em> :</span></p></td>
<td>return location for a <span class="type">GInputStream</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether the search completed successfully</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EPhotoCache.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EPhotoCache--client-cache"></a><h3>The <code class="literal">"client-cache"</code> property</h3>
<pre class="programlisting"> "client-cache" <a class="link" href="EClientCache.html" title="EClientCache"><span class="type">EClientCache</span></a>* : Read / Write / Construct Only</pre>
<p>
Cache of shared <a href="../libedataserver/EClient.html"><span class="type">EClient</span></a> instances.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|