SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Class WorkbenchMessageBoxServiceAbstract

    Displays a microfrontend in a message box.

    A message box is a standardized dialog for presenting a message to the user, such as an info, warning or alert, or for prompting the user for confirmation.

    A microfrontend provided as a messagebox capability can be opened in a message box. The qualifier differentiates between different message box capabilities. Declaring an intention allows for opening public message box capabilities of other applications.

    Displayed on top of other content, a modal message box blocks interaction with other parts of the application.

    A message box can be context-modal or application-modal. Context-modal blocks a specific part of the application, as specified by the context; application-modal blocks the workbench or browser viewport, based on global workbench settings.

    A message box can be bound to a context (e.g., a part or view), defaulting to the calling context. The message box is displayed only if the context is visible and closes when the context is disposed.

    A message box is opened in the center of its context, if any, unless opened from the peripheral area.

    Message boxes are stacked per modality, with only the topmost message box in each stack being interactive.

    WorkbenchMessageBoxCapability

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Displays the specified message in a message box.

      By default, the message box is modal to the calling context. Specify a different modality in WorkbenchMessageBoxOptions.modality.

      Parameters

      • message: null | string

        Specifies the text to display, if any. Can be text or a translation key. A translation key starts with the percent symbol (%) and may include parameters in matrix notation for text interpolation.

      • Optionaloptions: WorkbenchMessageBoxOptions

        Controls the appearance and behavior of the message box.

      Returns Promise<string>

      Promise that resolves to the key of the action button that the user clicked to close the message box, or that rejects if the message box couldn't be opened, e.g., because of missing the intention.

      • Calling this method requires the intention {"type": "messagebox"}.
    • Opens the microfrontend of a messagebox capability in a workbench message box based on the given qualifier and options.

      By default, the message box is modal to the calling context. Specify a different modality in WorkbenchMessageBoxOptions.modality.

      Parameters

      • qualifier: Qualifier

        Identifies the messagebox capability that provides the microfrontend to open in a message box.

      • Optionaloptions: WorkbenchMessageBoxOptions

        Controls the appearance and behavior of the message box.

      Returns Promise<string>

      Promise that resolves to the key of the action button that the user clicked to close the message box, or that rejects if the message box couldn't be opened, e.g., because of missing the intention or because no messagebox capability matching the qualifier and visible to the application was found.

      • WorkbenchMessageBoxCapability
      • WorkbenchMessageBox