GData.TasksTask¶

Subclasses:: None

Methods¶

Inherited:: GData.Entry (24), GData.Parsable (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (id)
	`get_completed` ()
	`get_due` ()
	`get_notes` ()
	`get_parent` ()
	`get_position` ()
	`get_status` ()
	`is_deleted` ()
	`is_hidden` ()
	`set_completed` (completed)
	`set_due` (due)
	`set_is_deleted` (deleted)
	`set_notes` (notes)
	`set_parent` (parent)
	`set_position` (position)
	`set_status` (status)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7)

Properties¶

Inherited:: GData.Entry (10), GData.Parsable (1)

Name	Type	Flags	Short Description
`completed`	`int`	r/w	Completion date of the task.
`due`	`int`	r/w	Due date of the task.
`is-deleted`	`bool`	r/w	Indicated whatever task is deleted.
`is-hidden`	`bool`	r	Indicated whatever task is hidden.
`notes`	`str`	r/w	Notes describing the task.
`parent`	`str`	r/w	Identifier of parent task.
`position`	`str`	r/w	Position of the task among sibling tasks using lexicographical order.
`status`	`str`	r/w	Status of the task.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Entry`	r

Class Details¶

class GData.TasksTask(**kwargs)¶

Bases:: GData.Entry
Abstract:: No
Structure:: GData.TasksTaskClass

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

New in version 0.15.0.

classmethod new(id)¶

Parameters:: id (str or None) – the task’s ID, or None
Returns:: a new GData.TasksTask; unref with GObject.Object.unref()
Return type:: GData.TasksTask

Creates a new GData.TasksTask with the given ID and default properties.

New in version 0.15.0.

get_completed()¶

Returns:: the completed property, or -1
Return type:: int

Gets the GData.TasksTask :completed property. If the property is unset, -1 will be returned.

New in version 0.15.0.

get_due()¶

Returns:: the due property, or -1
Return type:: int

Gets the GData.TasksTask :due property. If the property is unset, -1 will be returned.

New in version 0.15.0.

get_notes()¶

Returns:: notes of the task, or None
Return type:: str or None

Gets the GData.TasksTask :notes property.

New in version 0.15.0.

get_parent()¶

Returns:: the parent of the task, or None
Return type:: str or None

Gets the GData.TasksTask :parent property.

New in version 0.15.0.

get_position()¶

Returns:: the position of the task, or None
Return type:: str or None

Gets the GData.TasksTask :position property.

New in version 0.15.0.

get_status()¶

Returns:: the status of the task, or None
Return type:: str or None

Gets the GData.TasksTask :status property.

New in version 0.15.0.

is_deleted()¶

Returns:: True if task is deleted, False otherwise
Return type:: bool

Gets the GData.TasksTask :is-deleted property.

New in version 0.15.0.

is_hidden()¶

Returns:: True if task is hidden, False otherwise
Return type:: bool

Gets the GData.TasksTask :is-hidden property.

New in version 0.15.0.

set_completed(completed)¶

Parameters:: completed (int) – completion time of the task, or -1

Sets the GData.TasksTask :completed property of the GData.TasksTask to the new completion time of the task, completed.

Set completed to -1 to unset the property in the completion time of the task

New in version 0.15.0.

set_due(due)¶

Parameters:: due (int) – due time of the task, or -1

Sets the GData.TasksTask :due property of the GData.TasksTask to the new due time of the task, due.

Set due to -1 to unset the property in the due time of the task

New in version 0.15.0.

set_is_deleted(deleted)¶

Parameters:: deleted (bool) – True if task is deleted, False otherwise

Sets the GData.TasksTask :is-deleted property to deleted.

New in version 0.15.0.

set_notes(notes)¶

Parameters:: notes (str or None) – a new notes of the task, or None

Sets the GData.TasksTask :notes property to the new notes, notes.

Set notes to None to unset the property in the task.

New in version 0.15.0.

set_parent(parent)¶

Parameters:: parent (str or None) – parent of the task

Sets the GData.TasksTask :parent property.

New in version 0.17.10.

set_position(position)¶

Parameters:: position (str) – position of the task in the list

Sets the GData.TasksTask :position property.

New in version 0.17.10.

set_status(status)¶

Parameters:: status (str or None) – a new status of the task, or None

Sets the GData.TasksTask :status property to the new status, status.

Set status to None to unset the property in the task.

New in version 0.15.0.

Property Details¶

GData.TasksTask.props.completed¶

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

Completion date of the task (as a RFC 3339 timestamp; seconds since the UNIX epoch).

This field is -1 if the task has not been completed.

New in version 0.15.0.

GData.TasksTask.props.due¶

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

Due date of the task (as a RFC 3339 timestamp; seconds since the UNIX epoch).

This field is -1 if the task has no due date assigned.

New in version 0.15.0.

GData.TasksTask.props.is_deleted¶

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

Flag indicating whether the task has been deleted. The default is False.

New in version 0.15.0.

GData.TasksTask.props.is_hidden¶

Name:: is-hidden
Type:: bool
Default Value:: False
Flags:: READABLE

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

New in version 0.15.0.

GData.TasksTask.props.notes¶

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

This is where the description of what needs to be done in the task is stored.

New in version 0.15.0.

GData.TasksTask.props.parent¶

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

Parent task identifier. This field is omitted if it is a top-level task.

Since 0.17.10, this property is writable.

New in version 0.15.0.

GData.TasksTask.props.position¶

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

String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task’s corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level).

Since 0.17.10, this property is writable.

New in version 0.15.0.

GData.TasksTask.props.status¶

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

Status of the task. This is either GData.TASKS_STATUS_NEEDS_ACTION or GData.TASKS_STATUS_COMPLETED.

New in version 0.15.0.