Avaya Infinity Omni SDK
    Preparing search index...

    Type Alias MessagingUiConfig

    The configuration for the Messaging UI.

    type MessagingUiConfig = {
        beforeMessageRender?: (message: Message) => Message;
        beforeMessageSend?: (message: Message) => Message | Promise<Message>;
        displayStrings?: DisplayStrings;
        emojiMartTranslations?: Partial<Record<Locale, EmojiMartTranslation>>;
        host: string;
        idleShutdownGraceTimeoutDuration?: number;
        idleTimeoutDuration?: number;
        initialTheme?: string;
        integrationId: string;
        locale?: Locale;
        logLevel?: LogLevel;
        onIdleTimeOut?: (instance: AvayaInfinityOmniSdkMessagingUi) => void;
        onInit?: (instance: AvayaInfinityOmniSdkMessagingUi) => void;
        onMessageBubbleClicked?: (
            instance: AvayaInfinityOmniSdkMessagingUi,
        ) => void | Promise<void>;
        onProactiveChatError?: (error: ProactiveChatError) => void;
        onShutdown?: (instance: AvayaInfinityOmniSdkMessagingUi) => void;
        proactiveChatConfigs?: ReadonlyArray<ProactiveChatConfig>;
        themeCustomizations?: Record<string, MessagingUiTheme>;
    }
    Index

    Properties

    beforeMessageRender? beforeMessageSend? displayStrings? emojiMartTranslations? host idleShutdownGraceTimeoutDuration? idleTimeoutDuration? initialTheme? integrationId locale? logLevel? onIdleTimeOut? onInit? onMessageBubbleClicked? onProactiveChatError? onShutdown? proactiveChatConfigs? themeCustomizations?

    Properties

    beforeMessageRender?: (message: Message) => Message

    The handler function that will be called before the message is rendered.

    Type Declaration

    beforeMessageSend?: (message: Message) => Message | Promise<Message>

    The handler function that will be called before the message is sent.

    Type Declaration

    displayStrings?: DisplayStrings

    The display strings for the Messaging UI. This configuration is used to customize the various display strings used in the Messaging UI and their translations.

    emojiMartTranslations?: Partial<Record<Locale, EmojiMartTranslation>>

    The map of Locale and the translation for the EmojiMart component used in the Messaging UI.

    host: string

    Hostname of the Avaya Infinity API endpoint to connect to.

    idleShutdownGraceTimeoutDuration?: number

    The maximum time (in milliseconds) a User can remain inactive after the idle timeout before which the Messaging UI automatically shuts down.

    idleTimeoutDuration?: number

    The maximum time (in milliseconds) a user can be inactive before the grace timer starts.

    initialTheme?: string

    The name the theme that should be used after the Messaging UI loads. If not provided, the Messaging UI will load with the default theme. This name must be one of the themes provided in MessagingUiConfig.themeCustomizations

    integrationId: string

    The unique web chat integration id configured in Avaya Infinity admin console.

    locale?: Locale

    The locale for the Messaging UI. The locale is used to determine the translations of the Messaging UI. The locale should be in the ISO 639-1 format, example "en-US".

    logLevel?: LogLevel

    The log level of the Messaging UI.

    onIdleTimeOut?: (instance: AvayaInfinityOmniSdkMessagingUi) => void

    The handler function that will be called when the user has remained inactive for idleTimeoutDuration.

    Type Declaration

    onInit?: (instance: AvayaInfinityOmniSdkMessagingUi) => void

    The handler function that will be called when the Messaging UI instance is initialized.

    Type Declaration

    onMessageBubbleClicked?: (
        instance: AvayaInfinityOmniSdkMessagingUi,
    ) => void | Promise<void>

    The handler function that will be called when the message bubble is clicked.

    Type Declaration

    onProactiveChatError?: (error: ProactiveChatError) => void

    The handler function that will be called when the SDK fails to fetch the proactive-chat configuration in a non-recoverable way (network error, server 5xx, JWT failure). A graceful 404 fallback to the legacy /themes endpoint is NOT routed through this callback — it is the expected state during phased rollout.

    Type Declaration

    onShutdown?: (instance: AvayaInfinityOmniSdkMessagingUi) => void

    The handler function that will be called when the Messaging UI instance is shut down.

    Type Declaration

    proactiveChatConfigs?: ReadonlyArray<ProactiveChatConfig>

    Client-side override for the Proactive-Chat (auto popup / bubble teaser) configuration. When provided, this overrides any per-URL config rows received from the server. Set to an empty array to disable proactive-chat entirely for this client deployment.

    This list carries only the two proactive-chat configs: autoPopup (flat row) and bubbleTeaser.

    ProactiveChatConfig

    themeCustomizations?: Record<string, MessagingUiTheme>

    A theme is a collection of all the configuration values that are utilized to achieve a certain look and feel for the Messaging UI. The Messaging UI supports multiple themes and allows switching between them.

    The map of theme names and their respective theme configuration objects.

    Settings

    On This Page

    Properties