CalComponent

---

Object Hierarchy:

Description:

Content:

Static methods:

• public static void free_attendee_list (SList<CalComponentAttendee> attendee_list)
  Frees a list of CalComponentAttendee structures.
• public static void free_categories_list (SList<string> categ_list)
  Frees a list of category strings.
• public static void free_datetime (CalComponentDateTime dt)
  Frees a date/time structure.
• public static void free_exdate_list (SList<CalComponentDateTime> exdate_list)
  Frees a list of CalComponentDateTime structures as returned by the get_exdate_list function.
• public static void free_geo (void* geo)
  Frees a struct icalgeotype structure as returned by the calendar component functions.
• public static void free_icaltimetype (void* t)
  Frees a struct icaltimetype value as returned by the calendar component functions.
• public static void free_id (CalComponentId id)
  Frees the id.
• public static void free_percent (int percent)
  Frees a percent value as returned by the get_percent function.
• public static void free_period_list (SList<CalComponentPeriod> period_list)
  Frees a list of CalComponentPeriod structures.
• public static void free_priority (int priority)
  Frees a priority value as returned by the get_priority function.
• public static void free_range (CalComponentRange range)
  Frees an CalComponentRange structure.
• public static void free_sequence (int sequence)
  Frees a sequence number value.
• public static void free_text_list (SList<CalComponentText> text_list)
  Frees a list of CalComponentText structures.
• public static string gen_uid ()
  Generates a unique identifier suitable for calendar components.

Creation methods:

• public CalComponent ()
  Creates a new empty calendar component object.
• public CalComponent.from_string (string calobj)
  Creates a new calendar component object from the given iCalendar string.

Methods:

• public void abort_sequence ()
  Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via commit_sequence) even if the changes done require a sequence increment.
• public void add_alarm (CalComponentAlarm alarm)
  Adds an alarm subcomponent to a calendar component.
• public CalComponent clone ()
  Creates a new calendar component object by copying the information from another one.
• public void commit_sequence ()
  Increments the sequence number property in a calendar component object if it needs it.
• public bool event_dates_match (CalComponent comp2)
  Checks if the DTSTART and DTEND properties of the 2 components match.
• public List<string> get_alarm_uids ()
  Builds a list of the unique identifiers of the alarm subcomponents inside a calendar component.
• public string get_as_string ()
  Gets the iCalendar string representation of a calendar component.
• public void get_attachment_list (out SList<string> attachment_list)
  Queries the attachment properties of the calendar component object.
• public void get_attendee_list (out SList<CalComponentAttendee> attendee_list)
  Queries the attendee properties of the calendar component object
• public void get_categories (string categories)
  Queries the categories of the given calendar component.
• public void get_categories_list (out SList<string> categ_list)
  Queries the list of categories of a calendar component object.
• public void get_classification (CalComponentClassification classif)
  Queries the classification of a calendar component object.
• public void get_comment_list (out SList<CalComponentText> text_list)
  Queries the comments of a calendar component object.
• public void get_completed (void* t)
  Queries the date at which a calendar compoment object was completed.
• public void get_contact_list (out SList<CalComponentText> text_list)
  Queries the contact of a calendar component object.
• public void get_created (void* t)
  Queries the date in which a calendar component object was created in the calendar store.
• public void get_description_list (out SList<CalComponentText> text_list)
  Queries the description of a calendar component object.
• public void get_dtend (CalComponentDateTime dt)
  Queries the date/time end of a calendar component object.
• public void get_dtstamp (void* t)
  Queries the date/timestamp property of a calendar component object, which is the last time at which the object was modified by a calendar user agent.
• public void get_dtstart (CalComponentDateTime dt)
  Queries the date/time start of a calendar component object.
• public void get_due (CalComponentDateTime dt)
  Queries the due date/time of a calendar component object.
• public void get_exdate_list (out SList<CalComponentDateTime> exdate_list)
  Queries the list of exception date properties in a calendar component object.
• public void get_geo (void* geo)
  Gets the geographic position property of a calendar component object.
• public void get_last_modified (void* t)
  Queries the time at which a calendar component object was last modified in the calendar store.
• public void get_location (string location)
  Queries the location property of a calendar component object.
• public int get_num_attachments ()
  Get the number of attachments to this calendar component object.
• public void get_organizer (CalComponentOrganizer organizer)
  Queries the organizer property of a calendar component object
• public void get_percent (int percent)
  Queries the percent-complete property of a calendar component object.
• public int get_percent_as_int ()
• public void get_priority (int priority)
  Queries the priority property of a calendar component object.
• public void get_rdate_list (out SList<CalComponentPeriod> period_list)
  Queries the list of recurrence date properties in a calendar component object.
• public void get_recurid (CalComponentRange recur_id)
  Queries the recurrence id property of a calendar component object.
• public string get_recurid_as_string ()
  Gets the recurrence ID property as a string.
