GData.TasksService¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class GData.TasksService(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
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:
The primary
GData.AuthorizationDomain
for interacting with Google Tasks. This will not normally need to be used, as it’s used internally by theGData.TasksService
methods. However, if using the plainGData.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
orNone
) – aGData.Authorizer
to authorize the service’s requests, orNone
- Returns:
a new
GData.TasksService
, orNone
; unref withGObject.Object.unref
()- Return type:
Creates a new
GData.TasksService
using the givenGData.Authorizer
. If authorizer isNone
, all requests are made as an unauthenticated user.New in version 0.15.0.
- delete_task(task, cancellable)¶
- Parameters:
task (
GData.TasksTask
) – theGData.TasksTask
to deletecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
- Return type:
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 deletecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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, andGData.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
) – theGData.TasksTasklist
to deletecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
- Return type:
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 deletecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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, andGData.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
) – theGData.TasksTask
to inserttasklist (
GData.TasksTasklist
) –GData.TasksTasklist
to insert intocancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
an updated
GData.TasksTask
, orNone
; unref withGObject.Object.unref
()- Return type:
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
) – theGData.TasksTask
to inserttasklist (
GData.TasksTasklist
) –GData.TasksTasklist
to insert intocancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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 aGData.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, andGData.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 insertcancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
an updated
GData.TasksTasklist
, orNone
; unref withGObject.Object.unref
()- Return type:
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 insertcancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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 aGData.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, andGData.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
orNone
) – aGData.Query
with the query parameters, orNone
cancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
progress_callback (
GData.QueryProgressCallback
orNone
) – aGData.QueryProgressCallback
to call when an entry is loaded, orNone
progress_user_data (
object
orNone
) – data to pass to the progress_callback function
- Raises:
- Returns:
a
GData.Feed
of query results; unref withGObject.Object.unref
()- Return type:
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
orNone
) – aGData.Query
with the query parameters, orNone
cancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
progress_callback (
GData.QueryProgressCallback
orNone
) – aGData.QueryProgressCallback
to call when an entry is loaded, orNone
progress_user_data (
object
orNone
) – data to pass to the progress_callback functioncallback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when authentication is finisheduser_data (
object
orNone
) – 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, andGData.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
) – aGData.TasksTasklist
query (
GData.Query
orNone
) – aGData.Query
with the query parameters, orNone
cancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
progress_callback (
GData.QueryProgressCallback
orNone
) – aGData.QueryProgressCallback
to call when an entry is loaded, orNone
progress_user_data (
object
orNone
) – data to pass to the progress_callback function
- Raises:
- Returns:
a
GData.Feed
of query results; unref withGObject.Object.unref
()- Return type:
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
) – aGData.TasksTasklist
query (
GData.Query
orNone
) – aGData.Query
with the query parameters, orNone
cancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
progress_callback (
GData.QueryProgressCallback
orNone
) – aGData.QueryProgressCallback
to call when an entry is loaded, orNone
progress_user_data (
object
orNone
) – data to pass to the progress_callback functioncallback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when the query is finisheduser_data (
object
orNone
) – 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, andGData.Service.query_async
(), which is the base asynchronous query function.New in version 0.15.0.
- update_task(task, cancellable)¶
- Parameters:
task (
GData.TasksTask
) – theGData.TasksTask
to updatecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
an updated
GData.TasksTask
, orNone
; unref withGObject.Object.unref
()- Return type:
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 updatecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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 aGData.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, andGData.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
) – theGData.TasksTasklist
to updatecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
- Raises:
- Returns:
an updated
GData.TasksTasklist
, orNone
; unref withGObject.Object.unref
()- Return type:
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 updatecancellable (
Gio.Cancellable
orNone
) – optionalGio.Cancellable
object, orNone
callback (
Gio.AsyncReadyCallback
orNone
) – aGio.AsyncReadyCallback
to call when insertion is finisheduser_data (
object
orNone
) – 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 aGData.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, andGData.Service.update_entry_async
(), which is the base asynchronous insertion function.New in version 0.15.0.