Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Window

A window in the client application that is running the extension.

Hierarchy

  • Window

Index

Properties

activeViewComponent

activeViewComponent: ViewComponent | undefined

The currently active view component in the window.

activeViewComponentChanges

activeViewComponentChanges: Subscribable<ViewComponent | undefined>

An event that is fired when the active view component changes.

visibleViewComponents

visibleViewComponents: ViewComponent[]

The user interface view components that are visible in the window.

Methods

showInputBox

  • Displays an input box to ask the user for input.

    The returned value will be undefined if the input box was canceled (e.g., because the user pressed the ESC key). Otherwise the returned value will be the string provided by the user.

    Parameters

    • Optional options: InputBoxOptions

      Configures the behavior of the input box.

    Returns Promise<string | undefined>

    The string provided by the user, or undefined if the input box was canceled.

showMessage

  • showMessage(message: string): Promise<void>
  • Show a modal message to the user that the user must dismiss before continuing.

    Parameters

    • message: string

      The message to show.

    Returns Promise<void>

    A promise that resolves when the user dismisses the message.

showNotification

  • showNotification(message: string): void
  • Show a notification message to the user that does not require interaction or steal focus.

    deprecated

    This API will change.

    Parameters

    • message: string

      The message to show. Markdown is supported.

    Returns void

    A promise that resolves when the user dismisses the message.

showProgress

  • Show progress in the window. The returned ProgressReporter can be used to update the progress bar, complete it or turn the notification into an error notification in case the operation failed.

    Parameters

    Returns Promise<ProgressReporter>

    A ProgressReporter that allows updating the progress display.

withProgress

  • Show progress in the window. Progress is shown while running the given callback and while the promise it returned isn't resolved nor rejected.

    Type parameters

    • R

    Parameters

    Returns Promise<R>

    The Promise the task-callback returned.

Generated using TypeDoc