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

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.

Functions

chatWindowOpen

@JvmStatic

suspend fun ChatEventHandler.chatWindowOpen(instant: Instant = Clock.System.now())

Send a ChatWindowOpen event to the analytics server.

conversion

@JvmStatic

suspend fun ChatEventHandler.conversion(type: String, value: Number, instant: Instant = Clock.System.now())

Send a conversion event to the analytics server.

customVisitor

@JvmStatic

suspend fun ChatEventHandler.customVisitor(data: Any)

Send an arbitrary custom analytics event to the analytics server.

event

@JvmStatic

suspend fun ChatEventHandler.event(id: UUID)

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.

pageView

@JvmStatic

suspend fun ChatEventHandler.pageView(title: String, uri: String, instant: Instant = Clock.System.now())

send a page viewed event to the server.

pageViewEnded

@JvmStatic

suspend fun ChatEventHandler.pageViewEnded(title: String, uri: String, instant: Instant = Clock.System.now())

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

proactiveActionClick

@JvmStatic

suspend fun ChatEventHandler.proactiveActionClick(data: ActionMetadata, instant: Instant = Clock.System.now())

Send a proactive action click event to the analytics.

proactiveActionDisplay

@JvmStatic

suspend fun ChatEventHandler.proactiveActionDisplay(data: ActionMetadata, instant: Instant = Clock.System.now())

Send a proactive action display event to the analytics.

proactiveActionFailure

@JvmStatic

suspend fun ChatEventHandler.proactiveActionFailure(data: ActionMetadata, instant: Instant = Clock.System.now())

Send a proactive action failure event to the analytics.

proactiveActionSuccess

@JvmStatic

suspend fun ChatEventHandler.proactiveActionSuccess(data: ActionMetadata, instant: Instant = Clock.System.now())

Send a proactive action success event to the analytics.

trigger

abstract suspend fun trigger(event: ChatEvent<*>)

Sends an event to the server without further delays.