FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
vscode-java-debug/src/progressAPI.ts at main · microsoft/vscode-java-debug · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
microsoft
/
vscode-java-debug
Public
Notifications
You must be signed in to change notification settings
Fork
428
Star
588
Code
Issues
201
Pull requests
12
Discussions
Actions
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
vscode-java-debug
/
src
/
progressAPI.ts
Copy path
More file actions
More file actions
Latest commit
History
History
History
82 lines (69 loc) · 2.71 KB
Breadcrumbs
vscode-java-debug
/
src
/
progressAPI.ts
Copy path
File metadata and controls
82 lines (69 loc) · 2.71 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
import
{
CancellationToken
,
ProgressLocation
}
from
"vscode"
;
export
interface
IProgressReporter
{
/**
* Set the job name.
*
@param
jobName the job name
*/
setJobName
(
jobName
:
string
)
:
void
;
/**
* Returns the id of the progress reporter.
*/
getId
(
)
:
string
;
/**
* Returns the progress location.
*/
getProgressLocation
(
)
:
ProgressLocation
|
{
viewId
:
string
}
;
/**
* Reports a progress message update.
*
@param
message the message to update
*
@param
increment use `increment` to report discrete progress. Each call with a `increment`
* value will be summed up and reflected as overall progress until 100% is reached.
* Note that currently only `ProgressLocation.Notification` is capable of showing
* discrete progress.
*/
report
(
message
:
string
,
increment
?:
number
)
:
void
;
/**
* Shows the progress reporter.
*/
show
(
)
:
void
;
/**
* Hides the progress reporter.
*
@param
onlyNotifications only hide the progress reporter when it's shown as notification.
*/
hide
(
onlyNotifications
?:
boolean
)
:
void
;
/**
* Returns whether the progress reporter has been cancelled or completed.
*/
isCancelled
(
)
:
boolean
;
/**
* Notifies the work is done that is either the task is completed or the user has cancelled it.
*/
done
(
)
:
void
;
/**
* The CancellationToken to monitor if the progress reporter has been cancelled by the user.
*/
getCancellationToken
(
)
:
CancellationToken
;
/**
* Disposes the progress reporter if the observed token has been cancelled.
*
@param
token the cancellation token to observe
*/
observe
(
token
?:
CancellationToken
)
:
void
;
}
export
interface
IProgressProvider
{
/**
* Creates a progress reporter.
*
@param
jobName the job name
*
@param
progressLocation The location at which progress should show, defaults to `ProgressLocation.Notification`.
*
@param
cancellable Controls if a cancel button should show to allow the user to cancel the progress reporter,
* defaults to true. Note that currently only `ProgressLocation.Notification` is supporting
* to show a cancel button.
*/
createProgressReporter
(
jobName
:
string
,
progressLocation
?:
ProgressLocation
|
{
viewId
:
string
}
,
cancellable
?:
boolean
)
:
IProgressReporter
;
/**
* Returns the progress reporter with the progress id.
*
@param
progressId the progress id
*/
getProgressReporter
(
progressId
:
string
)
:
IProgressReporter
|
undefined
;
}
Back
|
FazBrowse Home
|
New Git URL