Evolution-Data-Server Manual: Calendar Client (libecal) | ||||
---|---|---|---|---|
Top | Description |
Synopsis
gboolean e_cal_client_check_timezones (icalcomponent *comp
,GList *comps
,icaltimezone* (*tzlookup) (const gchar *tzid, gconstpointer ecalclient, GCancellable *cancellable, GError **error)
,gconstpointer ecalclient
,GCancellable *cancellable
,GError **error
); icaltimezone * e_cal_client_tzlookup (const gchar *tzid
,gconstpointer ecalclient
,GCancellable *cancellable
,GError **error
); icaltimezone * e_cal_client_tzlookup_icomp (const gchar *tzid
,gconstpointer custom
,GCancellable *cancellable
,GError **error
); const gchar * e_cal_match_tzid (const gchar *tzid
); gboolean e_cal_check_timezones (icalcomponent *comp
,GList *comps
,icaltimezone* (*tzlookup) (const gchar *tzid, gconstpointer custom, GError **error)
,gconstpointer custom
,GError **error
); icaltimezone * e_cal_tzlookup_ecal (const gchar *tzid
,gconstpointer custom
,GError **error
); icaltimezone * e_cal_tzlookup_icomp (const gchar *tzid
,gconstpointer custom
,GError **error
);
Details
e_cal_client_check_timezones ()
gboolean e_cal_client_check_timezones (icalcomponent *comp
,GList *comps
,icaltimezone* (*tzlookup) (const gchar *tzid, gconstpointer ecalclient, GCancellable *cancellable, GError **error)
,gconstpointer ecalclient
,GCancellable *cancellable
,GError **error
);
This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE items which are to be imported into Evolution.
Using VTIMEZONE definitions is problematic because they cannot be updated properly when timezone definitions change. They are also incomplete (for compatibility reason only one set of rules for summer saving changes can be included, even if different rules apply in different years). This function looks for matches of the used TZIDs against system timezones and replaces such TZIDs with the corresponding system timezone. This works for TZIDs containing a location (found via a fuzzy string search) and for Outlook TZIDs (via a hard-coded lookup table).
Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, e_cal_get_component_as_string()
fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.
If this mapping fails, this function also deals with VTIMEZONE conflicts: such conflicts occur when the calendar already contains an old VTIMEZONE definition with the same TZID, but different summer saving rules. Replacing the VTIMEZONE potentially breaks displaying of old events, whereas not replacing it breaks the new events (the behavior in Evolution <= 2.22.1).
The way this problem is resolved is by renaming the new VTIMEZONE definition until the TZID is unique. A running count is appended to the TZID. All items referencing the renamed TZID are adapted accordingly.
|
a VCALENDAR containing a list of VTIMEZONE and arbitrary other components, in arbitrary order: these other components are modified by this call |
|
a list of icalcomponent
instances which also have to be patched; may be NULL . [element-type icalcomponent][allow-none]
|
|
a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by e_cal_client_check_timezones()
(to be compatible with e_cal_get_timezone() );
NULL indicates that no such timezone exists
or an error occurred |
|
an arbitrary pointer which is passed through to
the tzlookup function |
|
a GCancellable to use in tzlookup function |
|
an error description in case of a failure |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 3.2
e_cal_client_tzlookup ()
icaltimezone * e_cal_client_tzlookup (const gchar *tzid
,gconstpointer ecalclient
,GCancellable *cancellable
,GError **error
);
An implementation of the tzlookup callback which clients
can use. Calls e_cal_client_get_timezone_sync()
.
|
must be a valid ECalCleint pointer |
Since 3.2
e_cal_client_tzlookup_icomp ()
icaltimezone * e_cal_client_tzlookup_icomp (const gchar *tzid
,gconstpointer custom
,GCancellable *cancellable
,GError **error
);
An implementation of the tzlookup callback which backends like the file backend can use. Searches for the timezone in the component list.
|
must be a icalcomponent pointer which contains either a VCALENDAR with VTIMEZONEs or VTIMEZONES directly |
Since 3.2
e_cal_match_tzid ()
const gchar * e_cal_match_tzid (const gchar *tzid
);
Matches tzid
against the system timezone definitions
and returns the matching TZID, or NULL
if none found
|
a timezone ID |
Since 2.24
e_cal_check_timezones ()
gboolean e_cal_check_timezones (icalcomponent *comp
,GList *comps
,icaltimezone* (*tzlookup) (const gchar *tzid, gconstpointer custom, GError **error)
,gconstpointer custom
,GError **error
);
Warning
e_cal_check_timezones
has been deprecated since version 3.2 and should not be used in newly-written code. Use e_cal_client_check_timezones()
instead.
This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE items which are to be imported into Evolution.
Using VTIMEZONE definitions is problematic because they cannot be updated properly when timezone definitions change. They are also incomplete (for compatibility reason only one set of rules for summer saving changes can be included, even if different rules apply in different years). This function looks for matches of the used TZIDs against system timezones and replaces such TZIDs with the corresponding system timezone. This works for TZIDs containing a location (found via a fuzzy string search) and for Outlook TZIDs (via a hard-coded lookup table).
Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, e_cal_get_component_as_string()
fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.
If this mapping fails, this function also deals with VTIMEZONE conflicts: such conflicts occur when the calendar already contains an old VTIMEZONE definition with the same TZID, but different summer saving rules. Replacing the VTIMEZONE potentially breaks displaying of old events, whereas not replacing it breaks the new events (the behavior in Evolution <= 2.22.1).
The way this problem is resolved is by renaming the new VTIMEZONE definition until the TZID is unique. A running count is appended to the TZID. All items referencing the renamed TZID are adapted accordingly.
|
a VCALENDAR containing a list of VTIMEZONE and arbitrary other components, in arbitrary order: these other components are modified by this call |
|
a list of icalcomponent
instances which also have to be patched; may be NULL . [element-type icalcomponent][allow-none]
|
|
a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by e_cal_check_timezones()
(to be compatible with e_cal_get_timezone() );
NULL indicates that no such timezone exists
or an error occurred. [allow-none]
|
|
an arbitrary pointer which is passed through to the tzlookup function |
|
an error description in case of a failure |
Returns : |
TRUE if successful, FALSE otherwise. |
Since 2.24
e_cal_tzlookup_ecal ()
icaltimezone * e_cal_tzlookup_ecal (const gchar *tzid
,gconstpointer custom
,GError **error
);
Warning
e_cal_tzlookup_ecal
has been deprecated since version 3.2 and should not be used in newly-written code. Use e_cal_client_tzlookup()
instead.
An implementation of the tzlookup callback which clients
can use. Calls e_cal_get_timezone()
.
|
must be a valid ECal pointer |
Since 2.24
e_cal_tzlookup_icomp ()
icaltimezone * e_cal_tzlookup_icomp (const gchar *tzid
,gconstpointer custom
,GError **error
);
Warning
e_cal_tzlookup_icomp
has been deprecated since version 3.2 and should not be used in newly-written code. Use e_cal_client_tzlookup_icomp()
instead.
An implementation of the tzlookup callback which backends like the file backend can use. Searches for the timezone in the component list.
|
must be a icalcomponent pointer which contains either a VCALENDAR with VTIMEZONEs or VTIMEZONES directly |
Since 2.24