Interface ProgressClient

interface ProgressClient {
    reportProgress(
        progressId: string,
        update: ProgressUpdate,
        message: ProgressMessage,
        cancellationToken: CancellationToken,
    ): Promise<void>;
    showProgress(
        progressId: string,
        message: ProgressMessage,
        cancellationToken: CancellationToken,
    ): Promise<undefined | string>;
}

Implemented by

Index

Methods

reportProgress showProgress

Methods

reportProgress

reportProgress(
    progressId: string,
    update: ProgressUpdate,
    message: ProgressMessage,
    cancellationToken: CancellationToken,
): Promise<void>
Update a previously created progress message.
Parameters
- progressId: string
- update: ProgressUpdate
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<void>
- Defined in packages/core/src/common/progress-service-protocol.ts:34

showProgress

showProgress(
    progressId: string,
    message: ProgressMessage,
    cancellationToken: CancellationToken,
): Promise<undefined | string>
Show a progress message with possible actions to user.
Parameters
- progressId: string
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<undefined | string>
- Defined in packages/core/src/common/progress-service-protocol.ts:29

Interface ProgressClient

Implemented by

Index

Methods

Methods

reportProgress

Parameters

Returns Promise<void>

showProgress

Parameters

Returns Promise<undefined | string>

Settings

On This Page