libecal-2.0

---

Description:

This package is a client library for evolution calendars.

• C-Documentation: https://developer-old.gnome.org/libecal/stable/
• Devhelp-Package download

Content:

Namespaces:

• ECal

Interfaces:

• TimezoneCache

Classes:

• Client - Contains only private data that should be read and manipulated using the functions below.
• ClientTzlookupICalCompData - Contains data used as lookup_data of tzlookup_icalcomp_cb .
• ClientView - Contains only private data that should be read and manipulated using the functions below.
• Component
• ComponentAlarm - Opaque structure, which represents alarm subcomponents.
• ComponentAlarmInstance - Opaque structure, which represents an alarm occurrence, i.
• ComponentAlarmRepeat - A structure holding whether and how an alarm repeats.
• ComponentAlarmTrigger - Opaque structure, which represents when an alarm is supposed to be triggered.
• ComponentAlarms - Opaque structure, which represents alarm trigger instances for a particular component.
• ComponentAttendee - Describes an attendee.
• ComponentDateTime - An opaque structure containing an Time describing the date/time value and also its TZID parameter.
• ComponentId - An opaque structure containing UID of a component and its recurrence ID (which can be null).
• ComponentOrganizer - Describes an organizer.
• ComponentParameterBag - Opaque structure, which represents a bad (list) of Parameter objects.
• ComponentPeriod - Period of time, can have explicit start/end times or start/duration instead.
• ComponentPropertyBag - Opaque structure, which represents a bad (list) of Property objects.
• ComponentRange - Describes a range.
• ComponentText - Contains description string and an alternate representation URI for text properties.
• ReminderData - Contains data related to single reminder occurrence.
• ReminderWatcher - Contains only private data that should be read and manipulated using the functions below.

Enums:

• ClientError
• ClientSourceType - Indicates the type of calendar
• ClientViewFlags - Flags that control the behaviour of an ClientView.
• ComponentAlarmAction - Alarm types
• ComponentAlarmTriggerKind
• ComponentClassification - CLASSIFICATION property
• ComponentPeriodKind - Way in which a period of time is specified
• ComponentRangeKind - The kind of range
• ComponentTransparency - Time transparency
• ComponentVType - Types of calendar components to be stored by a ECalComponent, as per RFC 2445.
• ObjModType - Indicates the type of modification made to a calendar
• OperationFlags - Calendar operation flags, to specify behavior in certain situations.
• RecurDescribeRecurrenceFlags - Influences behaviour of recur_describe_recurrence.
• ReminderWatcherDescribeFlags - Flags modifying behaviour of describe_data.

Constants:

• public const string BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS
  An email address preferred for e-mail reminders by the calendar.
• public const string BACKEND_PROPERTY_CAL_EMAIL_ADDRESS
  An email address associated with the calendar.
• public const string BACKEND_PROPERTY_DEFAULT_OBJECT
  A default object for the calendar.
• public const string BACKEND_PROPERTY_REVISION
  The current overall revision string, this can be used as a quick check to see if data has changed at all since the last time the calendar revision was observed.
• public const string EVOLUTION_ALARM_UID_PROPERTY
  Extension property for alarm components so that we can reference them by UID.
• public const string EVOLUTION_ENDDATE_PARAMETER
  The X parameter name being used to store the enddate in RRULE and EXRULE properties.
• public const int LIBICAL_GLIB_UNSTABLE_API
• public const string STATIC_CAPABILITY_ALARM_DESCRIPTION
  Flag indicating that the backend supports alarm description
• public const string STATIC_CAPABILITY_ALL_DAY_EVENT_AS_TIME
  Let the client know that it should store All Day event times as time with a time zone, rather than as a date.
• public const string STATIC_CAPABILITY_BULK_ADDS
  Flag indicating that the backend supports bulk additions.
• public const string STATIC_CAPABILITY_BULK_MODIFIES
  Flag indicating that the backend supports bulk modifications.
• public const string STATIC_CAPABILITY_BULK_REMOVES
  Flag indicating that the backend supports bulk removals.
• public const string STATIC_CAPABILITY_COMPONENT_COLOR
  When the capability is set, the client supports storing color for individual components.
