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

ChatEventHandlerActions

object ChatEventHandlerActions

Provides in-one-place interactions to trigger all available events.

See also

Functions

Link copied to clipboard
@JvmOverloads
@JvmStatic
fun ChatEventHandler.chatWindowOpen(date: Date = Date(), listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send a ChatWindowOpen event to the analytics server.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
fun ChatEventHandler.customVisitor(data: Any, listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Send an arbitrary custom analytics event to the analytics server.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
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.

Link copied to clipboard
@JvmOverloads
@JvmStatic
fun ChatEventHandler.refresh(listener: ChatEventHandler.OnEventSentListener? = null, errorListener: ChatEventHandler.OnEventErrorListener? = null)

Refresh the authentication token associated with the chat.