WorkDoneProgress
Create Work Done Progress 请求
window/workDoneProgress/create 请求从服务器发送到客户端,要求客户端创建工作完成进度。
客户端能力(Client capability):
- 属性路径:
window.workDoneProgress
- 属性类型:
boolean
请求(Request):
- method: "window/workDoneProgress/create"
- params:
WorkDoneProgressCreateParams
, 定义如下:
export interface WorkDoneProgressCreateParams {
/**
* The token to be used to report progress.
*/
token: ProgressToken;
}
响应(Response):
- result: void
- error:
code
和message
,以防在请求期间发生异常。如果发生错误,服务器不得使用WorkDoneProgressCreateParams
中提供的token
发送任何进度通知。
Cancel a Work Done Progress 通知
window/workDoneProgress/cancel
通知从客户端发送到服务器,以取消使用 window/workDoneProgress/create
在服务器端启动的进度。无需将进度标记为 cancellable
即可取消,客户端可以出于多种原因取消进度:如果出现错误、重新加载工作区等。
通知(Notification):
- method: "window/workDoneProgress/cancel"
- params:
WorkDoneProgressCancelParams
, 定义如下:
export interface WorkDoneProgressCancelParams {
/**
* The token to be used to report progress.
*/
token: ProgressToken;
}