ProgressNotification

@Serializable
data class ProgressNotification(val progress: Int, val progressToken: ProgressToken, val _meta: JsonObject = EmptyJsonObject, val total: Double?) : ClientNotification, ServerNotification, ProgressBase(source)

An out-of-band notification used to inform the receiver of a progress update for a long-running request.

Constructors

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

Properties

Link copied to clipboard
val _meta: JsonObject
Link copied to clipboard
open override val method: Method
Link copied to clipboard
open override val progress: Int

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?

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

Functions

Link copied to clipboard

Converts the notification to a JSON-RPC notification.