EDataServer.GDataSession¶

Subclasses:: None

Methods¶

Inherited:: EDataServer.SoupSession (27), Soup.Session (43), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (source)
	`tasklists_delete_sync` (tasklist_id, cancellable)
	`tasklists_get_sync` (tasklist_id, cancellable)
	`tasklists_insert_sync` (title, cancellable)
	`tasklists_list_sync` (query, cb, user_data, cancellable)
	`tasklists_patch_sync` (tasklist_id, tasklist_properties, cancellable)
	`tasklists_update_sync` (tasklist_id, tasklist, cancellable)
	`tasks_clear_sync` (tasklist_id, cancellable)
	`tasks_delete_sync` (tasklist_id, task_id, cancellable)
	`tasks_get_sync` (tasklist_id, task_id, cancellable)
	`tasks_insert_sync` (tasklist_id, task, parent_task_id, previous_task_id, cancellable)
	`tasks_list_sync` (tasklist_id, query, cb, user_data, cancellable)
	`tasks_move_sync` (tasklist_id, task_id, parent_task_id, previous_task_id, cancellable)
	`tasks_patch_sync` (tasklist_id, task_id, task_properties, cancellable)
	`tasks_update_sync` (tasklist_id, task_id, task, cancellable)

Virtual Methods¶

Inherited:: Soup.Session (2), GObject.Object (7)

Properties¶

Inherited:: EDataServer.SoupSession (3), Soup.Session (12)

Signals¶

Inherited:: Soup.Session (2), GObject.Object (1)

Fields¶

Inherited:: Soup.Session (2), GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SoupSession`	r

Class Details¶

class EDataServer.GDataSession(**kwargs)¶

Bases:: EDataServer.SoupSession
Abstract:: No
Structure:: EDataServer.GDataSessionClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.46.

classmethod new(source)¶

Parameters:: source (EDataServer.Source) – an EDataServer.Source
Returns:: a new EDataServer.GDataSession; free it with GObject.Object.unref(), when no longer needed.
Return type:: EDataServer.GDataSession

Creates a new EDataServer.GDataSession associated with the given source.

New in version 3.46.

tasklists_delete_sync(tasklist_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Deletes a task list tasklist_id.

New in version 3.46.

tasklists_get_sync(tasklist_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_tasklist:: tasklist object

Return type:

(bool, out_tasklist: Json.Object)

Gets a task list tasklist_id and returns it as a Json.Object, which should be freed with Json.Object.unref(), when no longer needed.

There can be used EDataServer.gdata_tasklist_get_id(), EDataServer.gdata_tasklist_get_etag(), EDataServer.gdata_tasklist_get_title(), EDataServer.gdata_tasklist_get_self_link(), EDataServer.gdata_tasklist_get_updated() to read the properties of the task list.

New in version 3.46.

tasklists_insert_sync(title, cancellable)¶

Parameters:

title (str) – title to set
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_inserted_tasklist:: the created task list

Return type:

(bool, out_inserted_tasklist: Json.Object)

Creates a new task list, titled title. The out_inserted_tasklist should be freed with Json.Object.unref(), when no longer needed.

New in version 3.46.

tasklists_list_sync(query, cb, user_data, cancellable)¶

Parameters:

query (EDataServer.GDataQuery or None) – an EDataServer.GDataQuery to limit returned task lists, or None
cb (EDataServer.GDataObjectCallback or None) – an EDataServer.GDataObjectCallback to call for each found task list
user_data (object or None) – user data passed to the cb
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Lists all configured task lists for the user, calling the cb for each of them.

New in version 3.46.

tasklists_patch_sync(tasklist_id, tasklist_properties, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
tasklist_properties (Json.Builder) – task list properties to change
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_patched_tasklist:: where to store patched task list, or None

Return type:

(bool, out_patched_tasklist: Json.Object)

Changes properties of a task list tasklist_id.

If not None, free the out_patched_tasklist with Json.Object.unref(), when no longer needed.

New in version 3.46.

tasklists_update_sync(tasklist_id, tasklist, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
tasklist (Json.Builder) – task list object to update the task list with
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_updated_tasklist:: where to store updated task list, or None

Return type:

(bool, out_updated_tasklist: Json.Object)

Updates a task list tasklist_id with values from the tasklist.

New in version 3.46.

tasks_clear_sync(tasklist_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Clears all completed tasks from the task list tasklist_id. The affected tasks will be marked as ‘hidden’ and no longer be returned by default when retrieving all tasks for a task list.

New in version 3.46.

tasks_delete_sync(tasklist_id, task_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task_id (str) – id of a task
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Deletes a task task_id from a task list tasklist_id.

New in version 3.46.

tasks_get_sync(tasklist_id, task_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task_id (str) – id of a task
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_task:: task object

Return type:

(bool, out_task: Json.Object)

Gets a task task_id from a task list tasklist_id and returns it as a Json.Object, which should be freed with Json.Object.unref(), when no longer needed.

There can be used EDataServer.gdata_task_get_id(), EDataServer.gdata_task_get_etag(), EDataServer.gdata_task_get_title() and other e_gdata_task_… functions to read the properties of the task.

New in version 3.46.

tasks_insert_sync(tasklist_id, task, parent_task_id, previous_task_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task (Json.Builder) – a Json.Builder with the task object
parent_task_id (str or None) – parent task identifier, or None to create at the top-level
previous_task_id (str or None) – previous sibling task identifier, or None to create at the first position among its siblings
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_inserted_task:: the created task

Return type:

(bool, out_inserted_task: Json.Object)

Creates a new task task in the task list tasklist_id. The out_inserted_task should be freed with Json.Object.unref(), when no longer needed.

New in version 3.46.

tasks_list_sync(tasklist_id, query, cb, user_data, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
query (EDataServer.GDataQuery or None) – an EDataServer.GDataQuery to limit returned tasks, or None
cb (EDataServer.GDataObjectCallback or None) – an EDataServer.GDataObjectCallback to call for each found task
user_data (object or None) – user data passed to the cb
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Lists all tasks in the task list tasklist_id, calling the cb for each of them.

New in version 3.46.

tasks_move_sync(tasklist_id, task_id, parent_task_id, previous_task_id, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task_id (str) – id of a task
parent_task_id (str or None) – parent task identifier, or None to move at the top-level
previous_task_id (str or None) – previous sibling task identifier, or None to move at the first position among its siblings
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

Return type:

bool

Moves the specified task task_id to another position in the task list tasklist_id. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.

New in version 3.46.

tasks_patch_sync(tasklist_id, task_id, task_properties, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task_id (str) – id of a task
task_properties (Json.Builder) – task properties to change
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_patched_task:: where to set patches task, or None

Return type:

(bool, out_patched_task: Json.Object)

Changes properties task_properties of a task task_id in the task list tasklist_id.

If not None, free the out_patched_task with Json.Object.unref(), when no longer needed.

New in version 3.46.

tasks_update_sync(tasklist_id, task_id, task, cancellable)¶

Parameters:

tasklist_id (str) – id of a task list
task_id (str) – id of a task
task (Json.Builder) – task object to update the task with
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

whether succeeded

out_updated_task:: where to store updated task, or None

Return type:

(bool, out_updated_task: Json.Object)

Updates a task task_id in a task list tasklist_id to the values from the task.

New in version 3.46.