language-servers/language-server-protocol
1
0
Fork 0
mirror of https://github.com/microsoft/language-server-protocol.git synced 2025-12-23 08:48:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixes #903: Is cancelling a server initiated progress report described in the lsp?

Browse source
This commit is contained in:
Dirk Baeumer 2020-01-28 16:14:34 +01:00
parent 1b9ad7d51f
commit a8f763b45c
2 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
_data/specification-3-15-toc.yml
View file

@ -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:

18
_specifications/specification-3-15.md
View file

@ -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`.
#### <a href="#window_workDoneProgress_cancel" name="window_workDoneProgress_cancel" class="anchor"> Canceling a Work Done Progress (:arrow_right:)</a>
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;
}
```
#### <a href="#telemetry_event" name="telemetry_event" class="anchor">Telemetry Notification (:arrow_left:)</a>
The telemetry notification is sent from the server to the client to ask the client to log a telemetry event.