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

ChatThreadHandler

Instance of a thread handler. This instance will contain the most up-to-date thread, even newer than the thread it was created from.

This object will not transfer any changes to the parent object and all updates are contained within this class. It's up to the client to keep the instance alive as long as they need it.

It has no side effects attached to it.

Types

OnThreadUpdatedListener

fun interface OnThreadUpdatedListener

Listener allowing to receive changes to a chat thread.

Functions

customFields

abstract fun customFields(): ChatFieldHandler

Returns new instance of field handler for this ChatThread.

events

abstract fun events(): ChatThreadEventHandler

Returns new instance of thread event handler for this ChatThread.

get

abstract fun get(): ChatThread

Returns the most up-to-date thread with updated properties. This value is internally stored and is safe to call in main-thread context.

@CheckResult

abstract fun get(listener: ChatThreadHandler.OnThreadUpdatedListener): Cancellable

Registers a listener which can be cancelled any time. The thread registers for listeners to thread recovered events (triggered by refresh), message events (triggered by messages and its methods) and metadata events.

messages

abstract fun messages(): ChatThreadMessageHandler

Returns new instance of message handler for this ChatThread.

refresh

abstract fun refresh()

Notifies the server asynchronously that client wants the thread to be refreshed. The request can be performed even if the client doesn't expect new data. In which case the get returns updated value anyway.

setName

abstract fun setName(name: String)

Notifies the server asynchronously that client wants to change the thread name to the supplied name. The change can fail, though if it doesn't get methods will return updated thread.