• public void get_sequence (int sequence)
  Queries the sequence number of a calendar component object.
• public void get_summary (CalComponentText summary)
  Queries the summary of a calendar component object.
• public void get_transparency (CalComponentTransparency transp)
  Queries the time transparency of a calendar component object.
• public void get_uid (string uid)
  Queries the unique identifier of a calendar component object.
• public void get_url (string url)
  Queries the uniform resource locator property of a calendar component object.
• public CalComponentVType get_vtype ()
  Queries the type of a calendar component object.
• public bool has_alarms ()
  Checks whether the component has any alarms.
• public bool has_attachments ()
  Queries the component to see if it has attachments.
• public bool has_attendees ()
  Queries a calendar component object for the existence of attendees.
• public bool has_exceptions ()
  Queries whether a calendar component object has any exception dates or exception rules.
• public bool has_exdates ()
  Queries whether a calendar component object has any exception dates defined for it.
• public bool has_exrules ()
  Queries whether a calendar component object has any exception rules defined for it.
• public bool has_organizer ()
  Check whether a calendar component object has an organizer or not.
• public bool has_rdates ()
  Queries whether a calendar component object has any recurrence dates defined for it.
• public bool has_recurrences ()
  Queries whether a calendar component object has any recurrence dates or recurrence rules.
• public bool has_rrules ()
  Queries whether a calendar component object has any recurrence rules defined for it.
• public bool has_simple_recurrence ()
  Checks whether the given calendar component object has simple recurrence rules or more complicated ones.
• public bool is_instance ()
  Checks whether a calendar component object is an instance of a recurring event.
• public void remove_alarm (string auid)
  Removes an alarm subcomponent from a calendar component.
• public void remove_all_alarms ()
  Remove all alarms from the calendar component
• public void rescan ()
  Rescans the icalcomponent being wrapped by the given calendar component.
• public void set_attachment_list (SList<string> attachment_list)
  This currently handles only attachments that are URIs in the file system - not inline binaries.
• public void set_attendee_list (SList<CalComponentAttendee> attendee_list)
  Sets the attendees of a calendar component object
• public void set_categories (string categories)
  Sets the list of categories for a calendar component.
• public void set_categories_list (SList<string> categ_list)
  Sets the list of categories of a calendar component object.
• public void set_classification (CalComponentClassification classif)
  Sets the classification property of a calendar component object.
• public void set_comment_list (SList<CalComponentText> text_list)
  Sets the comments of a calendar component object.
• public void set_completed (void* t)
  Sets the date at which a calendar component object was completed.
• public void set_contact_list (SList<CalComponentText> text_list)
  Sets the contact of a calendar component object.
• public void set_created (void* t)
  Sets the date in which a calendar component object is created in the calendar store.
• public void set_dtend (CalComponentDateTime dt)
  Sets the date/time end property of a calendar component object.
• public void set_dtstamp (void* t)
  Sets the date/timestamp of a calendar component object.
• public void set_dtstart (CalComponentDateTime dt)
  Sets the date/time start property of a calendar component object.
• public void set_due (CalComponentDateTime dt)
  Sets the due date/time property of a calendar component object.
• public void set_exdate_list (SList<CalComponentDateTime> exdate_list)
  Sets the list of exception dates in a calendar component object.
• public void set_geo (void* geo)
  Sets the geographic position property on a calendar component object.
• public bool set_icalcomponent (long icalcomp)
  Sets the contents of a calendar component object from an icalcomponent structure.
• public void set_last_modified (void* t)
  Sets the time at which a calendar component object was last stored in the calendar store.
• public void set_location (string location)
  Sets the location property of a calendar component object.
• public void set_new_vtype (CalComponentVType type)
  Clears any existing component data from a calendar component object and creates a new icalcomponent of the specified type for it.
• public void set_organizer (CalComponentOrganizer organizer)
  Sets the organizer of a calendar component object
• public void set_percent (int percent)
  Sets the percent-complete property of a calendar component object.
• public void set_percent_as_int (int percent)
• public void set_priority (int priority)
  Sets the priority property of a calendar component object.
• public void set_rdate_list (SList<CalComponentPeriod> period_list)
  Sets the list of recurrence dates in a calendar component object.
• public void set_recurid (CalComponentRange recur_id)
  Sets the recurrence id property of a calendar component object.
• public void set_sequence (int sequence)
  Sets the sequence number of a calendar component object.
• public void set_summary (CalComponentText summary)
  Sets the summary of a calendar component object.
• public void set_transparency (CalComponentTransparency transp)
  Sets the time transparency of a calendar component object.
• public void set_uid (string uid)
  Sets the unique identifier string of a calendar component object.
• public void set_url (string url)
  Sets the uniform resource locator property of a calendar component object.
• public void strip_errors ()
  Strips all error messages from the calendar component.

Inherited Members: