Class ComponentAlarm

Opaque structure, which represents alarm subcomponents. Use the functions below to work with it.

record

Hierarchy

ComponentAlarm

Constructors

constructor

new ComponentAlarm(): ComponentAlarm

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

Returns ComponentAlarm

Properties

Static name

name: string

Methods

copy

copy(): ComponentAlarm

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

Returns ComponentAlarm

fillComponent

fillComponent(component: ICalGLib.Component): void

- Defined in ECal-2.0.d.ts:3341
Fills component with data from alarm. The component should be of %I_CAL_VALARM_COMPONENT kind - the function does nothing, if it's not. In case the alarm doesn't have set 'uid', a new is assigned.

Parameters
- component: ICalGLib.Component
  
  an #ICalComponent of %I_CAL_VALARM_COMPONENT kind
Returns void

getAcknowledged

getAcknowledged(): ICalGLib.Time

- Defined in ECal-2.0.d.ts:3348
Get the last time the alarm had been acknowledged, that is, when its reminder had been triggered. The returned #ICalTime is owned by alarm and should not be modified, neither its content.

Returns ICalGLib.Time

getAction

getAction(): ComponentAlarmAction

- Defined in ECal-2.0.d.ts:3352
Get the alarm action, as an #ECalComponentAlarmAction.

Returns ComponentAlarmAction

getAsComponent

getAsComponent(): ICalGLib.Component

- Defined in ECal-2.0.d.ts:3359
Creates a VALARM #ICalComponent filled with data from the alarm. In case the alarm doesn't have set 'uid', a new is assigned. Free the returned component with g_object_unref(), when no longer needed.

Returns ICalGLib.Component

getAttachments

getAttachments(): Attach[]

- Defined in ECal-2.0.d.ts:3365
Get the list of attachments, as #ICalAttach. The returned #GSList is owned by alarm and should not be modified, neither its content.

Returns Attach[]

getAttendees

getAttendees(): ComponentAttendee[]

- Defined in ECal-2.0.d.ts:3371
Get the list of attendees, as #ECalComponentAttendee. The returned #GSList is owned by alarm and should not be modified, neither its content.

Returns ComponentAttendee[]

getDescription

getDescription(): ComponentText

- Defined in ECal-2.0.d.ts:3375
Get the alarm description, as an #ECalComponentText.

Returns ComponentText

getPropertyBag

getPropertyBag(): ComponentPropertyBag

- Defined in ECal-2.0.d.ts:3376
Returns ComponentPropertyBag

getRepeat

getRepeat(): ComponentAlarmRepeat

- Defined in ECal-2.0.d.ts:3380
Get the alarm repeat information, as an ECalComponentAlarmRepeat.

Returns ComponentAlarmRepeat

getSummary

getSummary(): ComponentText

- Defined in ECal-2.0.d.ts:3384
Get the alarm summary, as an #ECalComponentText.

Returns ComponentText

getTrigger

getTrigger(): ComponentAlarmTrigger

- Defined in ECal-2.0.d.ts:3388
Get the alarm trigger, as an #ECalComponentAlarmTrigger.

Returns ComponentAlarmTrigger

getUid

getUid(): string

- Defined in ECal-2.0.d.ts:3392
Get the alarm UID.

Returns string

hasAttachments

hasAttachments(): boolean

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

hasAttendees

hasAttendees(): boolean

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

setAcknowledged

setAcknowledged(when: ICalGLib.Time): void

- Defined in ECal-2.0.d.ts:3399
Set the acknowledged time of the alarm. Use %NULL to unset it.

Parameters
- when: ICalGLib.Time
  
  an #ICalTime when the alarm had been acknowledged, or %NULL to unset
Returns void

setAction

setAction(action: ComponentAlarmAction): void

- Defined in ECal-2.0.d.ts:3404
Set the alarm action, as an #ECalComponentAlarmAction.

Parameters
- action: ComponentAlarmAction
  
  an #ECalComponentAlarmAction
Returns void

setAttachments

setAttachments(attachments: Attach[]): void

- Defined in ECal-2.0.d.ts:3409
Set the list of attachments, as a #GSList of an #ICalAttach.

Parameters
- attachments: Attach[]
  
  a #GSList of an #ICalAttach objects to set as attachments, or %NULL to unset
Returns void

setAttendees

setAttendees(attendees: ComponentAttendee[]): void

- Defined in ECal-2.0.d.ts:3414
Set the list of attendees, as a #GSList of an #ECalComponentAttendee.

Parameters
- attendees: ComponentAttendee[]
  
  a #GSList of an #ECalComponentAttendee objects to set as attendees, or %NULL to unset
Returns void

setDescription

setDescription(description: ComponentText): void

- Defined in ECal-2.0.d.ts:3419
Set the alarm description, as an #ECalComponentText.

Parameters
- description: ComponentText
  
  a description to set, or %NULL to unset
Returns void

setFromComponent

setFromComponent(component: ICalGLib.Component): void

- Defined in ECal-2.0.d.ts:3425
Fill the alarm structure with the information from the component, which should be of %I_CAL_VALARM_COMPONENT kind.

Parameters
- component: ICalGLib.Component
  
  an #ICalComponent
Returns void

setRepeat

setRepeat(repeat: ComponentAlarmRepeat): void

- Defined in ECal-2.0.d.ts:3430
Set the alarm repeat information, as an #ECalComponentAlarmRepeat.

Parameters
- repeat: ComponentAlarmRepeat
  
  a repeat information to set, or %NULL to unset
Returns void

setSummary

setSummary(summary: ComponentText): void

- Defined in ECal-2.0.d.ts:3435
Set the alarm summary, as an #ECalComponentText.

Parameters
- summary: ComponentText
  
  a summary to set, or %NULL to unset
Returns void

setTrigger

setTrigger(trigger: ComponentAlarmTrigger): void

- Defined in ECal-2.0.d.ts:3440
Set the alarm trigger, as an #ECalComponentAlarmTrigger.

Parameters
- trigger: ComponentAlarmTrigger
  
  a trigger to set, or %NULL to unset
Returns void

setUid

setUid(uid: string): void

- Defined in ECal-2.0.d.ts:3445
Set the alarm UID, or generates a new UID, if uid is %NULL or an empty string.

Parameters
- uid: string
  
  a UID to set, or %NULL or empty string to generate new
Returns void

takeAcknowledged

takeAcknowledged(when: ICalGLib.Time): void

- Defined in ECal-2.0.d.ts:3451
Set the acknowledged time of the alarm. Use %NULL to unset it. The function assumes ownership of the when.

Parameters
- when: ICalGLib.Time
  
  an #ICalTime when the alarm had been acknowledged, or %NULL to unset
Returns void

Static new

new(): ComponentAlarm

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

Returns ComponentAlarm

Static newFromComponent

newFromComponent(component: ICalGLib.Component): ComponentAlarm

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

Parameters
- component: ICalGLib.Component
  
  an #ICalComponent of kind %I_CAL_VALARM_COMPONENT
Returns ComponentAlarm