onAiAssistantEventReceive

Home > @gooddata/sdk-pluggable-application-model > IPluggableApplicationMountHandle > onAiAssistantEventReceive

IPluggableApplicationMountHandle.onAiAssistantEventReceive property

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Ref the renderer populates with a handler that delegates a host-chat event to the active app's mount handle (onAiAssistantEventReceive), so an embedded app can handle it in-app.

Signature:

onAiAssistantEventReceive?: (event: {
        name: string;
        payload: Record<string, unknown>;
    }) => void;

Remarks

On hosted routes the host owns the single chat instance; an application that exposes its own assistant controls (e.g. an embedded AI button, or the toggleAIAssistant postMessage command whose result is echoed to an embedding client) needs to know the real open-state to keep those controls and their reported results aligned with what the user sees. The host calls this when event is received.