ChatInstanceProvider

Configuration scope used to reconfigure and restart the chat session.

Defines provider of device token for push notifications, typically this will be Firebase.messaging.token.

those interested in ChatInstanceProvider updates.

Current authorization.

Current chat object.

Current chat state.

Current configuration.

Current developmentMode state. If true, additional debugging is provided

Current deviceToken provider.

Current Logger.

Current user name.

Add a listener to receive notifications of chat and state changes.

Cancel any pending prepare or connect action and return the state to an appropriate starting point.

Close any connected chat web sockets.

Update the configuration of chat.

Connect the chat web socket so chat functions are available.

Method is invoked when Chat instance encounters possible exception in a background process. Application should handle these exceptions according to the description of each RuntimeChatException. Some of these exceptions can indicate issues during transfer of messages while others may indicate that further interactions with Chat will be ignored.

Method is invoked when chat instance is connected and ready to send/receive messages, events or actions. This happens once initial connection is established or after Chat.reconnect is called.

Method is invoked when chat instance has finished performing background tasks after connection was established.

Method is invoked when chat session is unexpectedly lost. Chat instance should be considered unusable, until reconnect is performed. If this method is invoked while the Chat.reconnect is being performed, then application should consider the reconnection attempt as failed. It is recommended that only a limited number of reconnection attempts are performed. If the problems persist despite the fact that the device has internet connectivity, then please collect logs (assuming the development mode is enabled) and contact your CXone representative with request for support. Integration should also check for possibly lost incoming messages & thread changes once reconnection is done.

Reestablish a chat connection if one does not currently exist.

Reconnect a broken connection.

Remove a listener no longer concerned with chat and state changes.

Set custom values on the current chat instance.

Sets UserName which will be used during creation of Chat instance and will apply it to current instance of Chat, if it exists. The username will be applied only if the chat channel configuration allows it.

Sign out/terminate the chat connection and clear any saved credentials.