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 @types/Gjs/ECal-2.0.d.ts:3437
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 @types/Gjs/ECal-2.0.d.ts:3298
Returns a newly allocated copy of alarm, which should be freed with e_cal_component_alarm_free(), when no longer needed.

Returns ComponentAlarm

fill_component

fill_component(component: ICalGLib.Component): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3306
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

get_acknowledged

get_acknowledged(): ICalGLib.Time

- Defined in @types/Gjs/ECal-2.0.d.ts:3313
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

get_action

get_action(): ComponentAlarmAction

- Defined in @types/Gjs/ECal-2.0.d.ts:3317
Get the alarm action, as an #ECalComponentAlarmAction.

Returns ComponentAlarmAction

get_as_component

get_as_component(): ICalGLib.Component

- Defined in @types/Gjs/ECal-2.0.d.ts:3324
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

get_attachments

get_attachments(): Attach[]

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

Returns Attach[]

get_attendees

get_attendees(): ComponentAttendee[]

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

Returns ComponentAttendee[]

get_description

get_description(): ComponentText

- Defined in @types/Gjs/ECal-2.0.d.ts:3340
Get the alarm description, as an #ECalComponentText.

Returns ComponentText

get_property_bag

get_property_bag(): ComponentPropertyBag

- Defined in @types/Gjs/ECal-2.0.d.ts:3341
Returns ComponentPropertyBag

get_repeat

get_repeat(): ComponentAlarmRepeat

- Defined in @types/Gjs/ECal-2.0.d.ts:3345
Get the alarm repeat information, as an ECalComponentAlarmRepeat.

Returns ComponentAlarmRepeat

get_summary

get_summary(): ComponentText

- Defined in @types/Gjs/ECal-2.0.d.ts:3349
Get the alarm summary, as an #ECalComponentText.

Returns ComponentText

get_trigger

get_trigger(): ComponentAlarmTrigger

- Defined in @types/Gjs/ECal-2.0.d.ts:3353
Get the alarm trigger, as an #ECalComponentAlarmTrigger.

Returns ComponentAlarmTrigger

get_uid

get_uid(): string

- Defined in @types/Gjs/ECal-2.0.d.ts:3357
Get the alarm UID.

Returns string

has_attachments

has_attachments(): boolean

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

has_attendees

has_attendees(): boolean

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

set_acknowledged

set_acknowledged(when: ICalGLib.Time): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3364
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

set_action

set_action(action: ComponentAlarmAction): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3369
Set the alarm action, as an #ECalComponentAlarmAction.

Parameters
- action: ComponentAlarmAction
  
  an #ECalComponentAlarmAction
Returns void

set_attachments

set_attachments(attachments: Attach[]): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3374
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

set_attendees

set_attendees(attendees: ComponentAttendee[]): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3379
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

set_description

set_description(description: ComponentText): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3384
Set the alarm description, as an #ECalComponentText.

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

set_from_component

set_from_component(component: ICalGLib.Component): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3390
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

set_repeat

set_repeat(repeat: ComponentAlarmRepeat): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3395
Set the alarm repeat information, as an #ECalComponentAlarmRepeat.

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

set_summary

set_summary(summary: ComponentText): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3400
Set the alarm summary, as an #ECalComponentText.

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

set_trigger

set_trigger(trigger: ComponentAlarmTrigger): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3405
Set the alarm trigger, as an #ECalComponentAlarmTrigger.

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

set_uid

set_uid(uid: string): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3410
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

take_acknowledged

take_acknowledged(when: ICalGLib.Time): void

- Defined in @types/Gjs/ECal-2.0.d.ts:3416
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 @types/Gjs/ECal-2.0.d.ts:3443
Creates a new empty #ECalComponentAlarm structure. Free it with e_cal_component_alarm_free(), when no longer needed.

Returns ComponentAlarm

Static new_from_component

new_from_component(component: ICalGLib.Component): ComponentAlarm

- Defined in @types/Gjs/ECal-2.0.d.ts:3452
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