ECal.ComponentOrganizer¶

Fields¶

None

Methods¶

class	`new` ()
class	`new_from_property` (property)
class	`new_full` (value, sentby, cn, language)
	`copy` ()
	`fill_property` (property)
	`get_as_property` ()
	`get_cn` ()
	`get_language` ()
	`get_parameter_bag` ()
	`get_sentby` ()
	`get_value` ()
	`set_cn` (cn)
	`set_from_property` (property)
	`set_language` (language)
	`set_sentby` (sentby)
	`set_value` (value)

Details¶

class ECal.ComponentOrganizer¶

Describes an organizer. Use the functions below to work with it.

classmethod new()¶

Returns:: a newly allocated ECal.ComponentOrganizer
Return type:: ECal.ComponentOrganizer

Creates a new empty ECal.ComponentOrganizer structure. Free it with e_cal_component_organizer_free(), when no longer needed.

New in version 3.34.

classmethod new_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property of kind ICalGLib.PropertyKind.ORGANIZER_PROPERTY
Returns:: a newly allocated ECal.ComponentOrganizer
Return type:: ECal.ComponentOrganizer or None

Creates a new ECal.ComponentOrganizer, filled with values from property, which should be of kind ICalGLib.PropertyKind.ORGANIZER_PROPERTY. The function returns None when it is not of the expected kind. Free the structure with e_cal_component_organizer_free(), when no longer needed.

New in version 3.34.

classmethod new_full(value, sentby, cn, language)¶

Parameters:

value (str or None) – usually a “mailto:email” of the organizer
sentby (str or None) – sent by
cn (str or None) – common name
language (str or None) – language

Returns:

a newly allocated ECal.ComponentOrganizer

Return type:

ECal.ComponentOrganizer

Creates a new ECal.ComponentOrganizer structure, with all members filled with given values from the parameters. The None and empty strings are treated as unset the value. Free the structure with e_cal_component_organizer_free(), when no longer needed.

New in version 3.34.

copy()¶

Returns:: a newly allocated copy of self
Return type:: ECal.ComponentOrganizer

Returns a newly allocated copy of self, which should be freed with e_cal_component_organizer_free(), when no longer needed.

New in version 3.34.

fill_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property
Returns:: an ICalGLib.Property
Return type:: property: ICalGLib.Property

Fill property with information from self. The property should be of kind ICalGLib.PropertyKind.ORGANIZER_PROPERTY.

New in version 3.34.

get_as_property()¶

Returns:: a newly created ICalGLib.Property, containing information from the self.
Return type:: ICalGLib.Property

Converts information stored in self into an ICalGLib.Property of ICalGLib.PropertyKind.ORGANIZER_PROPERTY kind. The caller is responsible to free the returned object with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_cn()¶

Returns:: the self common name (cn) parameter
Return type:: str or None

New in version 3.34.

get_language()¶

Returns:: the self language parameter
Return type:: str or None

New in version 3.34.

get_parameter_bag()¶

Returns:: an ECal.ComponentParameterBag with additional parameters stored with the organizer property, other than those accessible with the other functions of the self.
Return type:: ECal.ComponentParameterBag

New in version 3.34.

get_sentby()¶

Returns:: the self sentby parameter
Return type:: str or None

New in version 3.34.

get_value()¶

Returns:: the self URI, usually of “mailto:email” form
Return type:: str or None

New in version 3.34.

set_cn(cn)¶

Parameters:: cn (str or None) – the value to set

Set the self common name (cn) parameter. The None and empty strings are treated as unset the value.

New in version 3.34.

set_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property

Fill the self structure with the information from the property, which should be of ICalGLib.PropertyKind.ORGANIZER_PROPERTY kind.

New in version 3.34.

set_language(language)¶

Parameters:: language (str or None) – the value to set

Set the self language parameter. The None and empty strings are treated as unset the value.

New in version 3.34.

set_sentby(sentby)¶

Parameters:: sentby (str or None) – the value to set

Set the self sentby parameter. The None and empty strings are treated as unset the value.

New in version 3.34.

set_value(value)¶

Parameters:: value (str or None) – the value to set

Set the self URI, usually of “mailto:email” form. The None and empty strings are treated as unset the value.

New in version 3.34.