diff --git a/_data/specification-3-15-toc.yml b/_data/specification-3-15-toc.yml index f8e1ae0..2e1917b 100644 --- a/_data/specification-3-15-toc.yml +++ b/_data/specification-3-15-toc.yml @@ -93,6 +93,8 @@ anchor: window_logMessage - title: progress/create anchor: window_workDoneProgress_create + - title: progress/cancel + anchor: window_workDoneProgress_cancel - title: Telemetry anchor: telemetry children: diff --git a/_specifications/specification-3-15.md b/_specifications/specification-3-15.md index 78ac9f3..753c1bb 100644 --- a/_specifications/specification-3-15.md +++ b/_specifications/specification-3-15.md @@ -1967,6 +1967,24 @@ _Response_: * result: void * error: code and message set in case an exception happens during the 'window/workDoneProgress/create' request. In case an error occurs a server must not send any progress notification using the token provided in the `WorkDoneProgressCreateParams`. +#### Canceling a Work Done Progress (:arrow_right:) + +The `window/workDoneProgress/cancel` notification is sent from the client to the server to cancel a progress initiated on the server side using the `window/workDoneProgress/create`. + +_Notification_: + +* method: 'window/workDoneProgress/cancel' +* params: `WorkDoneProgressCancelParams` defined as follows: + +```ts +export interface WorkDoneProgressCancelParams { + /** + * The token to be used to report progress. + */ + token: ProgressToken; +} +``` + #### Telemetry Notification (:arrow_left:) The telemetry notification is sent from the server to the client to ask the client to log a telemetry event.