EDataServer.SourceAlarms

g EDataServer.SourceAlarms EDataServer.SourceAlarms EDataServer.SourceExtension EDataServer.SourceExtension EDataServer.SourceExtension->EDataServer.SourceAlarms GObject.Object GObject.Object GObject.Object->EDataServer.SourceExtension

Subclasses:None

Virtual Methods

Inherited:GObject.Object (7)

Properties

Inherited:EDataServer.SourceExtension (1)
Name Type Flags Short Description
include-me bool r/w/c/en Include this source in alarm notifications
last-notified str r/w/c/en Last alarm notification (in ISO 8601 format)

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent EDataServer.SourceExtension r  

Class Details

class EDataServer.SourceAlarms(**kwargs)
Bases:EDataServer.SourceExtension
Abstract:No
Structure:EDataServer.SourceAlarmsClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

dup_last_notified()
Returns:a newly-allocated copy of EDataServer.SourceAlarms :last-notified
Return type:str or None

Thread-safe variation of EDataServer.SourceAlarms.get_last_notified(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

get_include_me()
Returns:whether to show alarms for upcoming appointments
Return type:bool

Returns whether the user should be alerted about upcoming appointments in the calendar described by the EDataServer.Source to which self belongs.

Alarm daemons such as evolution-alarm-notify can use this property to decide which calendars to query for upcoming appointments.

New in version 3.6.

get_last_notified()
Returns:an ISO 8601 timestamp, or None
Return type:str or None

Returns an ISO 8601 formatted timestamp of when the user was last alerted about an upcoming appointment in the calendar described by the EDataServer.Source to which self belongs. If no valid timestamp has been set, the function will return None.

New in version 3.6.

set_include_me(include_me)
Parameters:include_me (bool) – whether to show alarms for upcoming appointments

Sets whether the user should be alerted about upcoming appointments in the calendar described by the EDataServer.Source to which self belongs.

Alarm daemons such as evolution-alarm-notify can use this property to decide which calendars to query for upcoming appointments.

New in version 3.6.

set_last_notified(last_notified)
Parameters:last_notified (str or None) – an ISO 8601 timestamp, or None

Sets an ISO 8601 formatted timestamp of when the user was last alerted about an upcoming appointment in the calendar described by the EDataServer.Source to which self belongs.

If last_notified is non-None, the function will validate the timestamp before setting the EDataServer.SourceAlarms :last-notified property. Invalid timestamps are discarded with a runtime warning.

Generally, this function should only be called by an alarm daemon such as evolution-alarm-notify.

New in version 3.6.

Property Details

EDataServer.SourceAlarms.props.include_me
Name:include-me
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Include this source in alarm notifications

EDataServer.SourceAlarms.props.last_notified
Name:last-notified
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Last alarm notification (in ISO 8601 format)