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

ChatEventHandler

interface ChatEventHandler

Event handler allows for triggering events regarding the overall Chat instance. 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

Listener to be notified when the triggered event is considered sent.

Functions

fun ChatEventHandler.chatWindowOpen(date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a ChatWindowOpen event to the analytics server.

fun ChatEventHandler.conversion(type: String, value: Number, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a conversion event to the analytics server.

fun ChatEventHandler.customVisitor(data: Any, listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send an arbitrary custom analytics event to the analytics server.

fun ChatEventHandler.event(id: UUID, listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Trigger event specified in agent console or elsewhere as per your representative instructions. This event is not mandatory though, consult your representative for more information.

fun ChatEventHandler.pageView(title: String, uri: String, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

send a page viewed event to the server.

fun ChatEventHandler.pageViewEnded(title: String, uri: String, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

send a page view ended event to the server when a previously viewed page is left.

proactiveActionClick

fun ChatEventHandler.proactiveActionClick(data: ActionMetadata, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a proactive action click event to the analytics.

proactiveActionDisplay

fun ChatEventHandler.proactiveActionDisplay(data: ActionMetadata, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a proactive action display event to the analytics.

proactiveActionFailure

fun ChatEventHandler.proactiveActionFailure(data: ActionMetadata, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a proactive action failure event to the analytics.

proactiveActionSuccess

fun ChatEventHandler.proactiveActionSuccess(data: ActionMetadata, date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a proactive action success event to the analytics.

fun ChatEventHandler.refresh(listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Refresh the authentication token associated with the chat.

abstract fun trigger(event: ChatEvent<*>, listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

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