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

public interface OnThreadUpdatedListener

Listener allowing to receive changes to a chat thread.

Functions

actions

public abstract ChatThreadActionHandler actions()

Return new instance of thread action handler for this ChatThread.

archive

public abstract Unit archive(Function1<Boolean, Unit> onComplete)

Requests that the server archive this thread.

customFields

public abstract ChatFieldHandler customFields()

Returns new instance of field handler for this ChatThread.

endContact

public abstract Unit endContact()

Terminate the contact.

events

public abstract ChatThreadEventHandler events()

Returns new instance of thread event handler for this ChatThread.

get

public abstract ChatThread get()

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()

public abstract Cancellable get(ChatThreadHandler.OnThreadUpdatedListener listener)

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

public abstract ChatThreadMessageHandler messages()

Returns new instance of message handler for this ChatThread.

refresh

public abstract Unit 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

public abstract Unit setName(String name)

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.