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

    Class WorkbenchNotificationServiceAbstract

    Shows a notification.

    A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered. It informs about system events, task completion or errors. The severity indicates importance or urgency.

    Notifications can be grouped. Only the most recent notification within a group is displayed.

    The built-in notification supports the display of a plain text message. Other notification capabilities can be contributed by the host app, e.g., to display structured content or to provide out-of-the-box notification templates. The use of a qualifier distinguishes different notification providers.

    WorkbenchNotificationCapability

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Displays the specified message as workbench notification.

      This method requires the intention {"type": "notification"}.

      Parameters

      • message: string

        Specifies the text to display. 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: WorkbenchNotificationOptions

        Controls the appearance and behavior of the notification.

      Returns Promise<void>

      Promise that resolves when the notification is displayed, or that rejects otherwise, e.g., because of missing the intention.

    • Displays the microfrontend of a notification capability as workbench notification based on the given qualifier and options.

      Parameters

      • qualifier: Qualifier

        Identifies the notification capability that provides the microfrontend to show as workbench notification.

      • Optionaloptions: WorkbenchNotificationOptions

        Controls the appearance and behavior of the notification.

      Returns Promise<void>

      Promise that resolves when the notification is displayed, or that rejects otherwise, e.g., because of missing the intention or because no notification capability was found matching the qualifier and is visible to the application.

      • WorkbenchMessageBoxCapability
      • WorkbenchMessageBox
    • Displays the specified message as workbench notification.

      Parameters

      • notification: WorkbenchNotificationConfig

        Configures content and appearance of the notification.

      • Optionalqualifier: Qualifier

        Identifies the notification capability that provides the microfrontend to show as workbench notification.

      Returns Promise<void>

      Promise that resolves when the notification is displayed or that rejects if the intention is missing or no matching notification capability is found.

      since version 1.0.0-beta.36. Pass text or qualifier as first argument. Marked for removal.