ECal.ComponentAlarm¶

Fields¶

None

Methods¶

class	`new` ()
class	`new_from_component` (component)
	`copy` ()
	`fill_component` (component)
	`get_acknowledged` ()
	`get_action` ()
	`get_as_component` ()
	`get_attachments` ()
	`get_attendees` ()
	`get_description` ()
	`get_property_bag` ()
	`get_repeat` ()
	`get_summary` ()
	`get_trigger` ()
	`get_uid` ()
	`has_attachments` ()
	`has_attendees` ()
	`set_acknowledged` (when)
	`set_action` (action)
	`set_attachments` (attachments)
	`set_attendees` (attendees)
	`set_description` (description)
	`set_from_component` (component)
	`set_repeat` (repeat)
	`set_summary` (summary)
	`set_trigger` (trigger)
	`set_uid` (uid)
	`take_acknowledged` (when)

Details¶

class ECal.ComponentAlarm¶

Opaque structure, which represents alarm subcomponents. Use the functions below to work with it.

classmethod new()¶

Returns:: a newly allocated ECal.ComponentAlarm
Return type:: ECal.ComponentAlarm

Creates a new empty ECal.ComponentAlarm structure. Free it with e_cal_component_alarm_free(), when no longer needed.

Added in version 3.34.

classmethod new_from_component(component)¶

Parameters:: component (ICalGLib.Component) – an ICalGLib.Component of kind ICalGLib.ComponentKind.VALARM_COMPONENT
Returns:: a newly allocated ECal.ComponentAlarm
Return type:: ECal.ComponentAlarm or None

Creates a new ECal.ComponentAlarm, filled with values from component, which should be of kind ICalGLib.ComponentKind.VALARM_COMPONENT. The function returns None when it is not of the expected kind. Free the structure with e_cal_component_alarm_free(), when no longer needed.

Added in version 3.34.

copy()¶

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

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

Added in version 3.34.

fill_component(component)¶

Parameters:: component (ICalGLib.Component) – an ICalGLib.Component of ICalGLib.ComponentKind.VALARM_COMPONENT kind

Fills component with data from self. The component should be of ICalGLib.ComponentKind.VALARM_COMPONENT kind - the function does nothing, if it’s not. In case the self doesn’t have set ‘uid’, a new is assigned.

Added in version 3.34.

get_acknowledged()¶

Returns:: the self acknowledged time, or None, when none is set
Return type:: ICalGLib.Time or None

Get the last time the alarm had been acknowledged, that is, when its reminder had been triggered. The returned ICalGLib.Time is owned by self and should not be modified, neither its content.

Added in version 3.40.

get_action()¶

Returns:: the self action, or ECal.ComponentAlarmAction.NONE, when none is set
Return type:: ECal.ComponentAlarmAction

Get the self action, as an ECal.ComponentAlarmAction.

Added in version 3.34.

get_as_component()¶

Returns:: a newly created ICalGLib.Component of ICalGLib.ComponentKind.VALARM_COMPONENT kind
Return type:: ICalGLib.Component

Creates a VALARM ICalGLib.Component filled with data from the self. In case the self doesn’t have set ‘uid’, a new is assigned. Free the returned component with GObject.Object.unref(), when no longer needed.

Added in version 3.34.

get_attachments()¶

Returns:: the self attachments, as a GLib.SList of an ICalGLib.Attach, or None, when none is set
Return type:: [ICalGLib.Attach] or None

Get the list of attachments, as ICalGLib.Attach. The returned GLib.SList is owned by self and should not be modified, neither its content.

Added in version 3.34.

get_attendees()¶

Returns:: the self attendees, as a GLib.SList of an ECal.ComponentAttendee, or None when, none are set
Return type:: [ECal.ComponentAttendee] or None

Get the list of attendees, as ECal.ComponentAttendee. The returned GLib.SList is owned by self and should not be modified, neither its content.

Added in version 3.34.

get_description()¶

