Class ProgressLocationService

Implements

ProgressClient

Index

Constructors

Properties

emitters lastEvents progressByLocation

Methods

addEmitter fireEvent getLocationId getOrCreateEmitters getProgress onProgress processEvent reportProgress showProgress

Constructors

constructor

new ProgressLocationService(): ProgressLocationService
Returns ProgressLocationService

Properties

`Protected` emitters

emitters: Map<string, Emitter<LocationProgress>[]> = ...

`Protected` lastEvents

lastEvents: Map<string, LocationProgress> = ...

`Protected` `Readonly` progressByLocation

progressByLocation: Map<string, Set<string>> = ...

Methods

`Protected` addEmitter

addEmitter(locationId): Emitter<LocationProgress>
Parameters
- locationId: string
Returns Emitter<LocationProgress>
- Defined in packages/core/src/browser/progress-location-service.ts:41

`Protected` fireEvent

fireEvent(locationId, show): void
Parameters
- locationId: string
- show: boolean
Returns void
- Defined in packages/core/src/browser/progress-location-service.ts:72

`Protected` getLocationId

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

`Protected` getOrCreateEmitters

getOrCreateEmitters(locationId): Emitter<LocationProgress>[]
Parameters
- locationId: string
Returns Emitter<LocationProgress>[]
- Defined in packages/core/src/browser/progress-location-service.ts:80

getProgress

getProgress(locationId): undefined | LocationProgress
Parameters
- locationId: string
Returns undefined | LocationProgress
- Defined in packages/core/src/browser/progress-location-service.ts:34

onProgress

onProgress(locationId): Event<LocationProgress>
Parameters
- locationId: string
Returns Event<LocationProgress>
- Defined in packages/core/src/browser/progress-location-service.ts:37

`Protected` processEvent

processEvent(progressId, locationId, event): void
Parameters
- progressId: string
- locationId: string
- event: "done" | "start"
Returns void
- Defined in packages/core/src/browser/progress-location-service.ts:61

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-location-service.ts:92

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-location-service.ts:51