GData.CalendarQuery¶

Subclasses:: None

Methods¶

Inherited:: GData.Query (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (q)
class	`new_with_limits` (q, start_min, start_max)
	`get_future_events` ()
	`get_max_attendees` ()
	`get_order_by` ()
	`get_recurrence_expansion_end` ()
	`get_recurrence_expansion_start` ()
	`get_single_events` ()
	`get_sort_order` ()
	`get_start_max` ()
	`get_start_min` ()
	`get_timezone` ()
	`set_future_events` (future_events)
	`set_max_attendees` (max_attendees)
	`set_order_by` (order_by)
	`set_recurrence_expansion_end` (end)
	`set_recurrence_expansion_start` (start)
	`set_show_deleted` (show_deleted)
	`set_single_events` (single_events)
	`set_sort_order` (sort_order)
	`set_start_max` (start_max)
	`set_start_min` (start_min)
	`set_timezone` (_timezone)
	`show_deleted` ()

Virtual Methods¶

Inherited:: GData.Query (1), GObject.Object (7)

Properties¶

Inherited:: GData.Query (11)

Name	Type	Flags	Short Description
`future-events`	`bool`	r/w	A shortcut to request all events scheduled for the future.
`max-attendees`	`int`	r/w	Specifies the maximum number of attendees to list for an event.
`order-by`	`str`	r/w	Specifies order of entries in a feed.
`recurrence-expansion-end`	`int`	d/r/w	Specifies end of period to expand recurrences for. `deprecated`
`recurrence-expansion-start`	`int`	d/r/w	Specifies start of period to expand recurrences for. `deprecated`
`show-deleted`	`bool`	r/w	Whether to include deleted/cancelled events in the query feed.
`single-events`	`bool`	r/w	Indicates whether recurring events should be expanded.
`sort-order`	`str`	d/r/w	Specifies direction of sorting. `deprecated`
`start-max`	`int`	r/w	A timespan such that only events within the timespan are returned.
`start-min`	`int`	r/w	A timespan such that only events within the timespan are returned.
`timezone`	`str`	r/w	The current timezone.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Query`	r

Class Details¶

class GData.CalendarQuery(**kwargs)¶

Bases:: GData.Query
Abstract:: No
Structure:: GData.CalendarQueryClass

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

classmethod new(q)¶

Parameters:: q (str or None) – a query string, or None
Returns:: a new GData.CalendarQuery
Return type:: GData.CalendarQuery

Creates a new GData.CalendarQuery with its GData.Query :q property set to q.

classmethod new_with_limits(q, start_min, start_max)¶

Parameters:

q (str or None) – a query string, or None
start_min (int) – a starting time for the event period, or -1
start_max (int) – an ending time for the event period, or -1

Returns:

a new GData.CalendarQuery

Return type:

GData.CalendarQuery

Creates a new GData.CalendarQuery with its GData.Query :q property set to q, and the time limits start_min and start_max applied (both in seconds since the UNIX epoch).

get_future_events()¶

Returns:: the future events property
Return type:: bool

Gets the GData.CalendarQuery :future-events property.

get_max_attendees()¶

Returns:: the maximum number of attendees, or 0
Return type:: int

Gets the GData.CalendarQuery :max-attendees property. If the property is unset, 0 will be returned.

New in version 0.9.1.

get_order_by()¶

Returns:: the order by property, or None if it is unset
Return type:: str

Gets the GData.CalendarQuery :order-by property.

get_recurrence_expansion_end()¶

Returns:: the UNIX timestamp for the recurrence-expansion-end property, or -1
Return type:: int

Gets the GData.CalendarQuery :recurrence-expansion-end property. If the property is unset, -1 will be returned.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

get_recurrence_expansion_start()¶

Returns:: the UNIX timestamp for the recurrence-expansion-start property, or -1
Return type:: int

Gets the GData.CalendarQuery :recurrence-expansion-start property. If the property is unset, -1 will be returned.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

get_single_events()¶

Returns:: the single events property
Return type:: bool

Gets the GData.CalendarQuery :single-events property.

get_sort_order()¶

Returns:: the sort order property, or None if it is unset
Return type:: str

Gets the GData.CalendarQuery :sort-order property.

Deprecated since version 0.17.7: Manually sort the results after retrieving them, as this is no longer supported on the server.

get_start_max()¶

Returns:: the UNIX timestamp (in seconds) for the start-max property, or -1
Return type:: int

Gets the GData.CalendarQuery :start-max property. If the property is unset, -1 will be returned.

get_start_min()¶

Returns:: the UNIX timestamp (in seconds) for the start-min property, or -1
Return type:: int

Gets the GData.CalendarQuery :start-min property. If the property is unset, -1 will be returned.

get_timezone()¶

Returns:: the timezone property, or None if it is unset
Return type:: str

Gets the GData.CalendarQuery :timezone property.

New in version 0.2.0.

set_future_events(future_events)¶

Parameters:: future_events (bool) – True to unconditionally show future events, False otherwise

Sets the GData.CalendarQuery :future-events property of the GData.CalendarQuery to future_events.

set_max_attendees(max_attendees)¶

Parameters:: max_attendees (int) – a new maximum attendee count, or 0

Sets the GData.CalendarQuery :max-attendees property of the GData.CalendarQuery to the new value, max_attendees.

Set max_attendees to 0 to unset the property in the query URI.

New in version 0.9.1.

set_order_by(order_by)¶

Parameters:: order_by (str or None) – a new order by string, or None

Sets the GData.CalendarQuery :order-by property of the GData.CalendarQuery to the new order by string, order_by.

Set order_by to None to unset the property in the query URI.

set_recurrence_expansion_end(end)¶

Parameters:: end (int) – a new end time, or -1

Sets the GData.CalendarQuery :recurrence-expansion-end property of the GData.CalendarQuery to the new time/date, end.

Set end to -1 to unset the property in the query URI.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

set_recurrence_expansion_start(start)¶

Parameters:: start (int) – a new start time, or -1

Sets the GData.CalendarQuery :recurrence-expansion-start property of the GData.CalendarQuery to the new time/date, start.

Set start to -1 to unset the property in the query URI.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

set_show_deleted(show_deleted)¶

Parameters:: show_deleted (bool) – True to show deleted events, False otherwise

Sets the GData.CalendarQuery :show-deleted property of the GData.CalendarQuery.

New in version 0.9.1.

set_single_events(single_events)¶

Parameters:: single_events (bool) – True to show recurring events as single events, False otherwise

Sets the GData.CalendarQuery :single-events property of the GData.CalendarQuery to single_events.

set_sort_order(sort_order)¶

Parameters:: sort_order (str or None) – a new sort order string, or None

Sets the GData.CalendarQuery :sort-order property of the GData.CalendarQuery to the new sort order string, sort_order.

Set sort_order to None to unset the property in the query URI.

Deprecated since version 0.17.7: Manually sort the results after retrieving them, as this is no longer supported on the server.

set_start_max(start_max)¶

Parameters:: start_max (int) – a new maximum start time (in seconds since the UNIX epoch), or -1

Sets the GData.CalendarQuery :start-max property of the GData.CalendarQuery to the new time/date, start_max.

Set start_max to -1 to unset the property in the query URI.

set_start_min(start_min)¶

Parameters:: start_min (int) – a new minimum start time (in seconds since the UNIX epoch), or -1

Sets the GData.CalendarQuery :start-min property of the GData.CalendarQuery to the new time/date, start_min.

Set start_min to -1 to unset the property in the query URI.

set_timezone(_timezone)¶

Parameters:: _timezone (str or None) – a new timezone string, or None

Sets the GData.CalendarQuery :timezone property of the GData.CalendarQuery to the new timezone string, timezone.

Set timezone to None to unset the property in the query URI.

New in version 0.2.0.

show_deleted()¶

Returns:: True if deleted/cancelled events should be shown, False otherwise
Return type:: bool

Gets the GData.CalendarQuery :show-deleted property.

New in version 0.9.1.

Property Details¶

GData.CalendarQuery.props.future_events¶

Name:: future-events
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

A shortcut to request all events scheduled for the future. Overrides the GData.CalendarQuery :recurrence-expansion-start, GData.CalendarQuery :recurrence-expansion-end, GData.CalendarQuery :start-min and GData.CalendarQuery :start-max properties.

GData.CalendarQuery.props.max_attendees¶

Name:: max-attendees
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Specifies the maximum number of attendees to list for an event. If the actual number of attendees for an event is greater than this value, only the current user and the event organiser are listed.

New in version 0.9.1.

GData.CalendarQuery.props.order_by¶

Name:: order-by
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Specifies order of entries in a feed. Supported values are lastmodified and starttime.

GData.CalendarQuery.props.recurrence_expansion_end¶

Name:: recurrence-expansion-end
Type:: int
Default Value:: -1
Flags:: DEPRECATED, READABLE, WRITABLE

Specifies the end of the time period to expand recurring events for, exclusive.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

GData.CalendarQuery.props.recurrence_expansion_start¶

Name:: recurrence-expansion-start
Type:: int
Default Value:: -1
Flags:: DEPRECATED, READABLE, WRITABLE

Specifies the beginning of the time period to expand recurring events for, inclusive.

Deprecated since version 0.17.7: Use GData.CalendarQuery :single-events instead, as this is no longer supported on the server.

GData.CalendarQuery.props.show_deleted¶

Name:: show-deleted
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether to include deleted/cancelled events in the query feed. Deleted events have their GData.CalendarEvent :status property set to GData.GD_EVENT_STATUS_CANCELED. They do not normally appear in query results.

New in version 0.9.1.

GData.CalendarQuery.props.single_events¶

Name:: single-events
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Indicates whether recurring events should be expanded or represented as a single event.

GData.CalendarQuery.props.sort_order¶

Name:: sort-order
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE, WRITABLE

Specifies direction of sorting. Supported values are ascending and descending.

By default, results are returned in ascending order.

Deprecated since version 0.17.7: Manually sort the results after retrieving them, as this is no longer supported on the server.

GData.CalendarQuery.props.start_max¶

Name:: start-max
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Together with GData.CalendarQuery :start-min, creates a timespan such that only events within the timespan are returned

GData.CalendarQuery :start-min is inclusive, while GData.CalendarQuery :start-max is exclusive. Events that overlap the range are included. Both are specified in seconds since the UNIX epoch.

If not specified, the default GData.CalendarQuery :start-max is 2031-01-01.

GData.CalendarQuery.props.start_min¶

Name:: start-min
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Together with GData.CalendarQuery :start-max, creates a timespan such that only events within the timespan are returned.

GData.CalendarQuery :start-min is inclusive, while GData.CalendarQuery :start-max is exclusive. Events that overlap the range are included. Both are specified in seconds since the UNIX epoch.

If not specified, the default GData.CalendarQuery :start-min is 1970-01-01.

GData.CalendarQuery.props.timezone¶

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

The current timezone. If this is not specified, all times are returned in UTC.

New in version 0.2.0.