GData.GDReminder¶

Subclasses:: None

Methods¶

Inherited:: GData.Parsable (5), GObject.Object (37), GData.Comparable (1)
Structs:: GObject.ObjectClass (5)

class	`new` (method, absolute_time, relative_time)
	`get_absolute_time` ()
	`get_method` ()
	`get_relative_time` ()
	`is_absolute_time` ()
	`set_absolute_time` (absolute_time)
	`set_method` (method)
	`set_relative_time` (relative_time)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7), GData.Comparable (1)

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`absolute-time`	`int`	r/w	Absolute time at which the reminder should be issued.
`is-absolute-time`	`bool`	r	Whether the reminder is specified as an absolute or relative time.
`method`	`str`	r/w	The notification method the reminder should use.
`relative-time`	`int`	r/w	Time at which the reminder should be issued, in minutes.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GDReminder(**kwargs)¶

Bases:: GData.Parsable, GData.Comparable
Abstract:: No
Structure:: GData.GDReminderClass

All the fields in the GData.GDReminder structure are private and should never be accessed directly.

New in version 0.2.0.

classmethod new(method, absolute_time, relative_time)¶

Parameters:

method (str or None) – the notification method the reminder should use, or None
absolute_time (int) – the absolute time for the reminder, or -1
relative_time (int) – the relative time for the reminder, in minutes, or -1

Returns:

a new GData.GDReminder, or None; unref with GObject.Object.unref()

Return type:

GData.GDReminder

Creates a new GData.GDReminder. More information is available in the GData specification.

New in version 0.2.0.

get_absolute_time()¶

Returns:: the UNIX timestamp of the absolute time for the reminder, or -1
Return type:: int

Gets the GData.GDReminder :absolute-time property. If the property is unset, -1 will be returned.

New in version 0.4.0.

get_method()¶

Returns:: the method, or None
Return type:: str

Gets the GData.GDReminder :method property.

New in version 0.4.0.

get_relative_time()¶

Returns:: the relative time, or -1
Return type:: int

Gets the GData.GDReminder :relative-time property.

New in version 0.4.0.

is_absolute_time()¶

Returns:: True if the reminder is absolute, False otherwise
Return type:: bool

Returns whether the reminder is specified as an absolute time, or as a number of minutes after the corresponding event’s start time.

New in version 0.4.0.

set_absolute_time(absolute_time)¶

Parameters:: absolute_time (int) – the new absolute time, or -1

Sets the GData.GDReminder :absolute-time property to absolute_time.

Set absolute_time to -1 to unset the property.

New in version 0.4.0.

set_method(method)¶

Parameters:: method (str or None) – the new method, or None

Sets the GData.GDReminder :method property to method.

Set method to None to unset the property.

New in version 0.4.0.

set_relative_time(relative_time)¶

Parameters:: relative_time (int) – the new relative time, or -1

Sets the GData.GDReminder :relative-time property to relative_time.

Set relative_time to -1 to unset the property.

New in version 0.4.0.

Property Details¶

GData.GDReminder.props.absolute_time¶

Name:: absolute-time
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Absolute time at which the reminder should be issued.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDReminder.props.is_absolute_time¶

Name:: is-absolute-time
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the reminder is specified as an absolute or relative time.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDReminder.props.method¶

Name:: method
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The notification method the reminder should use. For example: GData.GD_REMINDER_ALERT or GData.GD_REMINDER_EMAIL.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDReminder.props.relative_time¶

Name:: relative-time
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Time at which the reminder should be issued, in minutes relative to the start time of the corresponding event.

For more information, see the

GData specification.

New in version 0.4.0.