GData.TasksService¶

Subclasses:: None

Methods¶

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

class	`get_primary_authorization_domain` ()
class	`new` (authorizer)
	`delete_task` (task, cancellable)
	`delete_task_async` (task, cancellable, callback, *user_data)
	`delete_tasklist` (tasklist, cancellable)
	`delete_tasklist_async` (tasklist, cancellable, callback, *user_data)
	`insert_task` (task, tasklist, cancellable)
	`insert_task_async` (task, tasklist, cancellable, callback, *user_data)
	`insert_tasklist` (tasklist, cancellable)
	`insert_tasklist_async` (tasklist, cancellable, callback, *user_data)
	`query_all_tasklists` (query, cancellable, progress_callback, *progress_user_data)
	`query_all_tasklists_async` (query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	`query_tasks` (tasklist, query, cancellable, progress_callback, *progress_user_data)
	`query_tasks_async` (tasklist, query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	`update_task` (task, cancellable)
	`update_task_async` (task, cancellable, callback, *user_data)
	`update_tasklist` (tasklist, cancellable)
	`update_tasklist_async` (tasklist, cancellable, 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.TasksService(**kwargs)¶

Bases:: GData.Service
Abstract:: No
Structure:: GData.TasksServiceClass

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

New in version 0.15.0.

classmethod get_primary_authorization_domain()¶

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

The primary GData.AuthorizationDomain for interacting with Google Tasks. This will not normally need to be used, as it’s used internally by the GData.TasksService 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.15.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.TasksService, or None; unref with GObject.Object.unref()
Return type:: GData.TasksService

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

New in version 0.15.0.

delete_task(task, cancellable)¶

Parameters:

task (GData.TasksTask) – the GData.TasksTask to delete
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

True on success, False otherwise

Return type:

bool

Delete task from online tasks service.

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

New in version 0.15.0.

delete_task_async(task, cancellable, callback, *user_data)¶

Parameters:

task (GData.TasksTask) – GData.TasksTask to delete
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

Deletes task from online tasks service. self and task are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.delete_entry_finish() to finish deleting task and to check for possible errors.

For more details, see GData.TasksService.delete_task(), which is the synchronous version of this function, and GData.Service.delete_entry_async(), which is the base asynchronous insertion function.

New in version 0.15.0.

delete_tasklist(tasklist, cancellable)¶

Parameters:

tasklist (GData.TasksTasklist) – the GData.TasksTasklist to delete
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

True on success, False otherwise

Return type:

bool

Delete tasklist from online tasks service.

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

New in version 0.15.0.

delete_tasklist_async(tasklist, cancellable, callback, *user_data)¶

Parameters:

tasklist (GData.TasksTasklist) – GData.TasksTasklist to delete
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

Deletes tasklist from online tasks service. self and tasklist are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.delete_entry_finish() to finish deleting tasklist and to check for possible errors.

For more details, see GData.TasksService.delete_tasklist(), which is the synchronous version of this function, and GData.Service.delete_entry_async(), which is the base asynchronous insertion function.

New in version 0.15.0.

insert_task(task, tasklist, cancellable)¶

Parameters:

task (GData.TasksTask) – the GData.TasksTask to insert
tasklist (GData.TasksTasklist) – GData.TasksTasklist to insert into
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

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

Return type:

GData.TasksTask

Inserts task by uploading it to the online tasks service into tasklist tasklist. It is safe to unref tasklist after function returns.

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

New in version 0.15.0.

insert_task_async(task, tasklist, cancellable, callback, *user_data)¶

Parameters:

task (GData.TasksTask) – the GData.TasksTask to insert
tasklist (GData.TasksTasklist) – GData.TasksTasklist to insert into
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 task by uploading it to the online tasks service into tasklist tasklist. self, task and tasklist are all 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.TasksTask representing the inserted task and to check for possible errors.

For more details, see GData.TasksService.insert_task(), 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.15.0.

insert_tasklist(tasklist, cancellable)¶

Parameters:

tasklist (GData.TasksTasklist) – GData.TasksTasklist to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

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

Return type:

GData.TasksTasklist

Inserts tasklist by uploading it to the online tasks service.

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

New in version 0.15.0.

insert_tasklist_async(tasklist, cancellable, callback, *user_data)¶

Parameters:

tasklist (GData.TasksTasklist) – GData.TasksTasklist 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 tasklist by uploading it to the online tasks service. self and tasklist 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.TasksTasklist representing the inserted tasklist and to check for possible errors.

For more details, see GData.TasksService.insert_tasklist(), 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.15.0.

query_all_tasklists(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 tasklists from the authenticated account which match the given query. It will return all tasklists the user has read access to.

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

New in version 0.15.0.

query_all_tasklists_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 tasklists 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.TasksService.query_all_tasklists(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.15.0.

query_tasks(tasklist, query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

tasklist (GData.TasksTasklist) – a GData.TasksTasklist
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 tasks in the given tasklist, which match query.

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

New in version 0.15.0.

query_tasks_async(tasklist, query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

tasklist (GData.TasksTasklist) – a GData.TasksTasklist
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 tasks in the given tasklist, which match query. self, tasklist 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.TasksService.query_tasks(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.15.0.

update_task(task, cancellable)¶

Parameters:

task (GData.TasksTask) – the GData.TasksTask to update
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

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

Return type:

GData.TasksTask

Update task in online tasks service.

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

New in version 0.15.0.

update_task_async(task, cancellable, callback, *user_data)¶

Parameters:

task (GData.TasksTask) – GData.TasksTask to update
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

Updates task to online tasks service. self and task are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.update_entry_finish() to obtain a GData.TasksTask representing the updated task and to check for possible errors.

For more details, see GData.TasksService.update_task(), which is the synchronous version of this function, and GData.Service.update_entry_async(), which is the base asynchronous insertion function.

New in version 0.15.0.

update_tasklist(tasklist, cancellable)¶

Parameters:

tasklist (GData.TasksTasklist) – the GData.TasksTasklist to update
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

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

Return type:

GData.TasksTasklist

Update tasklist in online tasks service.

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

New in version 0.15.0.

update_tasklist_async(tasklist, cancellable, callback, *user_data)¶

Parameters:

tasklist (GData.TasksTasklist) – GData.TasksTasklist to update
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

Updates tasklist from online tasks service. self and tasklist are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.update_entry_finish() to obtain a GData.TasksTasklist representing the updated task and to check for possible errors.

For more details, see GData.TasksService.update_tasklist(), which is the synchronous version of this function, and GData.Service.update_entry_async(), which is the base asynchronous insertion function.

New in version 0.15.0.