Class ComponentOrganizer

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

record

Hierarchy

ComponentOrganizer

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new ComponentOrganizer(): ComponentOrganizer

- Defined in ECal-2.0.d.ts:4265
Creates a new empty #ECalComponentOrganizer structure. Free it with e_cal_component_organizer_free(), when no longer needed.

Returns ComponentOrganizer

Properties

Static name

name: string

Methods

copy

copy(): ComponentOrganizer

- Defined in ECal-2.0.d.ts:4198
Returns a newly allocated copy of organizer, which should be freed with e_cal_component_organizer_free(), when no longer needed.

Returns ComponentOrganizer

fillProperty

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

- Defined in ECal-2.0.d.ts:4204
Fill property with information from organizer. The property should be of kind %I_CAL_ORGANIZER_PROPERTY.

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

getAsProperty

getAsProperty(): ICalGLib.Property

- Defined in ECal-2.0.d.ts:4210
Converts information stored in organizer into an #ICalProperty of %I_CAL_ORGANIZER_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:4211
Returns string

getLanguage

getLanguage(): string

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

getParameterBag

getParameterBag(): ComponentParameterBag

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

getSentby

getSentby(): string

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

getValue

getValue(): string

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

setCn

setCn(cn: string): void

- Defined in ECal-2.0.d.ts:4221
Set the organizer common name (cn) parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- cn: string
  
  the value to set
Returns void

setFromProperty

setFromProperty(property: ICalGLib.Property): void

- Defined in ECal-2.0.d.ts:4227
Fill the organizer structure with the information from the property, which should be of %I_CAL_ORGANIZER_PROPERTY kind.

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

setLanguage

setLanguage(language: string): void

- Defined in ECal-2.0.d.ts:4233
Set the organizer language parameter. The %NULL and empty strings are treated as unset the value.

Parameters
- language: string
  
  the value to set
Returns void

setSentby

setSentby(sentby: string): void

- Defined in ECal-2.0.d.ts:4239
Set the organizer 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:4245
Set the organizer 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(): ComponentOrganizer

- Defined in ECal-2.0.d.ts:4271
Creates a new empty #ECalComponentOrganizer structure. Free it with e_cal_component_organizer_free(), when no longer needed.

Returns ComponentOrganizer

Static newFromProperty

newFromProperty(property: ICalGLib.Property): ComponentOrganizer

- Defined in ECal-2.0.d.ts:4280
Creates a new #ECalComponentOrganizer, filled with values from property, which should be of kind %I_CAL_ORGANIZER_PROPERTY. The function returns %NULL when it is not of the expected kind. Free the structure with e_cal_component_organizer_free(), when no longer needed.

Parameters
- property: ICalGLib.Property
  
  an #ICalProperty of kind %I_CAL_ORGANIZER_PROPERTY
Returns ComponentOrganizer

Static newFull

newFull(value: string, sentby: string, cn: string, language: string): ComponentOrganizer

- Defined in ECal-2.0.d.ts:4292
Creates a new #ECalComponentOrganizer 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_organizer_free(), when no longer needed.

Parameters
- value: string
  
  usually a "mailto:email" of the organizer
- sentby: string
  
  sent by
- cn: string
  
  common name
- language: string
  
  language
Returns ComponentOrganizer