• public const string STATIC_CAPABILITY_CREATE_MESSAGES
• public const string STATIC_CAPABILITY_DELEGATE_SUPPORTED
• public const string STATIC_CAPABILITY_DELEGATE_TO_MANY
• public const string STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING
• public const string STATIC_CAPABILITY_ITIP_SUPPRESS_ON_REMOVE_SUPPORTED
  Set, when the backend supports e_cal_static_capability_save_schedules and it can suppress iTip message on component removal.
• public const string STATIC_CAPABILITY_NO_ALARM_AFTER_START
  Flag indicating that the backend does not support alarm after start the event
• public const string STATIC_CAPABILITY_NO_ALARM_REPEAT
• public const string STATIC_CAPABILITY_NO_AUDIO_ALARMS
• public const string STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK
• public const string STATIC_CAPABILITY_NO_CONV_TO_RECUR
• public const string STATIC_CAPABILITY_NO_DISPLAY_ALARMS
• public const string STATIC_CAPABILITY_NO_EMAIL_ALARMS
• public const string STATIC_CAPABILITY_NO_GEN_OPTIONS
• public const string STATIC_CAPABILITY_NO_MEMO_START_DATE
• public const string STATIC_CAPABILITY_NO_ORGANIZER
• public const string STATIC_CAPABILITY_NO_PROCEDURE_ALARMS
• public const string STATIC_CAPABILITY_NO_TASK_ASSIGNMENT
• public const string STATIC_CAPABILITY_NO_THISANDFUTURE
• public const string STATIC_CAPABILITY_NO_THISANDPRIOR
• public const string STATIC_CAPABILITY_NO_TRANSPARENCY
• public const string STATIC_CAPABILITY_ONE_ALARM_ONLY
• public const string STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT
• public const string STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND
• public const string STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS
• public const string STATIC_CAPABILITY_RECURRENCES_NO_MASTER
• public const string STATIC_CAPABILITY_REFRESH_SUPPORTED
• public const string STATIC_CAPABILITY_REMOVE_ALARMS
• public const string STATIC_CAPABILITY_REMOVE_ONLY_THIS
  FIXME: Document me.
• public const string STATIC_CAPABILITY_REQ_SEND_OPTIONS
• public const string STATIC_CAPABILITY_RETRACT_SUPPORTED
  Set, when the backend supports retract.
• public const string STATIC_CAPABILITY_SAVE_SCHEDULES
• public const string STATIC_CAPABILITY_SIMPLE_MEMO
  When the capability is set, the backend handles only simple memos, which means it stores only memo description.
• public const string STATIC_CAPABILITY_SIMPLE_MEMO_WITH_SUMMARY
  Similar to the e_cal_static_capability_simple_memo, except the backend stores the description and the summary separately.
• public const string STATIC_CAPABILITY_TASK_CAN_RECUR
  When the capability is set, the client can store and provide recurring tasks, otherwise it cannot.
• public const string STATIC_CAPABILITY_TASK_DATE_ONLY
  Let the client know that the Task Start date, Due date and Completed date can be entered only as dates.
• public const string STATIC_CAPABILITY_TASK_ESTIMATED_DURATION
  Set, when the backend supports ESTIMATED-DURATION property for tasks.
• public const string STATIC_CAPABILITY_TASK_HANDLE_RECUR
  When the capability is set, the backend handles task recurrence completion on its own.
• public const string STATIC_CAPABILITY_TASK_NO_ALARM
  When the capability is set, the client cannot store reminders on tasks, otherwise it can.

Delegates:

• public delegate bool ComponentParameterBagFilterFunc (Parameter parameter)
  A function used to filter which parameters should be added to the bag, when filling it with ComponentParameterBag.from_property and set_from_property.
• public delegate bool ComponentPropertyBagFilterFunc (Property property)
  A function used to filter which properties should be added to the bag, when filling it with ComponentPropertyBag.from_component and set_from_component.
• public delegate void RecurFormatDateTimeFunc (Time itt, string buffer, int buffer_size)
  Format the date/time value from itt into buffer, whose size cannot exceed buffer_size letters.
• public delegate bool RecurInstanceCb (Component icomp, Time instance_start, Time instance_end, Cancellable? cancellable = null) throws Error
  Callback used by recur_generate_instances_sync, called for each instance of a (recurring) component within given time range.
• public delegate unowned Timezone? RecurResolveTimezoneCb (string tzid, Cancellable? cancellable = null) throws Error
  Resolve timezone by its ID provided as tzid.
