ECal.ComponentAlarmInstance¶

Fields¶

None

Methods¶

class	`new` (uid, instance_time, occur_start, occur_end)
	`copy` ()
	`get_component` ()
	`get_occur_end` ()
	`get_occur_start` ()
	`get_rid` ()
	`get_time` ()
	`get_uid` ()
	`set_component` (component)
	`set_occur_end` (occur_end)
	`set_occur_start` (occur_start)
	`set_rid` (rid)
	`set_time` (instance_time)
	`set_uid` (uid)

Details¶

class ECal.ComponentAlarmInstance¶

Opaque structure, which represents an alarm occurrence, i.e. a instance instance. Use the functions below to work with it.

classmethod new(uid, instance_time, occur_start, occur_end)¶

Parameters:

uid (str) – UID of the alarm
instance_time (int) – instance time, i.e. “5 minutes before the appointment”
occur_start (int) – actual event occurrence start to which this instance corresponds
occur_end (int) – actual event occurrence end to which this instance corresponds

Returns:

a newly allocated ECal.ComponentAlarmInstance

Return type:

ECal.ComponentAlarmInstance

Creates a new ECal.ComponentAlarmInstance structure, filled with the given values. Free the instance with e_cal_component_alarm_instance_free(), when no longer needed.

New in version 3.34.

copy()¶

Returns:: a newly allocated copy of self
Return type:: ECal.ComponentAlarmInstance

Returns a newly allocated copy of self, which should be freed with e_cal_component_alarm_instance_free(), when no longer needed.

New in version 3.34.

get_component()¶

Returns:: component associated with the instance, or None
Return type:: object or None

New in version 3.48.

get_occur_end()¶

Returns:: actual event occurrence end to which this self corresponds
Return type:: int

New in version 3.34.

get_occur_start()¶

Returns:: actual event occurrence start to which this self corresponds
Return type:: int

New in version 3.34.

get_rid()¶

Returns:: the Recurrence ID of the component this self was generated for.
Return type:: str or None

New in version 3.40.

get_time()¶

Returns:: alarm instance time, i.e. “5 minutes before the appointment”
Return type:: int

New in version 3.34.

get_uid()¶

Returns:: alarm UID, to which this self corresponds
Return type:: str

New in version 3.34.

set_component(component)¶

Parameters:: component (object or None) – an ECal.Component or None

Sets component as the component associated with the self. It can be None to unset it.

New in version 3.48.

set_occur_end(occur_end)¶

Parameters:: occur_end (int) – event occurence end to set

Set the actual event occurrence end to which this self corresponds.

New in version 3.34.

set_occur_start(occur_start)¶

Parameters:: occur_start (int) – event occurence start to set

Set the actual event occurrence start to which this self corresponds.

New in version 3.34.

set_rid(rid)¶

Parameters:: rid (str or None) – recurrence UID to set, or None

Set the Recurrence ID of the component this self was generated for.

New in version 3.40.

set_time(instance_time)¶

Parameters:: instance_time (int) – instance time to set

Set the instance time, i.e. “5 minutes before the appointment”.

New in version 3.34.

set_uid(uid)¶

Parameters:: uid (str) – alarm UID to set

Set the alarm UID.

New in version 3.34.