@mendix/extensions-api - v0.7.0
    Preparing search index...

    Interface IRuntimeControllerApi

    API for working with runtime controller.

    interface IRuntimeControllerApi {
        _apiId: "mendix.RuntimeControllerApi";
        addEventListener<K extends "connectionChanged">(
            eventType: K,
            listener: EventHandler<RuntimeApiEventMap, K>,
        ): DisposeListener;
        executePreviewAction(
            actionName: string,
            parameters?: Record<string, string>,
        ): Promise<unknown>;
        removeEventListener<K extends "connectionChanged">(
            eventType: K,
            listener: EventHandler<RuntimeApiEventMap, K>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _apiId: "mendix.RuntimeControllerApi"

    Unique identifier for the RuntimeController API.

    Methods

    • Adds an event listener for the specified event type.

      Type Parameters

      • K extends "connectionChanged"

      Parameters

      • eventType: K

        The type of event to listen for.

      • listener: EventHandler<RuntimeApiEventMap, K>

        The event listener to add.

      Returns DisposeListener

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

    • Executes a preview action with the given parameters.

      Parameters

      • actionName: string
      • Optionalparameters: Record<string, string>

      Returns Promise<unknown>

    • Removes an event listener for the specified event type.

      Type Parameters

      • K extends "connectionChanged"

      Parameters

      • eventType: K

        The type of event to remove the listener from.

      • listener: EventHandler<RuntimeApiEventMap, K>

        The event listener to remove.

      Returns void