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

ChatThreadsHandler

Instance that allows modification, manipulation and observing of threads.

Some methods of this class depend on configuration sent from the server. If the configuration changes remotely, you need to call ChatBuilder.build again and use the newly created instance. The saved configuration will never change at run-time.

There are no effects attached to initialization of this class.

Types

OnThreadsUpdatedListener

fun interface OnThreadsUpdatedListener

Listener which allows the user to subscribe to thread list changes.

Properties

preChatSurvey

abstract val preChatSurvey: PreChatSurvey?

A pre-chat form which should be answered by the user before create is called. Answers have to be supplied as custom fields in the create call.

Functions

create

open fun create(): ChatThreadHandler

Creates a new thread -if permitted by the configuration- and returns a handler for it. threads should return this new instance even if it's not created on the server yet.

open fun create(customFields: Map<String, String>): ChatThreadHandler

open fun create(preChatSurveyResponse: Sequence<PreChatSurveyResponse<out FieldDefinition, out Any>>): ChatThreadHandler

abstract fun create(customFields: Map<String, String>, preChatSurveyResponse: Sequence<PreChatSurveyResponse<out FieldDefinition, out Any>>): ChatThreadHandler

Creates a new thread -if permitted by configuration- and returns a handler for it. threads should return this new instance even if it's not created on the server yet.

refresh

abstract fun refresh()

Sends a request to refresh the thread-list.

thread

abstract fun thread(thread: ChatThread): ChatThreadHandler

Creates a new thread handler with given thread. thread is used as a template and this particular instance will not be updated in response to changes in the handler.

threads

@CheckResult

abstract fun threads(listener: ChatThreadsHandler.OnThreadsUpdatedListener): Cancellable

Registers a listeners on this instance that returns new value every time client calls refresh or server imperatively forces a refresh remotely.