Class ComponentAttendee

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

record

Hierarchy

ComponentAttendee

Constructors

constructor

new ComponentAttendee(): ComponentAttendee

- Defined in @types/Gjs/ECal-2.0.d.ts:3935
Creates a new empty #ECalComponentAttendee structure. Free it with e_cal_component_attendee_free(), when no longer needed.

Returns ComponentAttendee

Properties

Static name

name: string

Methods

copy

copy(): ComponentAttendee

- Defined in @types/Gjs/ECal-2.0.d.ts:3823
Returns a newly allocated copy of attendee, which should be freed with e_cal_component_attendee_free(), when no longer needed.

Returns ComponentAttendee

fill_property

fill_property(property: ICalGLib.Property): ICalGLib.Property

- Defined in @types/Gjs/ECal-2.0.d.ts:3829
Fill property with information from attendee. The property should be of kind %I_CAL_ATTENDEE_PROPERTY.

Parameters
- property: ICalGLib.Property
  
  an #ICalProperty
Returns ICalGLib.Property

get_as_property

get_as_property(): ICalGLib.Property

- Defined in @types/Gjs/ECal-2.0.d.ts:3835
Converts information stored in attendee into an #ICalProperty of %I_CAL_ATTENDEE_PROPERTY kind. The caller is responsible to free the returned object with g_object_unref(), when no longer needed.

Returns ICalGLib.Property

get_cn

get_cn(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3836
Returns string

get_cutype

get_cutype(): ParameterCutype

- Defined in @types/Gjs/ECal-2.0.d.ts:3837
Returns ParameterCutype

get_delegatedfrom

get_delegatedfrom(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3838
Returns string

get_delegatedto

get_delegatedto(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3839
Returns string

get_language

get_language(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3840
Returns string

get_member

get_member(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3841
Returns string

get_parameter_bag

get_parameter_bag(): ComponentParameterBag

- Defined in @types/Gjs/ECal-2.0.d.ts:3842
Returns ComponentParameterBag

get_partstat

get_partstat(): ParameterPartstat

- Defined in @types/Gjs/ECal-2.0.d.ts:3843
Returns ParameterPartstat

get_role

get_role(): ParameterRole

- Defined in @types/Gjs/ECal-2.0.d.ts:3844
Returns ParameterRole

get_rsvp

get_rsvp(): boolean

- Defined in @types/Gjs/ECal-2.0.d.ts:3845
Returns boolean

get_sentby

get_sentby(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3846
Returns string

get_value

get_value(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3847
Returns string

set_cn

set_cn(cn: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3853
Set the attendee common name (cn) parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- cn: string
  
  the value to set
Returns void

set_cutype

set_cutype(cutype: ParameterCutype): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3858
Set the attendee type, as an #ICalParameterCutype.

Parameters
- cutype: ParameterCutype
  
  the value to set, as an #ICalParameterCutype
Returns void

set_delegatedfrom

set_delegatedfrom(delegatedfrom: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3864
Set the attendee delegatedfrom parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- delegatedfrom: string
  
  the value to set
Returns void

set_delegatedto

set_delegatedto(delegatedto: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3870
Set the attendee delegatedto parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- delegatedto: string
  
  the value to set
Returns void

set_from_property

set_from_property(property: ICalGLib.Property): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3876
Fill the attendee structure with the information from the property, which should be of %I_CAL_ATTENDEE_PROPERTY kind.

Parameters
- property: ICalGLib.Property
  
  an #ICalProperty
Returns void

set_language

set_language(language: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3882
Set the attendee language parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- language: string
  
  the value to set
Returns void

set_member

set_member(member: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3888
Set the attendee member parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- member: string
  
  the value to set
Returns void

set_partstat

set_partstat(partstat: ParameterPartstat): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3893
Set the attendee status, as an #ICalParameterPartstat.

Parameters
- partstat: ParameterPartstat
  
  the value to set, as an #ICalParameterPartstat
Returns void

set_role

set_role(role: ParameterRole): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3898
Set the attendee role, as an #ICalParameterRole.

Parameters
- role: ParameterRole
  
  the value to set, as an #ICalParameterRole
Returns void

set_rsvp

set_rsvp(rsvp: boolean): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3903
Set the attendee RSVP.

Parameters
- rsvp: boolean
  
  the value to set
Returns void

set_sentby

set_sentby(sentby: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3909
Set the attendee sentby parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- sentby: string
  
  the value to set
Returns void

set_value

set_value(value: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3915
Set the attendee URI, usually of "mailto:email" form. The %NULL and empty strings are treated as unset the value.

Parameters
- value: string
  
  the value to set
Returns void

Static new

new(): ComponentAttendee

- Defined in @types/Gjs/ECal-2.0.d.ts:3941
Creates a new empty #ECalComponentAttendee structure. Free it with e_cal_component_attendee_free(), when no longer needed.

Returns ComponentAttendee

Static new_from_property

new_from_property(property: ICalGLib.Property): ComponentAttendee

- Defined in @types/Gjs/ECal-2.0.d.ts:3950
Creates a new #ECalComponentAttendee, filled with values from property, which should be of kind %I_CAL_ATTENDEE_PROPERTY. The function returns %NULL when it is not of the expected kind. Free the structure with e_cal_component_attendee_free(), when no longer needed.

Parameters
- property: ICalGLib.Property
  
  an #ICalProperty of kind %I_CAL_ATTENDEE_PROPERTY
Returns ComponentAttendee

Static new_full

new_full(value: string, member: string, cutype: ParameterCutype, role: ParameterRole, partstat: ParameterPartstat, rsvp: boolean, delegatedfrom: string, delegatedto: string, sentby: string, cn: string, language: string): ComponentAttendee

- Defined in @types/Gjs/ECal-2.0.d.ts:3969
Creates a new #ECalComponentAttendee structure, with all members filled with given values from the parameters. The %NULL and empty strings are treated as unset the value. Free the structure with e_cal_component_attendee_free(), when no longer needed.

Parameters
- value: string
  
  usually a "mailto:email" of the attendee
- member: string
  
  member parameter
- cutype: ParameterCutype
  
  type of the attendee, an #ICalParameterCutype
- role: ParameterRole
  
  role of the attendee, an #ICalParameterRole
- partstat: ParameterPartstat
  
  current status of the attendee, an #ICalParameterPartstat
- rsvp: boolean
  
  whether requires RSVP
- delegatedfrom: string
  
  delegated from
- delegatedto: string
  
  delegated to
- sentby: string
  
  sent by
- cn: string
  
  common name
- language: string
  
  language
Returns ComponentAttendee