ProgressTask

Properties

abstract val completed: Long

The number of units of work that have been completed

abstract val context: T

The context is used to pass custom information to the task

true if this task's completed count is equal to its total

abstract val id: TaskId

The unique id of this task

abstract val paused: Boolean

Whether the task is currently paused

abstract val started: Boolean

Whether the task has been started

abstract val total: Long?

The total number of units of work, or null if the total is unknown

abstract val visible: Boolean

Whether the task should be visible in the progress bar

Advance the completed progress of this task by amount.

Create a ProgressState for this task's current state

abstract fun reset(start: Boolean = true, block: ProgressTaskUpdateScope<T>.() -> Unit = {})

Reset the task so its completed count is 0 and its clock is reset.

Update the task's state.

Set the completed progress of this task to completed.