Class ComponentAttendee

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

record

Hierarchy

ComponentAttendee

Constructors

constructor

new ComponentAttendee(): ComponentAttendee

- Defined in ECal-2.0.d.ts:3970
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 ECal-2.0.d.ts:3858
Returns a newly allocated copy of attendee, which should be freed with e_cal_component_attendee_free(), when no longer needed.

Returns ComponentAttendee

fillProperty

fillProperty(property: ICalGLib.Property): ICalGLib.Property

- Defined in ECal-2.0.d.ts:3864
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

getAsProperty

getAsProperty(): ICalGLib.Property

- Defined in ECal-2.0.d.ts:3870
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

getCn

getCn(): string

- Defined in ECal-2.0.d.ts:3871
Returns string

getCutype

getCutype(): ParameterCutype

- Defined in ECal-2.0.d.ts:3872
Returns ParameterCutype

getDelegatedfrom

getDelegatedfrom(): string

- Defined in ECal-2.0.d.ts:3873
Returns string

getDelegatedto

getDelegatedto(): string

- Defined in ECal-2.0.d.ts:3874
Returns string

getLanguage

getLanguage(): string

- Defined in ECal-2.0.d.ts:3875
Returns string

getMember

getMember(): string

- Defined in ECal-2.0.d.ts:3876
Returns string

getParameterBag

getParameterBag(): ComponentParameterBag

- Defined in ECal-2.0.d.ts:3877
Returns ComponentParameterBag

getPartstat

getPartstat(): ParameterPartstat

- Defined in ECal-2.0.d.ts:3878
Returns ParameterPartstat

getRole

getRole(): ParameterRole

- Defined in ECal-2.0.d.ts:3879
Returns ParameterRole

getRsvp

getRsvp(): boolean

- Defined in ECal-2.0.d.ts:3880
Returns boolean

getSentby

getSentby(): string

- Defined in ECal-2.0.d.ts:3881
Returns string

getValue

getValue(): string

- Defined in ECal-2.0.d.ts:3882
Returns string

setCn

setCn(cn: string): void

- Defined in ECal-2.0.d.ts:3888
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

setCutype

setCutype(cutype: ParameterCutype): void

- Defined in ECal-2.0.d.ts:3893
Set the attendee type, as an #ICalParameterCutype.

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

setDelegatedfrom

setDelegatedfrom(delegatedfrom: string): void

- Defined in ECal-2.0.d.ts:3899
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

setDelegatedto

setDelegatedto(delegatedto: string): void

- Defined in ECal-2.0.d.ts:3905
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

setFromProperty

setFromProperty(property: ICalGLib.Property): void

- Defined in ECal-2.0.d.ts:3911
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

setLanguage

setLanguage(language: string): void

- Defined in ECal-2.0.d.ts:3917
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

setMember

setMember(member: string): void

- Defined in ECal-2.0.d.ts:3923
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

setPartstat

setPartstat(partstat: ParameterPartstat): void

- Defined in ECal-2.0.d.ts:3928
Set the attendee status, as an #ICalParameterPartstat.

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

setRole

setRole(role: ParameterRole): void

- Defined in ECal-2.0.d.ts:3933
Set the attendee role, as an #ICalParameterRole.

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

setRsvp

setRsvp(rsvp: boolean): void

- Defined in ECal-2.0.d.ts:3938
Set the attendee RSVP.

Parameters
- rsvp: boolean
  
  the value to set
Returns void

setSentby

setSentby(sentby: string): void

- Defined in ECal-2.0.d.ts:3944
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

setValue

setValue(value: string): void

- Defined in ECal-2.0.d.ts:3950
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 ECal-2.0.d.ts:3976
Creates a new empty #ECalComponentAttendee structure. Free it with e_cal_component_attendee_free(), when no longer needed.

Returns ComponentAttendee

Static newFromProperty

newFromProperty(property: ICalGLib.Property): ComponentAttendee

- Defined in ECal-2.0.d.ts:3985
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 newFull

newFull(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 ECal-2.0.d.ts:4004
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