Class MessageService

showProgress

• showProgress(message: ProgressMessage, onDidCancel?: (() => void)): Promise<Progress>

• Shows the given message as a progress.

  Parameters

  • message: ProgressMessage

    the message to show for the progress.

  • Optional onDidCancel: (() => void)

    an optional callback which will be invoked if the progress indicator was canceled.

    • • (): void

      • Returns void

  Returns Promise<Progress>

  a promise resolving to a Progress object with which the progress can be updated.

  Example usage

    @inject(MessageService)
    protected readonly messageService: MessageService;
  
    // this will show "Progress" as a cancelable message
    this.messageService.showProgress({text: 'Progress'});
  
    // this will show "Rolling back" with "Cancel" and an additional "Skip" action
    this.messageService.showProgress({
      text: `Rolling back`,
      actions: ["Skip"],
    },
    () => console.log("canceled"))
    .then((progress) => {
      // register if interested in the result (only necessary for custom actions)
      progress.result.then((result) => {
        // will be 'Cancel', 'Skip' or `undefined`
        console.log("result is", result);
      });
      progress.report({message: "Cleaning references", work: {done: 10, total: 100}});
      progress.report({message: "Restoring previous state", work: {done: 80, total: 100}});
      progress.report({message: "Complete", work: {done: 100, total: 100}});
      // we are done so we can cancel the progress message, note that this will also invoke `onDidCancel`
      progress.cancel();
    });