Interface IMessageBoxApi

API for showing message boxes

interface IMessageBoxApi {
    _apiId: "mendix.MessageBoxApi";
    addEventListener<K>(eventType: K, listener: EventHandler<{}, K>): DisposeListener;
    removeEventListener<K>(eventType: K, listener: EventHandler<{}, K>): void;
    show(type: "info" | "warning" | "error", message: string, details?: string): Promise<void>;
}

Hierarchy (view full)

Properties

_apiId

Methods

addEventListener removeEventListener show

Properties

_apiId

_apiId

Unique identifier that can be used to register or retrieve a specific API.

Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

Methods

addEventListener

  • addEventListener<K>(eventType, listener): 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.

removeEventListener

  • removeEventListener<K>(eventType, listener): 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, message, details?): 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.

Settings

On This Page

Properties
Methods