• public delegate bool UtilForeachCategoryFunc (Component comp, ref string inout_category)
  Function called for each non-empty category from util_foreach_category.

Methods:

• public string isodate_from_time_t (long t)
  Creates an ISO 8601 UTC representation from a time value.
• public unowned string? match_tzid (string tzid)
  Matches tzid against the system timezone definitions and returns the matching TZID, or null if none found
• public string? recur_describe_recurrence (Component icalcomp, DateWeekday week_start_day, uint32 flags)
  Describes some simple types of recurrences in a human-readable and localized way.
• public string? recur_describe_recurrence_ex (Component icalcomp, DateWeekday week_start_day, uint32 flags, RecurFormatDateTimeFunc? datetime_fmt_func)
  Describes some simple types of recurrences in a human-readable and localized way.
• public bool recur_ensure_end_dates (Component comp, bool refresh, RecurResolveTimezoneCb tz_cb, Cancellable? cancellable = null) throws Error
  This recalculates the end dates for recurrence & exception rules which use the COUNT property.
• public bool recur_generate_instances_sync (Component icalcomp, Time interval_start, Time interval_end, RecurInstanceCb? callback, RecurResolveTimezoneCb? get_tz_callback, Timezone default_timezone, Cancellable? cancellable = null) throws Error
  Calls the given callback function for each occurrence of the event that intersects the range between the given start and end times (the end time is not included).
• public unowned string recur_get_localized_nth (int nth)
• public long recur_obtain_enddate (Recurrence ir, Property prop, Timezone zone, bool convert_end_date)
• public string? system_timezone_get_location ()
  Fetches the system timezone location string.
• public long time_add_day (long time, int days)
  Adds a day onto the time, using local time.
• public long time_add_day_with_zone (long time, int days, Timezone zone)
  Adds or subtracts a number of days to/from the given time_t value, using the given timezone.
• public long time_add_month_with_zone (long time, int months, Timezone zone)
  Adds or subtracts a number of months to/from the given time_t value, using the given timezone.
• public long time_add_week (long time, int weeks)
  Adds the given number of weeks to a time value.
• public long time_add_week_with_zone (long time, int weeks, Timezone zone)
  Adds or subtracts a number of weeks to/from the given time_t value, using the given timezone.
• public long time_day_begin (long t)
  Returns the start of the day, according to the local time.
• public long time_day_begin_with_zone (long time, Timezone zone)
  Returns the start of the day containing the given time_t, using the given timezone.
• public long time_day_end (long t)
  Returns the end of the day, according to the local time.
• public long time_day_end_with_zone (long time, Timezone zone)
  Returns the end of the day containing the given time_t, using the given timezone.
• public int time_day_of_week (int day, int month, int year)
  Returns the day of the week for the specified date, 0 (Sun) to 6 (Sat).
• public int time_day_of_year (int day, int month, int year)
  Returns the 1-based day number within the year of the specified date.
• public int time_days_in_month (int year, int month)
  Returns the number of days in the month.
• public long time_from_isodate (string str)
  Converts an ISO 8601 UTC time string into a time_t value.
• public bool time_is_leap_year (int year)
  Returns whether the specified year is a leap year.
• public int time_leap_years_up_to (int year)
  Returns the number of leap years since year 1 up to (but not including) the specified year.
• public long time_month_begin_with_zone (long time, Timezone zone)
  Returns the start of the month containing the given time_t, using the given timezone.
• public void time_to_gdate_with_zone (Date date, long time, Timezone? zone)
  Converts a time_t value to a Date structure using the specified timezone.
• public long time_week_begin_with_zone (long time, int week_start_day, Timezone zone)
  Returns the start of the week containing the given time_t, using the given timezone.
• public long time_year_begin_with_zone (long time, Timezone zone)
  Returns the start of the year containing the given time_t, using the given timezone.
• public void util_add_timezones_from_component (Component vcal_comp, Component icalcomp)
  Adds VTIMEZONE components to a VCALENDAR for all tzid's in the given icalcomp.
• public void util_clamp_vtimezone (ref Component vtimezone, Time from, Time? to)
  Modifies the vtimezone to include only subcomponents influencing the passed-in time interval between from and to.
• public void util_clamp_vtimezone_by_component (ref Component vtimezone, Component component)
  Similar to util_clamp_vtimezone, only reads the clamp times from the component.
