Interface IMessageBoxApi

_apiId

addEventListener

• addEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<{}, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

ask

• ask(options: askOptions): Promise<boolean>

  Asks the user a question with the given options.

  Parameters

  • options: askOptions

    The options for the question.

  Returns Promise<boolean>

  A promise that resolves to true if the user clicked Yes or OK, false otherwise.

removeEventListener

• removeEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<{}, K>

    The event listener to remove.

  Returns void

show

• show(
      type: "info" | "warning" | "error",
      message: string,
      details?: string,
  ): Promise<void>

  Shows a message box with the given type, message and optional details.

  Parameters

  • type: "info" | "warning" | "error"

    The type of message box. One of "info", "warning" or "error".
  • message: string

    The message to show in the message box.
  • Optionaldetails: string

    The optional details to show in the message box.

  Returns Promise<void>

  A promise that resolves when the message box is closed.
• show(options: showOptions): Promise<void>

  Shows a message box with the given options.

  Parameters

  • options: showOptions

    The options for the message box.

  Returns Promise<void>

  A promise that resolves when the message box is closed.