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

ChatInstanceProvider

class ChatInstanceProvider : 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.

dispatcher

Coroutine dispatcher used for background operations, defaults to Dispatchers.IO.

Types

AuthenticationScope

interface AuthenticationScope

Authentication scope for configuring identity and token-related settings.

object Companion

ConfigurationScope

interface ConfigurationScope : ChatInstanceProvider.AuthenticationScope

Configuration scope used to reconfigure and restart the chat session.

DeviceTokenProvider

fun interface DeviceTokenProvider

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

interface Listener

those interested in ChatInstanceProvider updates.

Properties

var authorization: Authorization?

Current authorization.

var chat: Chat?

Current chat object.

val chatState: ChatState

Current chat state.

var configuration: SocketFactoryConfiguration?

Current configuration.

var customerId: String?

Current optional customerId.

developmentMode

var developmentMode: Boolean

Current developmentMode state. If true, additional debugging is provided

deviceTokenProvider

var deviceTokenProvider: ChatInstanceProvider.DeviceTokenProvider?

Current deviceToken provider.

open override val identity: Logger

var logger: Logger

Current Logger.

open override val scope: String

tokenDelegateListener

var tokenDelegateListener: TokenDelegateListener?

Current optional token delegate listener for implicit OAuth flow.

var userName: UserName?

Current user name.

Functions

fun addListener(listener: ChatInstanceProvider.Listener)

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

fun cancel()

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

fun close()

Close any connected chat web sockets.

closeSuspending

suspend fun closeSuspending()

Coroutine-native equivalent of close -- prefer this from a coroutine context.

suspend fun configure(context: Context, actions: ChatInstanceProvider.ConfigurationScope.() -> Unit)

Update the configuration of chat.

Connect the chat web socket so chat functions are available.

open override fun log(level: Level, message: String, throwable: Throwable?)

onChatRuntimeException

open override fun onChatRuntimeException(exception: RuntimeChatException)

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.

open override fun 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.

open override fun onConnecting()

Method is invoked when the application initiates connection to chat session or if the session was lost and chat attempts automatically to reconnect. Chat should be considered temporarily unavailable until onConnected is invoked.

open override fun onReady()

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

onUnexpectedDisconnect

open override fun onUnexpectedDisconnect()

Method is invoked when chat session is unexpectedly lost during initial connection, or if the initial connection was established, but then lost and retry mechanism has been exhausted without success.

fun prepare(context: Context, newConfig: SocketFactoryConfiguration? = null)

Reestablish a chat connection if one does not currently exist.

fun removeListener(listener: ChatInstanceProvider.Listener)

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

setCustomerValues

fun setCustomerValues(values: Map<String, String>): ChatInstanceProvider

Set custom values on the current chat instance.

setTokenDelegateListener

fun setTokenDelegateListener(listener: TokenDelegateListener?)

Sets or clears the TokenDelegateListener for the implicit OAuth flow.

fun setUserName(name: UserName)

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.

suspend fun signOut(): Unit?

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