• public string? util_component_dup_x_property (Component icalcomp, string x_name)
  Searches for an X property named x_name within X properties of icalcomp and returns its value as a newly allocated string.
• public Property? util_component_find_property_for_locale (Component icalcomp, PropertyKind prop_kind, string? locale)
  Searches properties of kind prop_kind in the icalcomp and returns one, which is usable for the locale.
• public Property? util_component_find_x_property (Component icalcomp, string x_name)
  Searches for an X property named x_name within X properties of icalcomp and returns it.
• public string? util_component_get_recurid_as_string (Component icalcomp)
• public bool util_component_has_alarms (Component icalcomp)
  Checks whether an Component has any alarm.
• public bool util_component_has_attendee (Component icalcomp)
  Checks if an Component has any attendees.
• public bool util_component_has_organizer (Component icalcomp)
  Checks whether an Component has an organizer.
• public bool util_component_has_property (Component icalcomp, PropertyKind prop_kind)
  Returns, whether the icalcomp has a property of prop_kind.
• public bool util_component_has_rdates (Component icalcomp)
  Checks if an Component has recurrence dates.
• public bool util_component_has_recurrences (Component icalcomp)
  Checks if an Component has recurrence dates or rules.
• public bool util_component_has_rrules (Component icalcomp)
  Checks if an Component has recurrence rules.
• public bool util_component_has_x_property (Component icalcomp, string x_name)
  Returns, whether the icalcomp contains X property named x_name.
• public bool util_component_is_instance (Component icalcomp)
  Checks whether an Component is an instance of a recurring appointment.
• public uint util_component_remove_property_by_kind (Component icalcomp, PropertyKind kind, bool all)
  Removes all or only the first property of kind kind in icalcomp.
• public bool util_component_remove_x_property (Component icalcomp, string x_name)
  Removes the first X property named x_name in icalcomp .
• public void util_component_set_x_property (Component icalcomp, string x_name, string? value)
  Sets a value of the first X property named x_name in icalcomp, if any such already exists, or adds a new property with this name and value.
• public uint32 util_conflict_resolution_to_operation_flags (ConflictResolution conflict_resolution)
  Encodes the ConflictResolution into the bit-or of OperationFlags.
• public Component? util_construct_instance (Component icalcomp, Time rid)
  This checks that rid indicates a valid recurrence of icalcomp, and if so, generates a copy of icalcomp containing a RECURRENCE-ID of rid.
• public Timezone util_copy_timezone (Timezone zone)
  Copies the zone together with its inner component and returns it as a new Timezone object.
• public void util_diff_categories (Component? old_comp, Component? new_comp, out HashTable<unowned string,int> out_added, out HashTable<unowned string,int> out_removed)
  Compares list of categories on the old_comp with the list of categories on the new_comp and fills out_added categories and out_removed categories accordingly, as if the old_comp is replaced with the new_comp.
• public bool util_email_addresses_equal (string? email1, string? email2)
  Compares two email addresses and returns whether they are equal.
• public void util_foreach_category (Component comp, UtilForeachCategoryFunc func)
  Calls func for each category stored in the comp.
• public ComponentAlarms? util_generate_alarms_for_comp (Component comp, long start, long end, ComponentAlarmAction omit, RecurResolveTimezoneCb resolve_tzid, Timezone default_timezone)
  Generates alarm instances for a calendar component.
• public int util_generate_alarms_for_list (List<Component> comps, long start, long end, ComponentAlarmAction omit, out SList<ComponentAlarms> comp_alarms, RecurResolveTimezoneCb resolve_tzid, Timezone default_timezone)
  Iterates through all the components in the comps list and generates alarm instances for them; putting them in the comp_alarms list.
• public ComponentAlarms? util_generate_alarms_for_uid_sync (void* client, string uid, long start, long end, ComponentAlarmAction omit, RecurResolveTimezoneCb resolve_tzid, Timezone default_timezone, Cancellable? cancellable = null) throws Error
  Generates alarm instances for a calendar component with UID uid , which is stored within the client.
• public unowned string? util_get_attendee_email (ComponentAttendee? attendee)
  Returns an attendee email, without the "mailto:" prefix, if the attendee has it set.
• public void util_get_component_occur_times (Component comp, out long out_start, out long out_end, RecurResolveTimezoneCb tz_cb, Timezone default_timezone, ComponentKind kind)
  Find out when the component starts and stops, being careful about recurrences.
