Class DispatchingProgressClient

Implements

ProgressClient

Index

Constructors

Properties

locationService statusBarItem

Methods

getLocationId reportProgress showProgress

Constructors

constructor

new DispatchingProgressClient(): DispatchingProgressClient
Returns DispatchingProgressClient

Properties

`Protected` locationService

locationService: ProgressLocationService

`Protected` statusBarItem

statusBarItem: ProgressStatusBarItem

Methods

`Protected` getLocationId

getLocationId(message): string
Parameters
- message: ProgressMessage
Returns string
- Defined in packages/core/src/browser/progress-client.ts:49

reportProgress

reportProgress(progressId, update, message, cancellationToken): Promise<void>
Update a previously created progress message.
Parameters
- progressId: string
- update: ProgressUpdate
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<void>
Implementation of ProgressClient.reportProgress
- Defined in packages/core/src/browser/progress-client.ts:41

showProgress

showProgress(progressId, message, cancellationToken): Promise<undefined | string>
Show a progress message with possible actions to user.
Parameters
- progressId: string
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<undefined | string>
Implementation of ProgressClient.showProgress
- Defined in packages/core/src/browser/progress-client.ts:33