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

ChatThreadEventHandler

interface ChatThreadEventHandler

Event handler allows for triggering events regarding the ChatThread instance it was created for.

It has no side effects attached to it and can be created again on demand.

Types

OnEventErrorListener

fun interface OnEventErrorListener

Listener which will be notified when the triggered event has failed with an error.

OnEventSentListener

fun interface OnEventSentListener

A listener to be notified when the triggered event is sent.

Functions

fun ChatThreadEventHandler.~~archiveThread~~(listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Archive the thread.

fun ChatThreadEventHandler.loadMetadata(listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Request additonal thread metadata.

fun ChatThreadEventHandler.markThreadRead(listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Mark the thread as read.

abstract fun trigger(event: ChatThreadEvent, listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Sends an event to server without further delays. If sending of the event fails, the event is considered consumed anyway.

fun ChatThreadEventHandler.typingEnd(listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Notify the server that the user has stopped typing.

fun ChatThreadEventHandler.typingStart(listener: ChatThreadEventHandler.OnEventSentListener? = null, errorListener: ChatThreadEventHandler.OnEventErrorListener? = null)

Notify the agent that the user has started typing.