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

    Class WorkbenchMessageBoxAbstract

    Handle to interact with a message box opened via WorkbenchMessageBoxService.

    The message box microfrontend can inject this handle to interact with the message box, such as reading parameters or signaling readiness.

    • WorkbenchMessageBoxCapability
    • WorkbenchMessageBoxService
    Index

    Constructors

    constructor

    Properties

    capability focused$ id params referrer

    Methods

    signalReady

    Constructors

    Properties

    capability: WorkbenchMessageBoxCapability

    Capability of the microfrontend loaded into this message box.

    focused$: Observable<boolean>

    Indicates whether this message box has the focus.

    id: `dialog.${string}`

    Represents the identity of this message box.

    params: Map<string, unknown>

    Parameters as passed by the message box opener.

    referrer: { appSymbolicName: string }

    Provides information about where the message box was opened.

    Type Declaration

    • ReadonlyappSymbolicName: string

      Symbolic name of the application that opened the messagebox.

    Methods

    • Signals readiness, notifying the workbench that this message box has completed initialization.

      If showSplash is set to true on the messagebox capability, the workbench displays a splash until the message box microfrontend signals readiness.

      Returns void

      WorkbenchMessageBoxCapability.properties.showSplash

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods