/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-ECalBackendCache.html is in evolution-data-server-doc 3.28.1-1ubuntu1.
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 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ECalBackendCache: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch09.html" title="Calendar Backend Classes">
<link rel="prev" href="evolution-data-server-ECalBackend.html" title="ECalBackend">
<link rel="next" href="evolution-data-server-ECalBackendFactory.html" title="ECalBackendFactory">
<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-data-server-ECalBackendCache.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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-ECalBackend.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ECalBackendFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-ECalBackendCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-ECalBackendCache.top_of_page"></a>ECalBackendCache</span></h2>
<p>ECalBackendCache — A helper class for caching calendar components</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.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-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="returnvalue">ECalBackendCache</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-new" title="e_cal_backend_cache_new ()">e_cal_backend_cache_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ECalComponent</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-component" title="e_cal_backend_cache_get_component ()">e_cal_backend_cache_get_component</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-put-component" title="e_cal_backend_cache_put_component ()">e_cal_backend_cache_put_component</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-remove-component" title="e_cal_backend_cache_remove_component ()">e_cal_backend_cache_remove_component</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-components" title="e_cal_backend_cache_get_components ()">e_cal_backend_cache_get_components</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-components-by-uid" title="e_cal_backend_cache_get_components_by_uid ()">e_cal_backend_cache_get_components_by_uid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-timezone" title="e_cal_backend_cache_get_timezone ()">e_cal_backend_cache_get_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-put-timezone" title="e_cal_backend_cache_put_timezone ()">e_cal_backend_cache_put_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-put-default-timezone" title="e_cal_backend_cache_put_default_timezone ()">e_cal_backend_cache_put_default_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-default-timezone" title="e_cal_backend_cache_get_default_timezone ()">e_cal_backend_cache_get_default_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-keys" title="e_cal_backend_cache_get_keys ()">e_cal_backend_cache_get_keys</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-marker" title="e_cal_backend_cache_get_marker ()">e_cal_backend_cache_get_marker</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-data-server-ECalBackendCache.html#e-cal-backend-cache-set-marker" title="e_cal_backend_cache_set_marker ()">e_cal_backend_cache_set_marker</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-put-server-utc-time" title="e_cal_backend_cache_put_server_utc_time ()">e_cal_backend_cache_put_server_utc_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-server-utc-time" title="e_cal_backend_cache_get_server_utc_time ()">e_cal_backend_cache_get_server_utc_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-put-key-value" title="e_cal_backend_cache_put_key_value ()">e_cal_backend_cache_put_key_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-get-key-value" title="e_cal_backend_cache_get_key_value ()">e_cal_backend_cache_get_key_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ECalBackendCache.html#e-cal-backend-cache-remove" title="e_cal_backend_cache_remove ()">e_cal_backend_cache_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.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-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache">ECalBackendCache</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCacheClass" title="struct ECalBackendCacheClass">ECalBackendCacheClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedata-cal/libedata-cal.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.description"></a><h2>Description</h2>
<p>This class can be used by backends to store calendar components.</p>
</div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-cal-backend-cache-new"></a><h3>e_cal_backend_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="returnvalue">ECalBackendCache</span></a> *
e_cal_backend_cache_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Creates a new <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object, which implements a cache of
calendar/tasks objects, very useful for remote backends.</p>
<div class="refsect3">
<a name="e-cal-backend-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>filename</p></td>
<td class="parameter_description"><p>filename for cache data</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-component"></a><h3>e_cal_backend_cache_get_component ()</h3>
<pre class="programlisting"><span class="returnvalue">ECalComponent</span> *
e_cal_backend_cache_get_component (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *rid</code></em>);</pre>
<p>Gets a component from the <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><code class="literal">ECalBackendCache</code></a> object.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-component.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>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><code class="literal">ECalBackendCache</code></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The UID of the component to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rid</p></td>
<td class="parameter_description"><p>Recurrence ID of the specific detached recurrence to retrieve,
or NULL if the whole object is to be retrieved.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-component.returns"></a><h4>Returns</h4>
<p> The <code class="literal">ECalComponent</code> representing the component found,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it was not found in the cache.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-put-component"></a><h3>e_cal_backend_cache_put_component ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_put_component (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">ECalComponent</span> *comp</code></em>);</pre>
<p>Puts the given calendar component in the given cache. This will add
the component if it does not exist or replace it if there was a
previous version of it.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-put-component.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>comp</p></td>
<td class="parameter_description"><p>Component to put on the cache.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-put-component.returns"></a><h4>Returns</h4>
<p> TRUE if the operation was successful, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-remove-component"></a><h3>e_cal_backend_cache_remove_component ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_remove_component (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *rid</code></em>);</pre>
<p>Removes a component from the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-remove-component.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>UID of the component to remove.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rid</p></td>
<td class="parameter_description"><p>Recurrence-ID of the component to remove. This is used when removing
detached instances of a recurring appointment.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-remove-component.returns"></a><h4>Returns</h4>
<p> TRUE if the component was removed, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-components"></a><h3>e_cal_backend_cache_get_components ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
e_cal_backend_cache_get_components (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<p>Retrieves a list of all the components stored in the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-components.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-components.returns"></a><h4>Returns</h4>
<p> A list of all the components. Each item in the list is
an <span class="type">ECalComponent</span>, which should be freed when no longer needed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-components-by-uid"></a><h3>e_cal_backend_cache_get_components_by_uid ()</h3>
<pre class="programlisting"><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
e_cal_backend_cache_get_components_by_uid
(<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>Retrieves a ical components from the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-components-by-uid.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>ID of the component to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-components-by-uid.returns"></a><h4>Returns</h4>
<p> The list of calendar components if found, or NULL otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-timezone"></a><h3>e_cal_backend_cache_get_timezone ()</h3>
<pre class="programlisting">const <span class="returnvalue">icaltimezone</span> *
e_cal_backend_cache_get_timezone (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>);</pre>
<p>Retrieves a timezone component from the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-timezone.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>ID of the timezone to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-timezone.returns"></a><h4>Returns</h4>
<p> The timezone if found, or NULL otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-put-timezone"></a><h3>e_cal_backend_cache_put_timezone ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_put_timezone (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>Puts the given timezone in the cache, adding it, if it did not exist, or
replacing it, if there was an older version.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-put-timezone.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>zone</p></td>
<td class="parameter_description"><p>The timezone to put on the cache.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-put-timezone.returns"></a><h4>Returns</h4>
<p> TRUE if the timezone was put on the cache, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-put-default-timezone"></a><h3>e_cal_backend_cache_put_default_timezone ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_put_default_timezone
(<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *default_zone</code></em>);</pre>
<p>Sets the default timezone on the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-put-default-timezone.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_zone</p></td>
<td class="parameter_description"><p>The default timezone.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-put-default-timezone.returns"></a><h4>Returns</h4>
<p> TRUE if the operation was successful, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-default-timezone"></a><h3>e_cal_backend_cache_get_default_timezone ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_cal_backend_cache_get_default_timezone
(<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<p>Retrieves the default timezone from the cache.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-default-timezone.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-default-timezone.returns"></a><h4>Returns</h4>
<p> The default timezone, or NULL if no default timezone
has been set on the cache.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-keys"></a><h3>e_cal_backend_cache_get_keys ()</h3>
<pre class="programlisting"><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
e_cal_backend_cache_get_keys (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<p>Gets the list of unique keys in the cache file.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-keys.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-keys.returns"></a><h4>Returns</h4>
<p> A list of all the keys. The items in the list are pointers
to internal data, so should not be freed, only the list should.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-marker"></a><h3>e_cal_backend_cache_get_marker ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_cal_backend_cache_get_marker (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<p>Gets the marker of the cache. If this field is present, it means the
cache has been populated.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-get-marker.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-marker.returns"></a><h4>Returns</h4>
<p> The value of the marker or NULL if the cache is still empty.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-set-marker"></a><h3>e_cal_backend_cache_set_marker ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cal_backend_cache_set_marker (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<p>Marks the cache as populated, to discriminate between an empty calendar
and an unpopulated one.</p>
<div class="refsect3">
<a name="e-cal-backend-cache-set-marker.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-put-server-utc-time"></a><h3>e_cal_backend_cache_put_server_utc_time ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_put_server_utc_time
(<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *utc_str</code></em>);</pre>
<div class="refsect3">
<a name="e-cal-backend-cache-put-server-utc-time.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>utc_str</p></td>
<td class="parameter_description"><p>UTC string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-put-server-utc-time.returns"></a><h4>Returns</h4>
<p> TRUE if the operation was successful, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-server-utc-time"></a><h3>e_cal_backend_cache_get_server_utc_time ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_cal_backend_cache_get_server_utc_time
(<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>);</pre>
<div class="refsect3">
<a name="e-cal-backend-cache-get-server-utc-time.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-server-utc-time.returns"></a><h4>Returns</h4>
<p> The server's UTC string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-put-key-value"></a><h3>e_cal_backend_cache_put_key_value ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_put_key_value (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<div class="refsect3">
<a name="e-cal-backend-cache-put-key-value.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The Key parameter to identify uniquely.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The value for the <em class="parameter"><code>key</code></em>
parameter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-put-key-value.returns"></a><h4>Returns</h4>
<p> TRUE if the operation was successful, FALSE otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-get-key-value"></a><h3>e_cal_backend_cache_get_key_value ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_cal_backend_cache_get_key_value (<em class="parameter"><code><a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<div class="refsect3">
<a name="e-cal-backend-cache-get-key-value.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>cache</p></td>
<td class="parameter_description"><p>An <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to fetch a value for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-get-key-value.returns"></a><h4>Returns</h4>
<p>The value. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-cache-remove"></a><h3>e_cal_backend_cache_remove ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_backend_cache_remove (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *basename</code></em>);</pre>
<p>Removes the cache directory</p>
<div class="refsect3">
<a name="e-cal-backend-cache-remove.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>dirname</p></td>
<td class="parameter_description"><p>The directory name where the cache is stored</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>basename</p></td>
<td class="parameter_description"><p>The directory inside <em class="parameter"><code>dirname</code></em>
where the cache is stored</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-backend-cache-remove.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ECalBackendCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ECalBackendCache"></a><h3>struct ECalBackendCache</h3>
<pre class="programlisting">struct ECalBackendCache {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
<hr>
<div class="refsect2">
<a name="ECalBackendCacheClass"></a><h3>struct ECalBackendCacheClass</h3>
<pre class="programlisting">struct ECalBackendCacheClass {
};
</pre>
<p>Class structure for the <a class="link" href="evolution-data-server-ECalBackendCache.html#ECalBackendCache" title="struct ECalBackendCache"><span class="type">ECalBackendCache</span></a>.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|