Member Junction
    Preparing search index...

    The widget's configuration, as the element's attributes and properties resolve to it.

    Members are camelCase on purpose: they mirror the element's DOM surface (api-url → apiUrl), which is what a page author writes, not MemberJunction's PascalCase class-member convention. The same goes for the event detail shapes below — they are a web-platform contract.

    interface WidgetConfig {
        agentId: string | null;
        agentName: string;
        apiUrl: string | null;
        applicationId: string | null;
        autoStart: boolean;
        channelInputs: Record<string, JSONObject>;
        channels: string[] | null;
        chrome: WidgetChrome;
        conversationId: string | null;
        cspNonce: string | null;
        frameCapture: boolean;
        inviteToken: string | null;
        launcher: IRealtimeSessionLauncher | null;
        locale: string | null;
        perception: WidgetPerception;
        preload: WidgetPreload;
        requireConsent: boolean;
        sessionUrl: string | null;
        theme: WidgetThemeMode;
        themeTokens: Record<string, string>;
        token: string | null;
        widgetKey: string | null;
    }
    Index

    Properties

    agentId: string | null

    The agent to talk to. In widget-key mode the server pins the agent and this is ignored.

    agentName: string

    The agent's display name (cosmetic).

    apiUrl: string | null

    MJAPI root. Required for every mode except host and launcher-with-a-configured-provider.

    applicationId: string | null

    The application the session runs in. In widget-key mode the server supplies it.

    autoStart: boolean

    Start as soon as the element is configured, instead of waiting for start() / the start button.

    channelInputs: Record<string, JSONObject>

    Seed inputs per channel name, applied when that channel opens.

    channels: string[] | null

    Channels the page brings to the session, by name (or ClassFactory key). null = none beyond the registry's.

    chrome: WidgetChrome
    conversationId: string | null

    A conversation to continue.

    cspNonce: string | null

    The page's CSP nonce, for the styles the widget injects.

    frameCapture: boolean

    Whether a rendered component may be captured as an image for the agent. Read by the session chunk; the default rasterizer that honours it is Phase 2's, so today this only records the page's intent.

    inviteToken: string | null

    Magic-link invite token (invite-token mode).

    launcher: IRealtimeSessionLauncher | null

    A host-supplied way to mint the session (see IRealtimeSessionLauncher).

    locale: string | null

    BCP-47 locale for the widget's own copy.

    perception: WidgetPerception

    Whether the agent may see what the person shares; see WidgetPerception.

    preload: WidgetPreload

    When to fetch the heavy call code; see WidgetPreload.

    requireConsent: boolean

    Show the consent gate before the microphone starts.

    sessionUrl: string | null

    Where the call chunk lives, when it is not next to this script (the element derives it from its own URL).

    themeTokens: Record<string, string>

    --mj-* token overrides (without the --mj- prefix, or with it).

    token: string | null

    A session JWT (token mode).

    widgetKey: string | null

    Public widget key (widget-key mode).