GData.CalendarService¶

Subclasses:: None

Methods¶

Inherited:: GData.Service (27), GObject.Object (37), GData.Batchable (1)
Structs:: GObject.ObjectClass (5)

class	`get_primary_authorization_domain` ()
class	`new` (authorizer)
	`insert_calendar_event` (calendar, event, cancellable)
	`insert_calendar_event_async` (calendar, event, cancellable, callback, *user_data)
	`insert_event` (event, cancellable)
	`insert_event_async` (event, cancellable, callback, *user_data)
	`query_all_calendars` (query, cancellable, progress_callback, *progress_user_data)
	`query_all_calendars_async` (query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	`query_events` (calendar, query, cancellable, progress_callback, *progress_user_data)
	`query_events_async` (calendar, query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	`query_own_calendars` (query, cancellable, progress_callback, *progress_user_data)
	`query_own_calendars_async` (query, cancellable, progress_callback, progress_user_data, callback, *user_data)

Virtual Methods¶

Inherited:: GData.Service (2), GObject.Object (7)

Properties¶

Inherited:: GData.Service (5)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Service`	r

Class Details¶

class GData.CalendarService(**kwargs)¶

Bases:: GData.Service, GData.Batchable
Abstract:: No
Structure:: GData.CalendarServiceClass

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

classmethod get_primary_authorization_domain()¶

Returns:: the service’s authorization domain
Return type:: GData.AuthorizationDomain

The primary GData.AuthorizationDomain for interacting with Google Calendar. This will not normally need to be used, as it’s used internally by the GData.CalendarService methods. However, if using the plain GData.Service methods to implement custom queries or requests which libgdata does not support natively, then this domain may be needed to authorize the requests.

The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.

New in version 0.9.0.

classmethod new(authorizer)¶

Parameters:: authorizer (GData.Authorizer or None) – a GData.Authorizer to authorize the service’s requests, or None
Returns:: a new GData.CalendarService, or None; unref with GObject.Object.unref()
Return type:: GData.CalendarService

Creates a new GData.CalendarService using the given GData.Authorizer. If authorizer is None, all requests are made as an unauthenticated user.

New in version 0.9.0.

insert_calendar_event(calendar, event, cancellable)¶

Parameters:

calendar (GData.CalendarCalendar) – the GData.CalendarCalendar to insert the event into
event (GData.CalendarEvent) – the GData.CalendarEvent to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

an updated GData.CalendarEvent, or None; unref with GObject.Object.unref()

Return type:

GData.CalendarEvent

Inserts event by uploading it to the online calendar service, adding it to the specified calendar.

For more details, see GData.Service.insert_entry().

New in version 0.17.2.

insert_calendar_event_async(calendar, event, cancellable, callback, *user_data)¶

Parameters:

calendar (GData.CalendarCalendar) – the GData.CalendarCalendar to insert the event into
event (GData.CalendarEvent) – the GData.CalendarEvent to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when insertion is finished
user_data (object or None) – data to pass to the callback function

Inserts event by uploading it to the online calendar service, adding it to the specified calendar. self and event are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.insert_entry_finish() to obtain a GData.CalendarEvent representing the inserted event and to check for possible errors.

For more details, see GData.CalendarService.insert_event(), which is the synchronous version of this function, and GData.Service.insert_entry_async(), which is the base asynchronous insertion function.

New in version 0.17.2.

insert_event(event, cancellable)¶

Parameters:

event (GData.CalendarEvent) – the GData.CalendarEvent to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

an updated GData.CalendarEvent, or None; unref with GObject.Object.unref()

Return type:

GData.CalendarEvent

Inserts event by uploading it to the online calendar service.

For more details, see GData.Service.insert_entry().

New in version 0.2.0.

Deprecated since version 0.17.2: Use GData.CalendarService.insert_calendar_event() instead to be able to specify the calendar to add the event to; otherwise the default calendar will be used.

insert_event_async(event, cancellable, callback, *user_data)¶

Parameters:

event (GData.CalendarEvent) – the GData.CalendarEvent to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when insertion is finished
user_data (object or None) – data to pass to the callback function

Inserts event by uploading it to the online calendar service. self and event are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.insert_entry_finish() to obtain a GData.CalendarEvent representing the inserted event and to check for possible errors.

For more details, see GData.CalendarService.insert_event(), which is the synchronous version of this function, and GData.Service.insert_entry_async(), which is the base asynchronous insertion function.

New in version 0.8.0.

Deprecated since version 0.17.2: Use GData.CalendarService.insert_calendar_event_async() instead to be able to specify the calendar to add the event to; otherwise the default calendar will be used.

query_all_calendars(query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of query results; unref with GObject.Object.unref()

Return type:

GData.Feed

Queries the service to return a list of all calendars from the authenticated account which match the given query. It will return all calendars the user has read access to, including primary, secondary and imported calendars.

For more details, see GData.Service.query().

query_all_calendars_async(query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when authentication is finished
user_data (object or None) – data to pass to the callback function

Queries the service to return a list of all calendars from the authenticated account which match the given query. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see GData.CalendarService.query_all_calendars(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.9.1.

query_events(calendar, query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

calendar (GData.CalendarCalendar) – a GData.CalendarCalendar
query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of query results; unref with GObject.Object.unref()

Return type:

GData.Feed

Queries the service to return a list of events in the given calendar, which match query.

For more details, see GData.Service.query().

query_events_async(calendar, query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

calendar (GData.CalendarCalendar) – a GData.CalendarCalendar
query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the query is finished
user_data (object or None) – data to pass to the callback function

Queries the service to return a list of events in the given calendar, which match query. self, calendar and query are all reffed when this function is called, so can safely be unreffed after this function returns.

Get the results of the query using GData.Service.query_finish() in the callback.

For more details, see GData.CalendarService.query_events(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.9.1.

query_own_calendars(query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of query results; unref with GObject.Object.unref()

Return type:

GData.Feed

Queries the service to return a list of calendars from the authenticated account which match the given query, and the authenticated user owns. (i.e. They have full read/write access to the calendar, as well as the ability to set permissions on the calendar.)

For more details, see GData.Service.query().

query_own_calendars_async(query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when authentication is finished
user_data (object or None) – data to pass to the callback function

Queries the service to return a list of calendars from the authenticated account which match the given query, and the authenticated user owns. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see GData.CalendarService.query_own_calendars(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.9.1.