• public bool util_get_default_name_and_address (SourceRegistry registry, out string out_name, out string out_address)
  Returns the real name and email address of the default mail identity, if available.
• public unowned string? util_get_organizer_email (ComponentOrganizer? organizer)
  Returns an organizer email, without the "mailto:" prefix, if the organizer has it set.
• public unowned string? util_get_property_email (Property prop)
  Returns an prop email, without the "mailto:" prefix, if the prop has it set.
• public unowned Timezone? util_get_system_timezone ()
  Fetches system timezone ICalTimezone object.
• public string? util_get_system_timezone_location ()
  Fetches system timezone localtion string.
• public bool util_has_alarms_in_range (Component comp, long start, long end, ComponentAlarmAction omit, RecurResolveTimezoneCb resolve_tzid, Timezone default_timezone)
  Checks whether the comp has any alarms in the given time interval.
• public tm? util_icaltime_to_tm (Time itt)
  Converts an Time into a GLibc's struct tm.
• public tm? util_icaltime_to_tm_with_zone (Time itt, Timezone from_zone, Timezone to_zone)
  Converts a time value from one timezone to another, and returns a struct tm representation of the time.
• public bool util_init_recur_task_sync (Component vtodo, Client cal_client, Cancellable? cancellable = null) throws Error
  Initializes properties of a recurring vtodo, like normalizing the Due date and eventually the Start date.
• public bool util_inline_local_attachments_sync (Component component, Cancellable? cancellable = null) throws Error
  Changes all URL attachments which point to a local file in component to inline attachments, aka adds the file content into the component.
• public bool util_is_first_instance (Component comp, Time rid, RecurResolveTimezoneCb tz_cb)
  Returns whether the given rid is the first instance of the recurrence defined in the comp.
• public bool util_mark_task_complete_sync (Component vtodo, long completed_time, Client cal_client, Cancellable? cancellable = null) throws Error
  Marks the vtodo as complete with eventual update of other properties.
• public Component util_new_component (ComponentKind kind)
  Creates a new Component of the specified kind.
• public Component util_new_top_level ()
  Creates a new VCALENDAR component.
• public void util_normalize_rrule_until_value (Component icalcomp, Time ttuntil, RecurResolveTimezoneCb tz_cb)
  Makes sure the ttuntil value matches the value type with the DTSTART value, as required by RFC 5545 section 3.3.10.
• public ConflictResolution util_operation_flags_to_conflict_resolution (uint32 flags)
  Decodes the ConflictResolution from the bit-or of OperationFlags.
• public Component? util_parse_ics_file (string filename)
  Parses the given file, and, if it contains a valid iCalendar object, parse it and return a new Component.
• public Component? util_parse_ics_string (string string)
  Parses an iCalendar string and returns a new Component representing that string.
• public int util_priority_from_string (string string)
  Converts a translated priority string to an iCalendar priority value.
• public unowned string util_priority_to_string (int priority)
  Converts an iCalendar PRIORITY value to a translated string.
• public bool util_property_has_parameter (Property prop, ParameterKind param_kind)
  Returns, whether the prop has a parameter of param_kind .
• public void util_remove_instances (Component icalcomp, Time rid, ObjModType mod)
  Removes one or more instances from icalcomp according to rid and mod.
• public void util_remove_instances_ex (Component icalcomp, Time rid, ObjModType mod, RecurResolveTimezoneCb tz_cb)
  Removes one or more instances from icalcomp according to rid and mod.
• public string util_seconds_to_string (int64 seconds)
  Converts time, in seconds, into a string representation readable by humans and localized into the current locale.
• public bool util_set_alarm_acknowledged (Component component, string auid, int64 when)
  Sets the ACKNOWLEDGED property on the component's alarm with UID auid to the time when (in UTC), or to the current time, when the when is 0.
• public Component? util_split_at_instance (Component icalcomp, Time rid, Time? master_dtstart)
  Splits a recurring icalcomp into two at time rid .
• public Component? util_split_at_instance_ex (Component icalcomp, Time rid, Time? master_dtstart, RecurResolveTimezoneCb tz_cb)
  Splits a recurring icalcomp into two at time rid .
• public unowned string util_strip_mailto (string? address)
  Strips "mailto:" prefix from the address, if present.
• public Time util_tm_to_icaltime (tm tm, bool is_date)
  Converts a struct tm into an Time.