Top |
Functions
Functions
e_cal_backend_cache_new ()
ECalBackendCache *
e_cal_backend_cache_new (const gchar *filename
);
Creates a new ECalBackendCache object, which implements a cache of calendar/tasks objects, very useful for remote backends.
e_cal_backend_cache_get_component ()
ECalComponent * e_cal_backend_cache_get_component (ECalBackendCache *cache
,const gchar *uid
,const gchar *rid
);
Gets a component from the ECalBackendCache
object.
Parameters
cache |
A |
|
uid |
The UID of the component to retrieve. |
|
rid |
Recurrence ID of the specific detached recurrence to retrieve, or NULL if the whole object is to be retrieved. |
Returns
The ECalComponent
representing the component found,
or NULL
if it was not found in the cache.
e_cal_backend_cache_put_component ()
gboolean e_cal_backend_cache_put_component (ECalBackendCache *cache
,ECalComponent *comp
);
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.
e_cal_backend_cache_remove_component ()
gboolean e_cal_backend_cache_remove_component (ECalBackendCache *cache
,const gchar *uid
,const gchar *rid
);
Removes a component from the cache.
Parameters
cache |
An ECalBackendCache object. |
|
uid |
UID of the component to remove. |
|
rid |
Recurrence-ID of the component to remove. This is used when removing detached instances of a recurring appointment. |
e_cal_backend_cache_get_components ()
GList *
e_cal_backend_cache_get_components (ECalBackendCache *cache
);
Retrieves a list of all the components stored in the cache.
Returns
A list of all the components. Each item in the list is an ECalComponent, which should be freed when no longer needed.
e_cal_backend_cache_get_components_by_uid ()
GSList * e_cal_backend_cache_get_components_by_uid (ECalBackendCache *cache
,const gchar *uid
);
Retrieves a ical components from the cache.
e_cal_backend_cache_get_timezone ()
const icaltimezone * e_cal_backend_cache_get_timezone (ECalBackendCache *cache
,const gchar *tzid
);
Retrieves a timezone component from the cache.
e_cal_backend_cache_put_timezone ()
gboolean e_cal_backend_cache_put_timezone (ECalBackendCache *cache
,const icaltimezone *zone
);
Puts the given timezone in the cache, adding it, if it did not exist, or replacing it, if there was an older version.
e_cal_backend_cache_put_default_timezone ()
gboolean e_cal_backend_cache_put_default_timezone (ECalBackendCache *cache
,icaltimezone *default_zone
);
Sets the default timezone on the cache.
e_cal_backend_cache_get_default_timezone ()
icaltimezone *
e_cal_backend_cache_get_default_timezone
(ECalBackendCache *cache
);
Retrieves the default timezone from the cache.
e_cal_backend_cache_get_keys ()
GSList *
e_cal_backend_cache_get_keys (ECalBackendCache *cache
);
Gets the list of unique keys in the cache file.
e_cal_backend_cache_get_marker ()
const gchar *
e_cal_backend_cache_get_marker (ECalBackendCache *cache
);
Gets the marker of the cache. If this field is present, it means the cache has been populated.
e_cal_backend_cache_set_marker ()
void
e_cal_backend_cache_set_marker (ECalBackendCache *cache
);
Marks the cache as populated, to discriminate between an empty calendar and an unpopulated one.
e_cal_backend_cache_put_server_utc_time ()
gboolean e_cal_backend_cache_put_server_utc_time (ECalBackendCache *cache
,const gchar *utc_str
);
e_cal_backend_cache_get_server_utc_time ()
const gchar *
e_cal_backend_cache_get_server_utc_time
(ECalBackendCache *cache
);
e_cal_backend_cache_put_key_value ()
gboolean e_cal_backend_cache_put_key_value (ECalBackendCache *cache
,const gchar *key
,const gchar *value
);
Parameters
cache |
An ECalBackendCache object. |
|
key |
The Key parameter to identify uniquely. |
|
value |
The value for the |
e_cal_backend_cache_get_key_value ()
const gchar * e_cal_backend_cache_get_key_value (ECalBackendCache *cache
,const gchar *key
);
Types and Values
struct ECalBackendCache
struct ECalBackendCache;
Contains only private data that should be read and manipulated using the functions below.
struct ECalBackendCacheClass
struct ECalBackendCacheClass { };
Class structure for the ECalBackendCache.