ECal.ComponentAlarmRepeat¶

Fields¶

None

Methods¶

class	`new` (repetitions, interval)
class	`new_seconds` (repetitions, interval_seconds)
	`copy` ()
	`get_interval` ()
	`get_interval_seconds` ()
	`get_repetitions` ()
	`set_interval` (interval)
	`set_interval_seconds` (interval_seconds)
	`set_repetitions` (repetitions)

Details¶

class ECal.ComponentAlarmRepeat¶

A structure holding whether and how an alarm repeats. Use the functions below to work with it.

classmethod new(repetitions, interval)¶

Parameters:

repetitions (int) – number of extra repetitions, zero for none
interval (ICalGLib.Duration) – interval between repetitions

Returns:

a newly allocated ECal.ComponentAlarmRepeat

Return type:

ECal.ComponentAlarmRepeat

Creates a new ECal.ComponentAlarmRepeat describing alarm repetitions. The returned structure should be freed with e_cal_component_alarm_repeat_free(), when no longer needed.

Added in version 3.34.

classmethod new_seconds(repetitions, interval_seconds)¶

Parameters:

repetitions (int) – number of extra repetitions, zero for none
interval_seconds (int) – interval between repetitions, in seconds

Returns:

a newly allocated ECal.ComponentAlarmRepeat

Return type:

ECal.ComponentAlarmRepeat

Creates a new ECal.ComponentAlarmRepeat describing alarm repetitions. The returned structure should be freed with e_cal_component_alarm_repeat_free(), when no longer needed.

Added in version 3.34.

copy()¶

Returns:: a newly allocated ECal.ComponentAlarmRepeat, copy of self. The returned structure should be freed with e_cal_component_alarm_repeat_free(), when no longer needed.
Return type:: ECal.ComponentAlarmRepeat

Added in version 3.34.

get_interval()¶

Returns:: the interval between repetitions of the self
Return type:: ICalGLib.Duration

Returns the interval between repetitions of the self, as an ICalGLib.Duration object. This object is owned by self and should not be freed. It’s valid until the self is not freed or its interval changed with either ECal.ComponentAlarmRepeat.set_interval() or ECal.ComponentAlarmRepeat.set_interval_seconds().

Added in version 3.34.

get_interval_seconds()¶

Returns:: the interval between repetitions of the self
Return type:: int

Returns the interval between repetitions of the self in seconds.

Added in version 3.34.

get_repetitions()¶

Returns:: the repetitions count of the self
Return type:: int

Added in version 3.34.

set_interval(interval)¶

Parameters:: interval (ICalGLib.Duration) – interval between repetitions, as an ICalGLib.Duration

Set the interval between repetitions of the self.

Added in version 3.34.

set_interval_seconds(interval_seconds)¶

Parameters:: interval_seconds (int) – interval between repetitions, in seconds

Set the interval_seconds between repetitions of the self.

Added in version 3.34.

set_repetitions(repetitions)¶

Parameters:: repetitions (int) – number of repetitions, zero for none

Set the repetitions count of the self.

Added in version 3.34.