Interface Options

interface Options {
    iframeParent: HTMLElement;
    languageCode: string;
    onConnectionStateChange: ((event) => void);
    onIframeCreate: ((iframe) => void);
    socketEndpoint: string;
    transport: "websocket" | "longpoll";
}

Properties

iframeParent languageCode onConnectionStateChange onIframeCreate socketEndpoint transport

Properties

iframeParent

iframeParent: HTMLElement

The element to render the chat iframe in.

languageCode

languageCode: string

The language to render the iframe in.

Can be changed later using the updateLanguageCode function.

Example: 'en', 'es', 'de', 'nl'

onConnectionStateChange

onConnectionStateChange: ((event) => void)

A callback that is triggered whenever the connection state of either socket changes.

Type declaration

onIframeCreate

onIframeCreate: ((iframe) => void)

Callback when the iframe is first created to allow things like class to be set.

Type declaration

    • (iframe): void

    • Parameters

      • iframe: HTMLIFrameElement

      Returns void

socketEndpoint

socketEndpoint: string

The WebSocket URL to the socket.

Example: 'wss://inbox.dialox.ai/socket'

transport

transport: "websocket" | "longpoll"

The socket transport to use.

Websocket (default) might still fall back to LongPoll automatically.

Settings

Member Visibility

Theme

On This Page

iframeParentlanguageCodeonConnectionStateChangeonIframeCreatesocketEndpointtransport

Generated using TypeDoc