CXone Mobile SDK

2.3.0-SNAPSHOT

chat-sdk-core/com.nice.cxonechat/ChatInstanceProvider

ChatInstanceProvider

public final class ChatInstanceProvider implements ChatStateListener, LoggerScope

ChatRepository owns and maintains the chat object and its state.

Parameters

configuration

Initial Sdk Configuration to use.

authorization

Initial authorization to use.

userName

Initial user name to use.

developmentMode

True if in development mode to get extra logging.

deviceTokenProvider

Provider of device tokens for push messages, default implementation will disable push notifications.

logger

The Logger used by the SDK, default is no-op implementation.

customerId

Optional customerId of the user.

chatBuilderProvider

INTERNAL USAGE ONLY Provides ChatBuilder. For internal testing usage only.

Types

public class Companion

ConfigurationScope

public interface ConfigurationScope

Configuration scope used to reconfigure and restart the chat session.

DeviceTokenProvider

public interface DeviceTokenProvider

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

public interface Listener

those interested in ChatInstanceProvider updates.

Properties

private final Authorization authorization

Current authorization.

private final Chat chat

Current chat object.

private final ChatState chatState

Current chat state.

public final static ChatInstanceProvider.Companion Companion

private final SocketFactoryConfiguration configuration

Current configuration.

private final String customerId

Current optional customerId.

developmentMode

private final Boolean developmentMode

Current developmentMode state. If true, additional debugging is provided

deviceTokenProvider

private final ChatInstanceProvider.DeviceTokenProvider deviceTokenProvider

Current deviceToken provider.

private final Logger identity

private final Logger logger

Current Logger.

private final String scope

private final UserName userName

Current user name.

Functions

public final Unit addListener(ChatInstanceProvider.Listener listener)

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

public final Unit cancel()

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

public final Unit close()

Close any connected chat web sockets.

public final Unit configure(Context context, Function1<ChatInstanceProvider.ConfigurationScope, Unit> actions)

Update the configuration of chat.

public final Unit connect()

Connect the chat web socket so chat functions are available.

getAuthorization

public final Authorization getAuthorization()

Current authorization.

public final Chat getChat()

Current chat object.

public final ChatState getChatState()

getConfiguration

public final SocketFactoryConfiguration getConfiguration()

Current configuration.

public final String getCustomerId()

Current optional customerId.

getDevelopmentMode

public final Boolean getDevelopmentMode()

Current developmentMode state. If true, additional debugging is provided

getDeviceTokenProvider

public final ChatInstanceProvider.DeviceTokenProvider getDeviceTokenProvider()

Current deviceToken provider.

public Logger getIdentity()

public final Logger getLogger()

Current Logger.

public String getScope()

public final UserName getUserName()

Current user name.

public Unit log(Level level, String message, Throwable throwable)

onChatRuntimeException

public Unit onChatRuntimeException(RuntimeChatException exception)

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.

public Unit onConnected()

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.

public Unit onReady()

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

onUnexpectedDisconnect

public Unit onUnexpectedDisconnect()

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.

@JvmOverloads()

public final Unit prepare(Context context, SocketFactoryConfiguration newConfig)

@JvmOverloads()

public final Unit prepare(Context context)

Reestablish a chat connection if one does not currently exist.

@Deprecated(message = "ChatInstanceProvider.reconnect() has been deprecated. Replace with ChatInstanceProvider.connect()", replaceWith = @ReplaceWith(imports = {}, expression = "connect()"))

public final Unit ~~reconnect~~()

Reconnect a broken connection.

public final Unit removeListener(ChatInstanceProvider.Listener listener)

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

setCustomerValues

public final ChatInstanceProvider setCustomerValues(Map<String, String> values)

Set custom values on the current chat instance.

public final Unit setUserName(UserName name)

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.

public final Unit signOut()

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