ECal.ReminderData¶

Fields¶

None

class	`new` (source_uid, component, instance)
	`copy` ()
	`free` ()
	`get_component` ()
	`get_instance` ()
	`get_source_uid` ()
	`set_component` (component)
	`set_instance` (instance)
	`set_source_uid` (source_uid)

class ECal.ReminderData¶

Contains data related to single reminder occurrence.

New in version 3.30.

classmethod new(source_uid, component, instance)¶

Parameters:

source_uid (str) – an EDataServer.Source UID, to which the component belongs
component (ECal.Component) – an ECal.Component
instance (ECal.ComponentAlarmInstance) – an ECal.ComponentAlarmInstance describing one reminder instance

Returns:

a new ECal.ReminderData prefilled with given values. Free the returned structure with ECal.ReminderData.free() when no longer needed.

Return type:

ECal.ReminderData

New in version 3.30.

copy()¶

Returns:: copy of self. Free the returned structure with ECal.ReminderData.free() when no longer needed.
Return type:: ECal.ReminderData or None

Copies given ECal.ReminderData structure. When the self is None, simply returns None as well.

New in version 3.30.

free()¶: Frees previously allocated ECal.ReminderData structure with ECal.ReminderData.new() or ECal.ReminderData.copy(). The function does nothing when self is None.

New in version 3.30.

get_component()¶

Returns:: an ECal.Component for self. It is owned by self, thus do not free it.
Return type:: ECal.Component

New in version 3.34.

get_instance()¶

Returns:: an ECal.ComponentAlarmInstance for self. It is owned by self, thus do not free it.
Return type:: ECal.ComponentAlarmInstance

New in version 3.34.

get_source_uid()¶

New in version 3.34.

set_component(component)¶

Set an ECal.Component component as associated with this self. The self creates a copy of the component.

New in version 3.34.

set_instance(instance)¶

Parameters:: instance (ECal.ComponentAlarmInstance) – an ECal.ComponentAlarmInstance

Set an ECal.ComponentAlarmInstance instance as associated with this self. The self creates a copy of the instance.

New in version 3.34.

set_source_uid(source_uid)¶

Set an EDataServer.Source UID for self.

New in version 3.34.