ECal.Component¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_from_icalcomponent` (icalcomp)
class	`new_from_string` (calobj)
class	`new_vtype` (vtype)
	`abort_sequence` ()
	`add_alarm` (alarm)
	`clone` ()
	`commit_sequence` ()
	`dup_comment_for_locale` (locale)
	`dup_description_for_locale` (locale)
	`dup_summaries` ()
	`dup_summary_for_locale` (locale)
	`get_alarm` (auid)
	`get_alarm_uids` ()
	`get_all_alarms` ()
	`get_as_string` ()
	`get_attachments` ()
	`get_attendees` ()
	`get_categories` ()
	`get_categories_list` ()
	`get_classification` ()
	`get_comments` ()
	`get_completed` ()
	`get_contacts` ()
	`get_created` ()
	`get_descriptions` ()
	`get_dtend` ()
	`get_dtstamp` ()
	`get_dtstart` ()
	`get_due` ()
	`get_exdates` ()
	`get_exrule_properties` ()
	`get_exrules` ()
	`get_geo` ()
	`get_icalcomponent` ()
	`get_id` ()
	`get_last_modified` ()
	`get_location` ()
	`get_organizer` ()
	`get_percent_complete` ()
	`get_priority` ()
	`get_rdates` ()
	`get_recurid` ()
	`get_recurid_as_string` ()
	`get_rrule_properties` ()
	`get_rrules` ()
	`get_sequence` ()
	`get_status` ()
	`get_summary` ()
	`get_transparency` ()
	`get_uid` ()
	`get_url` ()
	`get_vtype` ()
	`has_alarms` ()
	`has_attachments` ()
	`has_attendees` ()
	`has_exceptions` ()
	`has_exdates` ()
	`has_exrules` ()
	`has_organizer` ()
	`has_rdates` ()
	`has_recurrences` ()
	`has_rrules` ()
	`has_simple_recurrence` ()
	`is_instance` ()
	`remove_alarm` (auid)
	`remove_all_alarms` ()
	`set_attachments` (attachments)
	`set_attendees` (attendee_list)
	`set_categories` (categories)
	`set_categories_list` (categ_list)
	`set_classification` (classif)
	`set_comments` (text_list)
	`set_completed` (tt)
	`set_contacts` (text_list)
	`set_created` (tt)
	`set_descriptions` (text_list)
	`set_dtend` (dt)
	`set_dtstamp` (tt)
	`set_dtstart` (dt)
	`set_due` (dt)
	`set_exdates` (exdate_list)
	`set_exrules` (recur_list)
	`set_geo` (geo)
	`set_icalcomponent` (icalcomp)
	`set_last_modified` (tt)
	`set_location` (location)
	`set_new_vtype` (type)
	`set_organizer` (organizer)
	`set_percent_complete` (percent)
	`set_priority` (priority)
	`set_rdates` (rdate_list)
	`set_recurid` (recur_id)
	`set_rrules` (recur_list)
	`set_sequence` (sequence)
	`set_status` (status)
	`set_summaries` (text_list)
	`set_summary` (summary)
	`set_transparency` (transp)
	`set_uid` (uid)
	`set_url` (url)
	`strip_errors` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class ECal.Component(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: ECal.ComponentClass

classmethod new()¶

Returns:: A newly-created calendar component object.
Return type:: ECal.Component

Creates a new empty calendar component object. Once created, you should set it from an existing #icalcomponent structure by using ECal.Component.set_icalcomponent() or with a new empty component type by using ECal.Component.set_new_vtype().

New in version 3.34.

classmethod new_from_icalcomponent(icalcomp)¶

Parameters:: icalcomp (ICalGLib.Component) – An ICalGLib.Component to use
Returns:: An ECal.Component with icalcomp assigned on success, None if the icalcomp cannot be assigned to ECal.Component.
Return type:: ECal.Component or None

Creates a new ECal.Component which will has set icalcomp as an inner ICalGLib.Component. The newly created ECal.Component takes ownership of the icalcomp, and if the call to ECal.Component.set_icalcomponent() fails, then icalcomp is freed.

New in version 3.34.

classmethod new_from_string(calobj)¶

Parameters:: calobj (str) – A string representation of an iCalendar component.
Returns:: A calendar component representing the given iCalendar string on success, None if there was an error.
Return type:: ECal.Component or None

Creates a new calendar component object from the given iCalendar string.

New in version 3.34.

classmethod new_vtype(vtype)¶

Parameters:: vtype (ECal.ComponentVType) – an ECal.ComponentVType
Returns:: A newly-created calendar component object with set vtype.
Return type:: ECal.Component

Creates a new ECal.Component of type vtype.

New in version 3.34.

abort_sequence()¶: Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via ECal.Component.commit_sequence()) even if the changes done require a sequence increment.

New in version 3.34.

add_alarm(alarm)¶

Parameters:: alarm (ECal.ComponentAlarm) – an alarm, as an ECal.ComponentAlarm

Adds an alarm subcomponent to a calendar component. You should have created the alarm by using ECal.ComponentAlarm.new(); it is invalid to use an ECal.ComponentAlarm structure that came from ECal.Component.get_alarm(). After adding the alarm, the alarm structure is no longer valid because the internal structures may change and you should get rid of it by using e_cal_component_alarm_free().

New in version 3.34.

clone()¶

Returns:: A newly-created calendar component with the same values as the original one.
Return type:: ECal.Component

Creates a new calendar component object by copying the information from another one.

New in version 3.34.

commit_sequence()¶

Increments the sequence number property in a calendar component object if it needs it. This needs to be done when any of a number of properties listed in RFC 2445 change values, such as the start and end dates of a component.

This function must be called before calling ECal.Component.get_as_string() to ensure that the component is fully consistent.

New in version 3.34.

dup_comment_for_locale(locale)¶

Parameters:: locale (str or None) – a locale identifier, or None
Returns:: comment for the locale, None if no comment is set on the self.
Return type:: ECal.ComponentText or None

Returns a comment for the given locale. When locale is None, the current locale is assumed. If no such comment for the locale exists either a comment with no language parameter or the first found is returned.

Free the returned non-None ECal.ComponentText with e_cal_component_text_free(), when no longer needed.

New in version 3.46.

dup_description_for_locale(locale)¶

Parameters:: locale (str or None) – a locale identifier, or None
Returns:: description for the locale, None if no description is set on the self.
Return type:: ECal.ComponentText or None

Returns a description for the given locale. When locale is None, the current locale is assumed. If no such description for the locale exists either a description with no language parameter or the first found is returned.

Free the returned non-None ECal.ComponentText with e_cal_component_text_free(), when no longer needed.

New in version 3.46.

dup_summaries()¶

Returns:: the summary properties and their parameters, as a GLib.SList of ECal.ComponentText structures.
Return type:: [ECal.ComponentText] or None

Queries the summary of a calendar component object. There can be one summary property per locale. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.

New in version 3.46.

dup_summary_for_locale(locale)¶

Parameters:: locale (str or None) – a locale identifier, or None
Returns:: summary for the locale, None if no summary is set on the self.
Return type:: ECal.ComponentText or None

Returns a summary for the given locale. When locale is None, the current locale is assumed. If no such summary for the locale exists either a summary with no language parameter or the first found is returned.

Free the returned non-None ECal.ComponentText with e_cal_component_text_free(), when no longer needed.

New in version 3.46.

get_alarm(auid)¶

Parameters:: auid (str) – Unique identifier for the sought alarm subcomponent.
Returns:: the alarm subcomponent that corresponds to the specified auid, or None if no alarm exists with that UID
Return type:: ECal.ComponentAlarm or None

Queries a particular alarm subcomponent of a calendar component. Free the returned pointer with e_cal_component_alarm_free(), when no longer needed.

New in version 3.34.

get_alarm_uids()¶

Returns:: a GLib.SList of unique identifiers for alarms.
Return type:: [str] or None

Builds a list of the unique identifiers of the alarm subcomponents inside a calendar component. Free the returned GLib.SList with g_slist_free_full (slist, GLib.free);, when no longer needed.

New in version 3.34.

get_all_alarms()¶

Returns:: the alarm subcomponents as a GLib.SList of ECal.ComponentAlarm, or None, if no alarm exists
Return type:: [ECal.ComponentAlarm] or None

Queries all alarm subcomponents of a calendar component. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_alarm_free);, when no longer needed.

New in version 3.34.

get_as_string()¶

Returns:: String representation of the calendar component according to RFC 2445.
Return type:: str

Gets the iCalendar string representation of a calendar component. You should call ECal.Component.commit_sequence() before this function to ensure that the component’s sequence number is consistent with the state of the object.

New in version 3.34.

get_attachments()¶

Returns:: a GLib.SList of attachments, as ICalGLib.Attach objects
Return type:: [ICalGLib.Attach] or None

Queries the attachment properties as ICalGLib.Attach objects of the calendar component object. Changes on these objects are directly affecting the component. Free the returned GLib.SList with g_slist_free_full (slist, GObject.Object.unref);, when no longer needed.

New in version 3.34.

get_attendees()¶

Returns:: the attendees, as a GLib.SList of an ECal.ComponentAttendee, or None, when none are set
Return type:: [ECal.ComponentAttendee] or None

Queries the attendee properties of the calendar component object. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_attendee_free);, when no longer needed.

New in version 3.34.

get_categories()¶

Returns:: the categories as string, or None if none are set
Return type:: str or None

Queries the categories of the given calendar component. The categories are returned in the categories argument, which, on success, will contain a comma-separated list of all categories set in the component. Free the returned string with GLib.free(), when no longer needed.

New in version 3.34.

get_categories_list()¶

Returns:: the GLib.SList of strings, where each string is a category, or None, when no category is set.
Return type:: [str] or None

Queries the list of categories of a calendar component object. Each element in the returned categ_list is a string with the corresponding category. Free the returned GLib.SList with g_slist_free_full (categories, GLib.free); , when no longer needed.

New in version 3.34.

get_classification()¶

Return type:: ECal.ComponentClassification

Queries the classification of a calendar component object. If the classification property is not set on this component, this function returns ECal.ComponentClassification.NONE.

Retuurns: a classification of the self, as an ECal.ComponentClassification

New in version 3.34.

get_comments()¶

Returns:: the comment properties and their parameters, as a list of ECal.ComponentText structures; or None, when the component doesn’t contain any.
Return type:: [ECal.ComponentText] or None

Queries the comments of a calendar component object. The comment property can appear several times inside a calendar component, and so a list of ECal.ComponentText is returned. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.

New in version 3.34.

get_completed()¶

Returns:: the completion date, as an ICalGLib.Time, or None, when none is set
Return type:: ICalGLib.Time or None

Queries the date at which a calendar compoment object was completed. Free the returned non-None pointer with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_contacts()¶

Returns:: the contact properties and their parameters, as a GLib.SList of ECal.ComponentText structures.
Return type:: [ECal.ComponentText]

Queries the contact of a calendar component object. The contact property can appear several times inside a calendar component, and so a list of ECal.ComponentText is returned. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.

New in version 3.34.

get_created()¶

Returns:: the creation date, as an ICalGLib.Time, or None, when none is set
Return type:: ICalGLib.Time or None

Queries the date in which a calendar component object was created in the calendar store. Free the returned non-None pointer with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_descriptions()¶

Returns:: the description properties and their parameters, as a GLib.SList of ECal.ComponentText structures.
Return type:: [ECal.ComponentText] or None

Queries the description of a calendar component object. Journal components may have more than one description, and as such this function returns a list of ECal.ComponentText structures. All other types of components can have at most one description for a single language. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.

New in version 3.34.

get_dtend()¶

Returns:: the date/time end, as an ECal.ComponentDateTime
Return type:: ECal.ComponentDateTime or None

Queries the date/time end of a calendar component object. In case there’s no DTEND, but only DTSTART and DURATION, then the end is computed from the later two. Free the returned ECal.ComponentDateTime with e_cal_component_datetime_free(), when no longer needed.

New in version 3.34.

get_dtstamp()¶

Returns:: A value for the date/timestamp, or None, when none found.
Return type:: ICalGLib.Time or None

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.

Free a non-None returned object with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_dtstart()¶

Returns:: the date/time start, as an ECal.ComponentDateTime
Return type:: ECal.ComponentDateTime or None

Queries the date/time start of a calendar component object. Free the returned ECal.ComponentDateTime with e_cal_component_datetime_free(), when no longer needed.

New in version 3.34.

get_due()¶

Returns:: the due date/time, as an ECal.ComponentDateTime
Return type:: ECal.ComponentDateTime or None

Queries the due date/time of a calendar component object. In case there’s no DUE, but only DTSTART and DURATION, then the due is computed from the later two. Free the returned ECal.ComponentDateTime with e_cal_component_datetime_free(), when no longer needed.

New in version 3.34.

get_exdates()¶

Returns:: the list of exception dates, as a GLib.SList of ECal.ComponentDateTime
Return type:: [ECal.ComponentDateTime] or None

Queries the list of exception date properties in a calendar component object. Free the returned GLib.SList with g_slist_free_full (exdates, e_cal_component_datetime_free);, when no longer needed.

New in version 3.34.

get_exrule_properties()¶

Returns:: a list of exception rule properties
Return type:: [ICalGLib.Property] or None

Queries the list of exception rule properties of a calendar component object. Free the list with g_slist_free_full (slist, GObject.Object.unref);, when no longer needed.

New in version 3.34.

get_exrules()¶

Returns:: a GLib.SList of exception rules as ICalGLib.Recurrence structures, or None, when none exist.
Return type:: [ICalGLib.Recurrence] or None

Queries the list of exception rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, GObject.Object.unref);, when no longer needed.

New in version 3.34.

get_geo()¶

Returns:: the geographic position as ICalGLib.Geo, or None, when none set.
Return type:: ICalGLib.Geo or None

Gets the geographic position property of a calendar component object. Free the returned non-None object with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_icalcomponent()¶

Returns:: An ICalGLib.Component structure, or None if the self has no ICalGLib.Component set to it.
Return type:: ICalGLib.Component or None

Queries the #icalcomponent structure that a calendar component object is wrapping.

New in version 3.34.

get_id()¶

Returns:: the id of the component
Return type:: ECal.ComponentId

Get the ID of the component as an ECal.ComponentId. The return value should be freed with e_cal_component_id_free(), when no longer needed.

New in version 3.34.

get_last_modified()¶

Returns:: the last modified time, as an ICalGLib.Time, or None, when none is set
Return type:: ICalGLib.Time or None

Queries the time at which a calendar component object was last modified in the calendar store. Free the returned non-None pointer with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_location()¶

Returns:: the locatio, or None, if none is set
Return type:: str or None

Queries the location property of a calendar component object.

New in version 3.34.

get_organizer()¶

Returns:: an ECal.ComponentOrganizer structure destribing the organizer, or None, when none exists.
Return type:: ECal.ComponentOrganizer or None

Queries the organizer property of a calendar component object. Free the returned structure with e_cal_component_organizer_free(), when no longer needed.

New in version 3.34.

get_percent_complete()¶

Returns:: the percent-complete property value, or -1 if not found
Return type:: int

Queries the percent-complete property of a calendar component object.

New in version 3.34.

get_priority()¶

Returns:: the priority property value, or -1, if not found
Return type:: int

Queries the priority property of a calendar component object.

New in version 3.34.

get_rdates()¶

Returns:: the list of recurrence dates, as a GLib.SList of ECal.ComponentPeriod structures.
Return type:: [ECal.ComponentPeriod] or None

Queries the list of recurrence date properties in a calendar component object. Free the returned GLib.SList with g_slist_free_full (slist, e_cal_component_period_free);, when no longer needed.

New in version 3.34.

get_recurid()¶

Returns:: the recurrence id property, as an ECal.ComponentRange
Return type:: ECal.ComponentRange or None

Queries the recurrence id property of a calendar component object. Free the returned ECal.ComponentRange with e_cal_component_range_free(), whe no longer needed.

New in version 3.34.

get_recurid_as_string()¶

Returns:: the recurrence ID as a string.
Return type:: str

Gets the recurrence ID property as a string.

New in version 3.34.

get_rrule_properties()¶

Returns:: a list of recurrence rule properties
Return type:: [ICalGLib.Property] or None

Queries a list of recurrence rule properties of a calendar component object. Free the list with g_slist_free_full (slist, GObject.Object.unref);, when no longer needed.

New in version 3.34.

get_rrules()¶

Returns:: a GLib.SList of recurrence rules as ICalGLib.Recurrence structures, or None, when none exist.
Return type:: [ICalGLib.Recurrence] or None

Queries the list of recurrence rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, GObject.Object.unref);, when no longer needed.

New in version 3.34.

get_sequence()¶

Returns:: the sequence number, or -1 if not found
Return type:: int

Queries the sequence number of a calendar component object.

New in version 3.34.

get_status()¶

Returns:: the status value; or ICalGLib.PropertyStatus.NONE, if the component has no status property
Return type:: ICalGLib.PropertyStatus

Queries the status property of a calendar component object.

New in version 3.34.

get_summary()¶

Returns:: the summary, as an ECal.ComponentText, or None, when none is set
Return type:: ECal.ComponentText or None

Queries the summary of a calendar component object. It returns the first found summary property of the component. To get a summary suitable for a specific locale use ECal.Component.dup_summary_for_locale().

Free the returned pointer withe_cal_component_text_free(), when no longer needed.

New in version 3.34.

get_transparency()¶

Returns:: the time transparency, as an ECal.ComponentTransparency; value ECal.ComponentTransparency.NONE is returned when none is set
Return type:: ECal.ComponentTransparency

Queries the time transparency of a calendar component object.

New in version 3.34.

get_uid()¶

Returns:: the UID string
Return type:: str

Queries the unique identifier of a calendar component object.

New in version 3.34.

get_url()¶

Returns:: the URL, or None, when none is set
Return type:: str or None

Queries the uniform resource locator property of a calendar component object. Free the returned URL with GLib.free(), when no longer needed.

New in version 3.34.

get_vtype()¶

Returns:: The type of the component, as defined by RFC 2445.
Return type:: ECal.ComponentVType

Queries the type of a calendar component object.

New in version 3.34.

has_alarms()¶

Returns:: True if the component has any alarms.
Return type:: bool

Checks whether the component has any alarms.

New in version 3.34.

has_attachments()¶

Returns:: True if there are attachments, False otherwise.
Return type:: bool

Queries the component to see if it has attachments.

New in version 3.34.

has_attendees()¶

Returns:: True if there are attendees, False if not.
Return type:: bool

Queries a calendar component object for the existence of attendees.

New in version 3.34.

has_exceptions()¶

Returns:: True if the component has exceptions, False otherwise.
Return type:: bool

Queries whether a calendar component object has any exception dates or exception rules.

New in version 3.34.

has_exdates()¶

Returns:: True if the component has exception dates, False otherwise.
Return type:: bool

Queries whether a calendar component object has any exception dates defined for it.

New in version 3.34.

has_exrules()¶

Returns:: True if the component has exception rules, False otherwise.
Return type:: bool

Queries whether a calendar component object has any exception rules defined for it.

New in version 3.34.

has_organizer()¶

Returns:: True if there is an organizer, False otherwise.
Return type:: bool

Check whether a calendar component object has an organizer or not.

New in version 3.34.

has_rdates()¶

Returns:: True if the component has recurrence dates, False otherwise.
Return type:: bool

Queries whether a calendar component object has any recurrence dates defined for it.

New in version 3.34.

has_recurrences()¶

Returns:: True if the component has recurrences, False otherwise.
Return type:: bool

Queries whether a calendar component object has any recurrence dates or recurrence rules.

New in version 3.34.

has_rrules()¶

Returns:: True if the component has recurrence rules, False otherwise.
Return type:: bool

Queries whether a calendar component object has any recurrence rules defined for it.

New in version 3.34.

has_simple_recurrence()¶

Returns:: True if it has a simple recurrence rule, False otherwise.
Return type:: bool

Checks whether the given calendar component object has simple recurrence rules or more complicated ones.

New in version 3.34.

is_instance()¶

Returns:: True if it is an instance, False if not.
Return type:: bool

Checks whether a calendar component object is an instance of a recurring event.

New in version 3.34.

remove_alarm(auid)¶

Parameters:: auid (str) – UID of the alarm to remove.

Removes an alarm subcomponent from a calendar component. If the alarm that corresponds to the specified auid had been fetched with ECal.Component.get_alarm(), then those alarm structures will be invalid; you should get rid of them with e_cal_component_alarm_free() before using this function.

New in version 3.34.

remove_all_alarms()¶: Remove all alarms from the calendar component

New in version 3.34.

set_attachments(attachments)¶

Parameters:: attachments ([ICalGLib.Attach] or None) – a GLib.SList of an ICalGLib.Attach, or None to remove any existing

Sets the attachments of the calendar component object.

New in version 3.34.

set_attendees(attendee_list)¶

Parameters:: attendee_list ([ECal.ComponentAttendee] or None) – Values for attendee properties, or None to unset

Sets the attendees of a calendar component object

New in version 3.34.

set_categories(categories)¶

Parameters:: categories (str) – Comma-separated list of categories.

Sets the list of categories for a calendar component.

New in version 3.34.

set_categories_list(categ_list)¶

Parameters:: categ_list ([str]) – List of strings, one for each category.

Sets the list of categories of a calendar component object.

New in version 3.34.

set_classification(classif)¶

Parameters:: classif (ECal.ComponentClassification) – Classification to use.

Sets the classification property of a calendar component object. To unset the property, specify ECal.ComponentClassification.NONE for classif.

New in version 3.34.

set_comments(text_list)¶

Parameters:: text_list ([ECal.ComponentText]) – List of ECal.ComponentText structures.

Sets the comments of a calendar component object. The comment property can appear several times inside a calendar component, and so a list of ECal.ComponentText structures is used.

New in version 3.34.

set_completed(tt)¶

Parameters:: tt (ICalGLib.Time or None) – Value for the completion date.

Sets the date at which a calendar component object was completed.

New in version 3.34.

set_contacts(text_list)¶

Parameters:: text_list ([ECal.ComponentText]) – List of ECal.ComponentText structures.

Sets the contact of a calendar component object. The contact property can appear several times inside a calendar component, and so a list of ECal.ComponentText structures is used.

New in version 3.34.

set_created(tt)¶

Parameters:: tt (ICalGLib.Time or None) – Value for the creation date.

Sets the date in which a calendar component object is created in the calendar store. This should only be used inside a calendar store application, i.e. not by calendar user agents.

New in version 3.34.

set_descriptions(text_list)¶

Parameters:: text_list ([ECal.ComponentText]) – List of ECal.ComponentText structures.

Sets the description of a calendar component object. Journal components may have more than one description, and as such this function takes in a list of ECal.ComponentText structures. All other types of components can have at most one description.

New in version 3.34.

set_dtend(dt)¶

Parameters:: dt (ECal.ComponentDateTime or None) – End date/time, or None, to remove the property.

Sets the date/time end property of a calendar component object.

New in version 3.34.

set_dtstamp(tt)¶

Parameters:: tt (ICalGLib.Time) – Date/timestamp value.

Sets the date/timestamp of a calendar component object. This should be called whenever a calendar user agent makes a change to a component’s properties.

New in version 3.34.

set_dtstart(dt)¶

Parameters:: dt (ECal.ComponentDateTime or None) – Start date/time, or None, to remove the property.

Sets the date/time start property of a calendar component object.

New in version 3.34.

set_due(dt)¶

Parameters:: dt (ECal.ComponentDateTime or None) – End date/time, or None, to remove the property.

Sets the due date/time property of a calendar component object.

New in version 3.34.

set_exdates(exdate_list)¶

Parameters:: exdate_list ([ECal.ComponentDateTime] or None) – List of ECal.ComponentDateTime structures.

Sets the list of exception dates in a calendar component object.

New in version 3.34.

set_exrules(recur_list)¶

Parameters:: recur_list ([ICalGLib.Recurrence] or None) – a GLib.SList of ICalGLib.Recurrence structures, or None.

Sets the list of exception rules in a calendar component object.

New in version 3.34.

set_geo(geo)¶

Parameters:: geo (ICalGLib.Geo or None) – Value for the geographic position property, or None to unset.

Sets the geographic position property on a calendar component object.

New in version 3.34.

set_icalcomponent(icalcomp)¶

Parameters:: icalcomp (ICalGLib.Component or None) – An ICalGLib.Component.
Returns:: True on success, False if icalcomp is an unsupported component type.
Return type:: bool

Sets the contents of a calendar component object from an ICalGLib.Component. If the self already had an ICalGLib.Component set into it, it will be freed automatically.

Supported component types are VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE.

New in version 3.34.

set_last_modified(tt)¶

Parameters:: tt (ICalGLib.Time or None) – Value for the last time modified.

Sets the time at which a calendar component object was last stored in the calendar store. This should not be called by plain calendar user agents.

New in version 3.34.

set_location(location)¶

Parameters:: location (str or None) – Location value. Use None or empty string, to unset the property.

Sets the location property of a calendar component object.

New in version 3.34.

set_new_vtype(type)¶

Parameters:: type (ECal.ComponentVType) – Type of calendar component to create.

Clears any existing component data from a calendar component object and creates a new ICalGLib.Component of the specified type for it. The only property that will be set in the new component will be its unique identifier.

New in version 3.34.

set_organizer(organizer)¶

Parameters:: organizer (ECal.ComponentOrganizer or None) – Value for the organizer property, as an ECal.ComponentOrganizer

Sets the organizer of a calendar component object

New in version 3.34.

set_percent_complete(percent)¶

Parameters:: percent (int) – a percent to set, or -1 to remove the property

Sets percent complete. The percent can be between 0 and 100, inclusive. A special value -1 can be used to remove the percent complete property.

New in version 3.34.

set_priority(priority)¶

Parameters:: priority (int) – Value for the priority property.

Sets the priority property of a calendar component object. The priority can be between 0 and 9, inclusive. A special value -1 can be used to remove the priority property.

New in version 3.34.

set_rdates(rdate_list)¶

Parameters:: rdate_list ([ECal.ComponentPeriod] or None) – List of ECal.ComponentPeriod structures, or None to set none

Sets the list of recurrence dates in a calendar component object.

New in version 3.34.

set_recurid(recur_id)¶

Parameters:: recur_id (ECal.ComponentRange or None) – Value for the recurrence id property, or None, to remove the property.

Sets the recurrence id property of a calendar component object.

New in version 3.34.

set_rrules(recur_list)¶

Parameters:: recur_list ([ICalGLib.Recurrence] or None) – List of ICalGLib.Recurrence structures, or None.

Sets the list of recurrence rules in a calendar component object.

New in version 3.34.

set_sequence(sequence)¶

Parameters:: sequence (int) – a sequence number to set, or -1 to remove the property

Sets the sequence number of a calendar component object. A special value -1 can be used to remove the sequence number property.

Normally this function should not be called, since the sequence number is incremented automatically at the proper times.

New in version 3.34.

set_status(status)¶

Parameters:: status (ICalGLib.PropertyStatus) – Status value, as an ICalGLib.PropertyStatus. Use ICalGLib.PropertyStatus.NONE, to unset the property

Sets the status property of a calendar component object.

New in version 3.34.

set_summaries(text_list)¶

Parameters:: text_list ([ECal.ComponentText]) – List of ECal.ComponentText structures.

Sets the summary of a calendar component object. The summaries can have each different language, otherwise it’s not allowed to have more than one summary property.

This does not update any alarm subcomponent description.

New in version 3.46.

set_summary(summary)¶

Parameters:: summary (ECal.ComponentText) – Summary property and its parameters.

Sets the summary of a calendar component object.

This also updates any alarm subcomponent descriptions, if needed.

New in version 3.34.

set_transparency(transp)¶

Parameters:: transp (ECal.ComponentTransparency) – Time transparency value.

Sets the time transparency of a calendar component object. Use ECal.ComponentTransparency.NONE to unset the property.

New in version 3.34.

set_uid(uid)¶

Parameters:: uid (str) – Unique identifier.

Sets the unique identifier string of a calendar component object.

New in version 3.34.

set_url(url)¶

Parameters:: url (str or None) – URL value.

Sets the uniform resource locator property of a calendar component object. A None or an empty string removes the property.

New in version 3.34.

strip_errors()¶: Strips all error messages from the calendar component. Those error messages are added to the iCalendar string representation whenever an invalid is used for one of its fields.

New in version 3.34.