Snapd.Task¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_id` ()
	`get_kind` ()
	`get_progress_done` ()
	`get_progress_label` ()
	`get_progress_total` ()
	`get_ready` ()
	`get_ready_time` ()
	`get_spawn_time` ()
	`get_status` ()
	`get_summary` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`id`	`str`	r/w/co	ID of task
`kind`	`str`	r/w/co	Kind of task
`progress-done`	`int`	r/w/co	Number of items done in this task
`progress-label`	`str`	r/w/co	Label for progress
`progress-total`	`int`	r/w/co	Total number of items to be done in this task
`ready`	`bool`	d/r/w/co	`True` when task complete `deprecated`
`ready-time`	`GLib.DateTime`	r/w/co	Time this task completed
`spawn-time`	`GLib.DateTime`	r/w/co	Time this task started
`status`	`str`	r/w/co	Status of task
`summary`	`str`	r/w/co	Summary of task

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Snapd.Task(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Snapd.TaskClass

Snapd.Task contains progress information for a task in a Snap transaction.

New in version 1.0.

get_id()¶

Returns:: an ID.
Return type:: str

Get the unique ID for this task.

New in version 1.0.

get_kind()¶

Returns:: the kind of task.
Return type:: str

Gets the kind of task this is.

New in version 1.0.

get_progress_done()¶

Returns:: a count.
Return type:: int

Get the the number of items completed in this task.

New in version 1.0.

get_progress_label()¶

Returns:: a label string.
Return type:: str

Get the the label associated with the progress.

New in version 1.5.

get_progress_total()¶

Returns:: a count.
Return type:: int

Get the the total number of items to be completed in this task.

New in version 1.0.

get_ready()¶

Returns:: True if this task is complete.
Return type:: bool

Get if this task is completed.

New in version 1.0.

Deprecated since version 1.5: Use Snapd.Change.get_ready() instead.

get_ready_time()¶

Returns:: a GLib.DateTime or None.
Return type:: GLib.DateTime or None

Get the time this task completed or None if not yet completed.

New in version 1.0.

get_spawn_time()¶

Returns:: a GLib.DateTime.
Return type:: GLib.DateTime

Get the time this task started.

New in version 1.0.

get_status()¶

Returns:: a status string.
Return type:: str

Get the status of the task.

New in version 1.0.

get_summary()¶

Returns:: a string describing the task.
Return type:: str

Get a human readable description of the task.

New in version 1.0.

Property Details¶

Snapd.Task.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

ID of task

Snapd.Task.props.kind¶

Name:: kind
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Kind of task

Snapd.Task.props.progress_done¶

Name:: progress-done
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Number of items done in this task

Snapd.Task.props.progress_label¶

Name:: progress-label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Label for progress

Snapd.Task.props.progress_total¶

Name:: progress-total
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Total number of items to be done in this task

Snapd.Task.props.ready¶

Name:: ready
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE, CONSTRUCT_ONLY

True when task complete

Deprecated since version ???.

Snapd.Task.props.ready_time¶

Name:: ready-time
Type:: GLib.DateTime
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Time this task completed

Snapd.Task.props.spawn_time¶

Name:: spawn-time
Type:: GLib.DateTime
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Time this task started

Snapd.Task.props.status¶

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

Status of task

Snapd.Task.props.summary¶

Name:: summary
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Summary of task