Params

data class Params(val progress: Double, val progressToken: ProgressToken, val total: Double? = null, val message: String? = null, val _meta: JsonObject = EmptyJsonObject) : NotificationParams, ProgressBase(source)

Constructors

Link copied to clipboard
constructor(progress: Double, progressToken: ProgressToken, total: Double? = null, message: String? = null, _meta: JsonObject = EmptyJsonObject)

Properties

Link copied to clipboard
open override val _meta: JsonObject

The protocol reserves this result property to allow clients and servers to attach additional metadata to their responses.

Link copied to clipboard
open override val message: String? = null

An optional message describing the current progress.

Link copied to clipboard
open override val progress: Double

The progress thus far. This should increase every time progress is made, even if the total is unknown.

Link copied to clipboard

The progress token, which was given in the initial request, used to associate this notification with the request that is proceeding.

Link copied to clipboard
open override val total: Double? = null

Total number of items to process (or total progress required), if known.