Class MessageClient

Hierarchy

MessageClient

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageClient(): MessageClient

Returns MessageClient

Methods

reportProgress

reportProgress(progressId: string, update: ProgressUpdate, message: ProgressMessage, cancellationToken: CancellationToken): Promise<void>

- Defined in packages/core/src/common/message-service-protocol.ts:145
Update a previously created progress message.

To be implemented by an extension, e.g. by the messages extension.

Parameters
- progressId: string
- update: ProgressUpdate
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<void>

showMessage

showMessage(message: Message): Promise<undefined | string>

- Defined in packages/core/src/common/message-service-protocol.ts:125
Show a message of the given type and possible actions to the user. Resolve to a chosen action. Never reject.

To be implemented by an extension, e.g. by the messages extension.

Parameters
- message: Message
Returns Promise<undefined | string>

showProgress

showProgress(progressId: string, message: ProgressMessage, cancellationToken: CancellationToken): Promise<undefined | string>

- Defined in packages/core/src/common/message-service-protocol.ts:135
Show a progress message with possible actions to user.

To be implemented by an extension, e.g. by the messages extension.

Parameters
- progressId: string
- message: ProgressMessage
- cancellationToken: CancellationToken
Returns Promise<undefined | string>