Struct
ECalComponentAlarm
Description [src]
struct ECalComponentAlarm {
/* No available fields */
}
Opaque structure, which represents alarm subcomponents. Use the functions below to work with it.
Constructors
e_cal_component_alarm_new
Creates a new empty ECalComponentAlarm structure. Free it
with e_cal_component_alarm_free(), when no longer needed.
since: 3.34
e_cal_component_alarm_new_from_component
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.
since: 3.34
Instance methods
e_cal_component_alarm_copy
Returns a newly allocated copy of alarm, which should be freed with
e_cal_component_alarm_free(), when no longer needed.
since: 3.34
e_cal_component_alarm_fill_component
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.
since: 3.34
e_cal_component_alarm_free
Free alarm, previously created by e_cal_component_alarm_new(),
e_cal_component_alarm_new_from_component()
or e_cal_component_alarm_copy(). The function does nothing, if alarm
is NULL.
since: 3.34
e_cal_component_alarm_get_acknowledged
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.
since: 3.40
e_cal_component_alarm_get_as_component
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.
since: 3.34
e_cal_component_alarm_get_attachments
Get the list of attachments, as ICalAttach.
The returned GSList is owned by alarm and should not be modified,
neither its content.
since: 3.34
e_cal_component_alarm_get_attendees
Get the list of attendees, as ECalComponentAttendee.
The returned GSList is owned by alarm and should not be modified,
neither its content.
since: 3.34
e_cal_component_alarm_get_description
Get the alarm description, as an ECalComponentText.
since: 3.34
e_cal_component_alarm_get_repeat
Get the alarm repeat information, as an ECalComponentAlarmRepeat.
since: 3.34
e_cal_component_alarm_get_trigger
Get the alarm trigger, as an ECalComponentAlarmTrigger.
since: 3.34
e_cal_component_alarm_set_acknowledged
Set the acknowledged time of the alarm. Use NULL to unset it.
since: 3.40
e_cal_component_alarm_set_attachments
Set the list of attachments, as a GSList of an ICalAttach.
since: 3.34
e_cal_component_alarm_set_attendees
Set the list of attendees, as a GSList of an ECalComponentAttendee.
since: 3.34
e_cal_component_alarm_set_description
Set the alarm description, as an ECalComponentText.
since: 3.34
e_cal_component_alarm_set_from_component
Fill the alarm structure with the information from the component, which should be of I_CAL_VALARM_COMPONENT kind.
since: 3.34
e_cal_component_alarm_set_repeat
Set the alarm repeat information, as an ECalComponentAlarmRepeat.
since: 3.34
e_cal_component_alarm_set_trigger
Set the alarm trigger, as an ECalComponentAlarmTrigger.
since: 3.34
e_cal_component_alarm_set_uid
Set the alarm UID, or generates a new UID, if uid is NULL or an empty string.
since: 3.34
e_cal_component_alarm_take_acknowledged
Set the acknowledged time of the alarm. Use NULL to unset it.
The function assumes ownership of the when.
since: 3.40
e_cal_component_alarm_take_attachments
Sets the list of attachments, as a GSList of an ICalAttach and assumes
ownership of the attachments and its content.
since: 3.34
e_cal_component_alarm_take_attendees
Sets the list of attendees, as a GSList of an ECalComponentAttendee and assumes
ownership of the attendees and its content.
since: 3.34
e_cal_component_alarm_take_description
Set the alarm description, as an ECalComponentText, and assumes
ownership of the description.
since: 3.34
e_cal_component_alarm_take_repeat
Set the alarm repeat information, as an ECalComponentAlarmRepeat and assumes
ownership of the trigger.
since: 3.34
e_cal_component_alarm_take_summary
Set the alarm summary, as an ECalComponentText, and assumes
ownership of the summary.
since: 3.34
e_cal_component_alarm_take_trigger
Set the alarm trigger, as an ECalComponentAlarmTrigger and assumes
ownership of the trigger.
since: 3.34