Returns:: the self description, or None, when none is set
Return type:: ECal.ComponentText or None

Get the self description, as an ECal.ComponentText.

Added in version 3.34.

get_property_bag()¶

Returns:: an ECal.ComponentPropertyBag with additional properties stored with an alarm component, other than those accessible with the other functions of the self.
Return type:: ECal.ComponentPropertyBag

Added in version 3.34.

get_repeat()¶

Returns:: the self repeat information, or None, when none is set
Return type:: ECal.ComponentAlarmRepeat or None

Get the self repeat information, as an ECal.ComponentAlarmRepeat.

Added in version 3.34.

get_summary()¶

Returns:: the self summary, or None, when none is set
Return type:: ECal.ComponentText or None

Get the self summary, as an ECal.ComponentText.

Added in version 3.34.

get_trigger()¶

Returns:: the self trigger, or None when, none is set
Return type:: ECal.ComponentAlarmTrigger or None

Get the self trigger, as an ECal.ComponentAlarmTrigger.

Added in version 3.34.

get_uid()¶

Returns:: the self UID, or None, when none is set
Return type:: str or None

Get the self UID.

Added in version 3.34.

has_attachments()¶

Returns:: whether the self has any attachments
Return type:: bool

Added in version 3.34.

has_attendees()¶

Returns:: whether the self has any attendees
Return type:: bool

Added in version 3.34.

set_acknowledged(when)¶

Parameters:: when (ICalGLib.Time or None) – an ICalGLib.Time when the self had been acknowledged, or None to unset

Set the acknowledged time of the self. Use None to unset it.

Added in version 3.40.

set_action(action)¶

Parameters:: action (ECal.ComponentAlarmAction) – an ECal.ComponentAlarmAction

Set the self action, as an ECal.ComponentAlarmAction.

Added in version 3.34.

set_attachments(attachments)¶

Parameters:: attachments ([ICalGLib.Attach] or None) – a GLib.SList of an ICalGLib.Attach objects to set as attachments, or None to unset

Set the list of attachments, as a GLib.SList of an ICalGLib.Attach.

Added in version 3.34.

set_attendees(attendees)¶

Parameters:: attendees ([ECal.ComponentAttendee] or None) – a GLib.SList of an ECal.ComponentAttendee objects to set as attendees, or None to unset

Set the list of attendees, as a GLib.SList of an ECal.ComponentAttendee.

Added in version 3.34.

set_description(description)¶

Parameters:: description (ECal.ComponentText or None) – a description to set, or None to unset

Set the self description, as an ECal.ComponentText.

Added in version 3.34.

set_from_component(component)¶

Parameters:: component (ICalGLib.Component) – an ICalGLib.Component

Fill the self structure with the information from the component, which should be of ICalGLib.ComponentKind.VALARM_COMPONENT kind.

Added in version 3.34.

set_repeat(repeat)¶

Parameters:: repeat (ECal.ComponentAlarmRepeat or None) – a repeat information to set, or None to unset

Set the self repeat information, as an ECal.ComponentAlarmRepeat.

Added in version 3.34.

set_summary(summary)¶

Parameters:: summary (ECal.ComponentText or None) – a summary to set, or None to unset

Set the self summary, as an ECal.ComponentText.

Added in version 3.34.

set_trigger(trigger)¶

Parameters:: trigger (ECal.ComponentAlarmTrigger or None) – a trigger to set, or None to unset

Set the self trigger, as an ECal.ComponentAlarmTrigger.

Added in version 3.34.

set_uid(uid)¶

Parameters:: uid (str or None) – a UID to set, or None or empty string to generate new

Set the self UID, or generates a new UID, if uid is None or an empty string.

Added in version 3.34.

take_acknowledged(when)¶

Parameters:: when (ICalGLib.Time or None) – an ICalGLib.Time when the self had been acknowledged, or None to unset

Set the acknowledged time of the self. Use None to unset it. The function assumes ownership of the when.

Added in version 3.40.