- Value parameters:
- cancellable
Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.
- message
Optional, more detailed associated progress message. Contains complementary information to the
title
. Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.- percentage
Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the
percentage
value in subsequent in report notifications. The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100].- title
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed. Examples: "Indexing" or "Linking dependencies".
- Companion:
- object
case class WorkDoneProgressBegin(kind: "begin", title: String, cancellable: Opt[Boolean], message: Opt[String], percentage: Opt[uinteger])
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any