ECal.ComponentAttendee¶

Fields¶

None

Methods¶

class	`new` ()
class	`new_from_property` (property)
class	`new_full` (value, member, cutype, role, partstat, rsvp, delegatedfrom, delegatedto, sentby, cn, language)
	`copy` ()
	`fill_property` (property)
	`get_as_property` ()
	`get_cn` ()
	`get_cutype` ()
	`get_delegatedfrom` ()
	`get_delegatedto` ()
	`get_language` ()
	`get_member` ()
	`get_parameter_bag` ()
	`get_partstat` ()
	`get_role` ()
	`get_rsvp` ()
	`get_sentby` ()
	`get_value` ()
	`set_cn` (cn)
	`set_cutype` (cutype)
	`set_delegatedfrom` (delegatedfrom)
	`set_delegatedto` (delegatedto)
	`set_from_property` (property)
	`set_language` (language)
	`set_member` (member)
	`set_partstat` (partstat)
	`set_role` (role)
	`set_rsvp` (rsvp)
	`set_sentby` (sentby)
	`set_value` (value)

Details¶

class ECal.ComponentAttendee¶

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

classmethod new()¶

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

Creates a new empty ECal.ComponentAttendee structure. Free it with e_cal_component_attendee_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.ATTENDEE_PROPERTY
Returns:: a newly allocated ECal.ComponentAttendee
Return type:: ECal.ComponentAttendee or None

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

New in version 3.34.

classmethod new_full(value, member, cutype, role, partstat, rsvp, delegatedfrom, delegatedto, sentby, cn, language)¶

Parameters:

value (str or None) – usually a “mailto:email” of the attendee
member (str or None) – member parameter
cutype (ICalGLib.ParameterCutype) – type of the attendee, an ICalGLib.ParameterCutype
role (ICalGLib.ParameterRole) – role of the attendee, an ICalGLib.ParameterRole
partstat (ICalGLib.ParameterPartstat) – current status of the attendee, an ICalGLib.ParameterPartstat
rsvp (bool) – whether requires RSVP
delegatedfrom (str or None) – delegated from
delegatedto (str or None) – delegated to
sentby (str or None) – sent by
cn (str or None) – common name
language (str or None) – language

Returns:

a newly allocated ECal.ComponentAttendee

Return type:

ECal.ComponentAttendee

Creates a new ECal.ComponentAttendee 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_attendee_free(), when no longer needed.

New in version 3.34.

copy()¶

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

Returns a newly allocated copy of self, which should be freed with e_cal_component_attendee_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.ATTENDEE_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.ATTENDEE_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_cutype()¶

Returns:: the self type, as an ICalGLib.ParameterCutype
Return type:: ICalGLib.ParameterCutype

New in version 3.34.

get_delegatedfrom()¶

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

New in version 3.34.

get_delegatedto()¶

Returns:: the self delegatedto 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_member()¶

Returns:: the self member property
Return type:: str or None

New in version 3.34.

get_parameter_bag()¶

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

New in version 3.34.

get_partstat()¶

Returns:: the self status, as an ICalGLib.ParameterPartstat
Return type:: ICalGLib.ParameterPartstat

New in version 3.34.

get_role()¶

Returns:: the self role, as an ICalGLib.ParameterRole
Return type:: ICalGLib.ParameterRole

New in version 3.34.

get_rsvp()¶

Returns:: whether the self requires RSVP
Return type:: bool

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_cutype(cutype)¶

Parameters:: cutype (ICalGLib.ParameterCutype) – the value to set, as an ICalGLib.ParameterCutype

Set the self type, as an ICalGLib.ParameterCutype.

New in version 3.34.

set_delegatedfrom(delegatedfrom)¶

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

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

New in version 3.34.

set_delegatedto(delegatedto)¶

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

Set the self delegatedto 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.ATTENDEE_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_member(member)¶

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

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

New in version 3.34.

set_partstat(partstat)¶

Parameters:: partstat (ICalGLib.ParameterPartstat) – the value to set, as an ICalGLib.ParameterPartstat

Set the self status, as an ICalGLib.ParameterPartstat.

New in version 3.34.

set_role(role)¶

Parameters:: role (ICalGLib.ParameterRole) – the value to set, as an ICalGLib.ParameterRole

Set the self role, as an ICalGLib.ParameterRole.

New in version 3.34.

set_rsvp(rsvp)¶

Parameters:: rsvp (bool) – the value to set

Set the self RSVP.

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.