| evolution-kolab_calendar Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
KolabUtilCalendarCacheKolabUtilCalendarCache — Utility methods for Evolution-Kolab calendar backend implementation with ECalBackendCache side effects. |
KolabUtilCalendarCacheClass; KolabUtilCalendarCache; ECalComponent * kolab_util_calendar_cache_get_tz (ECalBackendCache *cache,ECalComponent *comp); ECalComponent * kolab_util_calendar_cache_get_object (ECalBackendCache *cal_cache,KolabMailAccess *koma,const gchar *uri,const gchar *uid,gboolean bulk,GError **error); ECalComponent * kolab_util_calendar_cache_remove_instance (ECalBackendCache *cal_cache,CalObjModType mod,ECalComponent *ecalcomp,const gchar *uid,const gchar *rid); gboolean kolab_util_calendar_cache_assure_uid_on_ecalcomponent (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *uri,ECalComponent *ecalcomp,gboolean bulk,GError **error); void kolab_util_calendar_cache_update_on_query (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *query,const gchar *uri); void kolab_util_calendar_cache_update_object (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *uri,const gchar *uid,gboolean bulk,GError **error);
The methods in KolabUtilCalendarCache are supposed to update the ECalBackendCache as a side effect to their primary task or retrieve data from the cache to fulfill its task.
typedef struct {
GObjectClass parent_class;
} KolabUtilCalendarCacheClass;
ECalComponent * kolab_util_calendar_cache_get_tz (ECalBackendCache *cache,ECalComponent *comp);
|
An ECalComponent (Some calendar entry). |
|
An Cache. |
Returns : |
An ECalComponent containing a timezone or NULL if none is found.
.
The tzid of the ECalComponent DTSTART property is used to extract timezone
information from the supplied backend cache. The ECalComponent returned
should be freed, using g_object_unref(), once no longer needed. Note:
Events may not provide a timezone/TZID (like UTC)!
|
ECalComponent * kolab_util_calendar_cache_get_object (ECalBackendCache *cal_cache,KolabMailAccess *koma,const gchar *uri,const gchar *uid,gboolean bulk,GError **error);
Retrieves the the object referenced by uid from the given cal_cache. If
none is found, NULL is returned.
|
An Cache. |
|
A KolabMailAccess object. |
|
An ECalComponent uri string. |
|
The uid to search for. |
|
Whether or not this is a mass operation. |
|
GError placeholder. |
Returns : |
An ECalComponent containing the object. Unref if no longer needed. |
ECalComponent * kolab_util_calendar_cache_remove_instance (ECalBackendCache *cal_cache,CalObjModType mod,ECalComponent *ecalcomp,const gchar *uid,const gchar *rid);
Removes an instance of an event with recurrence.
|
An ECalBackendCache. |
|
CalObjModType to apply to the remove request. |
|
The object before the removal took place. |
|
The UID of the recurring event. |
|
The recurrence ID of the recurrence. |
Returns : |
The modified component. |
gboolean kolab_util_calendar_cache_assure_uid_on_ecalcomponent (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *uri,ECalComponent *ecalcomp,gboolean bulk,GError **error);
Sets a new uid to ecalcomp and assures, that it is not used in koma, so far.
|
An ECalBackendCache. |
|
A KolabMailAccess instance. |
|
An ECalComponent uri string. |
|
An ECalComponent. |
|
Whether or not this is a mass operation. |
|
GError placeholder. |
Returns : |
On Success TRUE is returned. |
void kolab_util_calendar_cache_update_on_query (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *query,const gchar *uri);
void kolab_util_calendar_cache_update_object (ECalBackendCache *cache,KolabMailAccess *koma,const gchar *uri,const gchar *uid,gboolean bulk,GError **error);