Returns a boolean indicating whether the instance of AvayaInfinityOmniSdkMessagingUi has been initialized.
A boolean indicating whether the instance has been initialized.
StaticcurrentReturns the name of the currently active theme
The current theme name.
StaticloadedReturns a boolean indicating whether the AvayaInfinityOmniSdkMessagingUi has been loaded.
A boolean indicating whether the Messaging UI has been loaded.
Initializes the AvayaInfinityOmniSdkMessagingUi with the provided parameters. Before any other operation can be performed with the Messaging UI, it must be initialized. The only exception to this is the AvayaInfinityOmniSdkMessagingUi.load which must be performed before initializing the Messaging UI. The initialization process creates a new session for the current user (identified by the JWT).
The initialization parameters required to initialize the Messaging UI.
A promise that resolves when the Messaging UI is initialized.
Shutdown the Messaging UI and close the user's session with Avaya Infinity. To use the Messaging UI again after shutdown, re-initialize it by calling AvayaInfinityOmniSdkMessagingUi.init.
Note: The Messaging UI instance must be initialized before calling this method.
A promise that resolves when the Messaging UI is shut down.
StaticapplyStaticapplySets the theme for the AvayaInfinityOmniSdkMessagingUi. The theme should be one of the themes that were provided in the MessagingUiConfig.
Name of the theme to set.
StaticclearStaticclearStaticclearStaticgetReturns the instance of AvayaInfinityOmniSdkMessagingUi if it is present in the DOM.
The instance of AvayaInfinityOmniSdkMessagingUi if it is present in the DOM, otherwise undefined.
StaticloadThis static method should be called to load the AvayaInfinityOmniSdkMessagingUi. Once called, it will fetch the web chat configurations defined in the Avaya Infinity admin console, and render the UI on the screen. This method can only be called once, and it should be called before any other operations can be performed.
An object containing all the configurations required by the Messaging UI.
The JWT required to connext with Avaya Infinity™ platform servers.
A promise that resolves when the Messaging UI is loaded successfully.
StaticresetReset the idle timer to indicate the Messaging UI that the user session is still active. The Messaging UI will internally reset the timer when the user interacts with the Messaging Window like sending a message.
This method should be invoked by the client to indicate the user's activeness which is only visible to the client itself and cannot be detected by the Messaging UI on its own. Examples of such activities could include when the User is browsing/interacting with the website.
StaticsetSets the event handler callback that needs to be invoked when the idle timeout is reached. This method will override the event handler callback that was provided in the configuration object (of type MessagingUiConfig) passed to the AvayaInfinityOmniSdkMessagingUi.load method.
The event handler callback. The handler will be called with the instance of the AvayaInfinityOmniSdkMessagingUi on which the event occurred as an argument.
StaticsetSets the event handler callback that needs to be invoked when the Messaging UI is initialized. This method will override the event handler callback that was provided in the configuration object (of type MessagingUiConfig) passed to the AvayaInfinityOmniSdkMessagingUi.load method.
The event handler callback. The handler will be called with the instance of the AvayaInfinityOmniSdkMessagingUi on which the event occurred as an argument.
StaticsetSets the locale for the AvayaInfinityOmniSdkMessagingUi. The locale is used to determine the translations of the Messaging UI.
The locale to set. The locale should be in the ISO 639-1 format, example "en-US".
StaticsetSets the log level of Messaging UI.
The log level to set.
StaticsetSets the event handler callback that needs to be invoked when the Messaging UI is shutdown. This method will override the event handler callback that was provided in the configuration object (of type MessagingUiConfig) passed to the AvayaInfinityOmniSdkMessagingUi.load method.
The event handler callback. The handler will be called with the instance of the AvayaInfinityOmniSdkMessagingUi on which the event occurred as an argument.
Web Component that implements the Avaya Infinity Messaging UI. The Web Component is highly customizable and can be easily integrated into the Client website to enable messaging capabilities.