Returns a boolean indicating whether the instance of AxpOmniSdkMessagingUi has been initialized.
A boolean indicating whether the instance has been initialized.
StaticcurrentReturns the current theme name
The current theme name
Initializes the AxpOmniSdkMessagingUi with the provided parameters. Before any operation can be performed with the SDK, it must be initialized. The initialization process creates a new session for the current user (identified by the JWT).
The initialization parameters required to initialize the SDK.
A promise that resolves when the SDK is initialized.
Shutdown the SDK and closes the user's session with AXP. After shutdown, if the SDK is required to be used again, re-initialize it by calling init. Before calling this method, it is mandatory for the SDK to be initialized.
StaticclearClears the event handler callback that was attached to the AXP Omni SDK Messaging UI idle timeout event.
This method will remove the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
StaticclearClears the event handler callback that was attached to the AXP Omni SDK Messaging UI initialization event.
This method will remove the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
StaticclearClears the event handler callback that was attached to the AXP Omni SDK Messaging UI shutdown event.
This method will remove the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
StaticgetReturns the instance of AxpOmniSdkMessagingUi if it is present in the DOM.
The instance of AxpOmniSdkMessagingUi if it is present in the DOM, otherwise undefined.
StaticresetReset the idle timer to indicate the SDK that the user session is still active. The SDK will internally reset the timer when the user interacts with the Messaging Window like sending a message. Invoke this method only when client want to indicate a user's activity visible only to the client.
StaticsetSets the event handler callback that needs to be invoked when the idle timeout is reached.
This method will reset the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
The event handler callback. The handler will be called with the instance of the AxpOmniSdkMessagingUi on which the event occurred as an argument.
StaticsetSets the event handler callback that needs to be invoked when the AXP Omni SDK Messaging UI is initialized.
This method will reset the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
The event handler callback. The handler will be called with the instance of the AxpOmniSdkMessagingUi on which the event occurred as an argument.
StaticsetSets the locale for the AxpOmniSdkMessagingUi. 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 SDK.
The log level to set.
StaticsetSets the event handler callback that needs to be invoked when the AXP Omni SDK Messaging UI is shutdown.
This method will reset the event handler callback that was previously configured in the
global configuration object axpOmniSdkMessagingUiConfig (of type AxpOmniSdkMessagingUiConfig).
The event handler callback. The handler will be called with the instance of the AxpOmniSdkMessagingUi on which the event occurred as an argument.
StaticsetSets the theme for the AxpOmniSdkMessagingUi. The theme should be one of the themes that were provided in the AxpOmniSdkMessagingUiConfig.
Name of the theme to set.
Web Component that implements the AXP Messaging UI. The Web Component is highly customizable and can be easily integrated into the Client website to enable messaging capabilities.