/usr/share/gtk-doc/html/evolution-util/evolution-util-EPhotoCache.html is in evolution-dev 3.28.1-2.
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 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 | <!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: Evolution Utilities Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch17.html" title="(Unsorted Sections)">
<link rel="prev" href="evolution-util-EPaned.html" title="EPaned">
<link rel="next" href="evolution-util-EPhotoSource.html" title="EPhotoSource">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#evolution-util-EPhotoCache.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch17.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-util-EPaned.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-util-EPhotoSource.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-util-EPhotoCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-EPhotoCache.top_of_page"></a>EPhotoCache</span></h2>
<p>EPhotoCache — Search for photos by email address</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-util-EPhotoCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="returnvalue">EPhotoCache</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-new" title="e_photo_cache_new ()">e_photo_cache_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="returnvalue">EClientCache</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-ref-client-cache" title="e_photo_cache_ref_client_cache ()">e_photo_cache_ref_client_cache</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-add-photo-source" title="e_photo_cache_add_photo_source ()">e_photo_cache_add_photo_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-list-photo-sources" title="e_photo_cache_list_photo_sources ()">e_photo_cache_list_photo_sources</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-remove-photo-source" title="e_photo_cache_remove_photo_source ()">e_photo_cache_remove_photo_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-add-photo" title="e_photo_cache_add_photo ()">e_photo_cache_add_photo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-remove-photo" title="e_photo_cache_remove_photo ()">e_photo_cache_remove_photo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-get-photo-sync" title="e_photo_cache_get_photo_sync ()">e_photo_cache_get_photo_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-get-photo" title="e_photo_cache_get_photo ()">e_photo_cache_get_photo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-util-EPhotoCache.html#e-photo-cache-get-photo-finish" title="e_photo_cache_get_photo_finish ()">e_photo_cache_get_photo_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-EPhotoCache.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache">EPhotoCache</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-EPhotoCache.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <e-util/e-util.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-util-EPhotoCache.description"></a><h2>Description</h2>
<p><a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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="evolution-util-EPhotoCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-photo-cache-new"></a><h3>e_photo_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="returnvalue">EPhotoCache</span></a> *
e_photo_cache_new (<em class="parameter"><code><a class="link" href="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="type">EClientCache</span></a> *client_cache</code></em>);</pre>
<div class="warning"><p><code class="literal">e_photo_cache_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a new <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a> instance.</p>
<div class="refsect3">
<a name="e-photo-cache-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>client_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="type">EClientCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-new.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p>
</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="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="returnvalue">EClientCache</span></a> *
e_photo_cache_ref_client_cache (<em class="parameter"><code><a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);</pre>
<div class="warning"><p><code class="literal">e_photo_cache_ref_client_cache</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns the <a class="link" href="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="type">EClientCache</span></a> passed to <a class="link" href="evolution-util-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="evolution-util-EClientCache.html#EClientCache" title="struct 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="refsect3">
<a name="e-photo-cache-ref-client-cache.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-ref-client-cache.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="evolution-util-EClientCache.html#EClientCache" title="struct EClientCache"><span class="type">EClientCache</span></a></p>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><span class="type">EPhotoSource</span> *photo_source</code></em>);</pre>
<div class="warning"><p><code class="literal">e_photo_cache_add_photo_source</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Adds <em class="parameter"><code>photo_source</code></em>
as a potential source of photos.</p>
<div class="refsect3">
<a name="e-photo-cache-add-photo-source.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>photo_source</p></td>
<td class="parameter_description"><p>an <span class="type">EPhotoSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>);</pre>
<div class="warning"><p><code class="literal">e_photo_cache_list_photo_sources</code> is deprecated and should not be used in newly-written code.</p></div>
<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>
<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="refsect3">
<a name="e-photo-cache-list-photo-sources.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-list-photo-sources.returns"></a><h4>Returns</h4>
<p> a sorted list of photo sources</p>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a> *photo_cache</code></em>,
<em class="parameter"><code><span class="type">EPhotoSource</span> *photo_source</code></em>);</pre>
<div class="warning"><p><code class="literal">e_photo_cache_remove_photo_source</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Removes <em class="parameter"><code>photo_source</code></em>
as a potential source of photos.</p>
<div class="refsect3">
<a name="e-photo-cache-remove-photo-source.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>photo_source</p></td>
<td class="parameter_description"><p>an <span class="type">EPhotoSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-remove-photo-source.returns"></a><h4>Returns</h4>
<p> <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</p>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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>
<div class="warning"><p><code class="literal">e_photo_cache_add_photo</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-photo-cache-add-photo.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>email_address</p></td>
<td class="parameter_description"><p>an email address</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bytes</p></td>
<td class="parameter_description"><p>a <span class="type">GBytes</span> containing photo data, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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>
<div class="warning"><p><code class="literal">e_photo_cache_remove_photo</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Removes the cache entry for <em class="parameter"><code>email_address</code></em>
, if such an entry exists.</p>
<div class="refsect3">
<a name="e-photo-cache-remove-photo.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>email_address</p></td>
<td class="parameter_description"><p>an email address</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-remove-photo.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if a cache entry was found and removed</p>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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>
<div class="warning"><p><code class="literal">e_photo_cache_get_photo_sync</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-photo-cache-get-photo-sync.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>email_address</p></td>
<td class="parameter_description"><p>an email address</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_stream</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GInputStream</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-get-photo-sync.returns"></a><h4>Returns</h4>
<p> whether the search completed successfully</p>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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>
<div class="warning"><p><code class="literal">e_photo_cache_get_photo</code> is deprecated and should not be used in newly-written code.</p></div>
<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="evolution-util-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="refsect3">
<a name="e-photo-cache-get-photo.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>email_address</p></td>
<td class="parameter_description"><p>an email address</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="evolution-util-EPhotoCache.html#EPhotoCache" title="struct 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 class="warning"><p><code class="literal">e_photo_cache_get_photo_finish</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Finishes the operation started with <a class="link" href="evolution-util-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="refsect3">
<a name="e-photo-cache-get-photo-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>photo_cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-util-EPhotoCache.html#EPhotoCache" title="struct EPhotoCache"><span class="type">EPhotoCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_stream</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GInputStream</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-cache-get-photo-finish.returns"></a><h4>Returns</h4>
<p> whether the search completed successfully</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-util-EPhotoCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EPhotoCache"></a><h3>struct EPhotoCache</h3>
<pre class="programlisting">struct EPhotoCache {
GObject parent;
EPhotoCachePrivate *priv;
};
</pre>
<div class="warning"><p><code class="literal">EPhotoCache</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|