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

ChatEventHandlerActions

public class ChatEventHandlerActions

Provides in-one-place interactions to trigger all available events. Analytic events usually can be sent once the chat instance is in at least ChatState.Prepared state.

See also

Properties

Link copied to clipboard
public final static ChatEventHandlerActions INSTANCE

Functions

Link copied to clipboard
@JvmOverloads()
public final static Unit chatWindowOpen(ChatEventHandler $self, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit chatWindowOpen(ChatEventHandler $self, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit chatWindowOpen(ChatEventHandler $self, Date date)
@JvmOverloads()
public final static Unit chatWindowOpen(ChatEventHandler $self)

Send a ChatWindowOpen event to the analytics server.

Link copied to clipboard
@JvmOverloads()
public final static Unit conversion(ChatEventHandler $self, String type, Number value, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit conversion(ChatEventHandler $self, String type, Number value, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit conversion(ChatEventHandler $self, String type, Number value, Date date)
@JvmOverloads()
public final static Unit conversion(ChatEventHandler $self, String type, Number value)

Send a conversion event to the analytics server.

Link copied to clipboard
@JvmOverloads()
public final static Unit customVisitor(ChatEventHandler $self, Object data, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit customVisitor(ChatEventHandler $self, Object data, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit customVisitor(ChatEventHandler $self, Object data)

Send an arbitrary custom analytics event to the analytics server.

Link copied to clipboard
@JvmOverloads()
public final static Unit event(ChatEventHandler $self, UUID id, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit event(ChatEventHandler $self, UUID id, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit event(ChatEventHandler $self, UUID id)

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()
public final static Unit pageView(ChatEventHandler $self, String title, String uri, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit pageView(ChatEventHandler $self, String title, String uri, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit pageView(ChatEventHandler $self, String title, String uri, Date date)
@JvmOverloads()
public final static Unit pageView(ChatEventHandler $self, String title, String uri)

send a page viewed event to the server.

Link copied to clipboard
@JvmOverloads()
public final static Unit pageViewEnded(ChatEventHandler $self, String title, String uri, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit pageViewEnded(ChatEventHandler $self, String title, String uri, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit pageViewEnded(ChatEventHandler $self, String title, String uri, Date date)
@JvmOverloads()
public final static Unit pageViewEnded(ChatEventHandler $self, String title, String uri)

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

Link copied to clipboard
@JvmOverloads()
public final static Unit proactiveActionClick(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit proactiveActionClick(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit proactiveActionClick(ChatEventHandler $self, ActionMetadata data, Date date)
@JvmOverloads()
public final static Unit proactiveActionClick(ChatEventHandler $self, ActionMetadata data)

Send a proactive action click event to the analytics.

Link copied to clipboard
@JvmOverloads()
public final static Unit proactiveActionDisplay(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit proactiveActionDisplay(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit proactiveActionDisplay(ChatEventHandler $self, ActionMetadata data, Date date)
@JvmOverloads()
public final static Unit proactiveActionDisplay(ChatEventHandler $self, ActionMetadata data)

Send a proactive action display event to the analytics.

Link copied to clipboard
@JvmOverloads()
public final static Unit proactiveActionFailure(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit proactiveActionFailure(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit proactiveActionFailure(ChatEventHandler $self, ActionMetadata data, Date date)
@JvmOverloads()
public final static Unit proactiveActionFailure(ChatEventHandler $self, ActionMetadata data)

Send a proactive action failure event to the analytics.

Link copied to clipboard
@JvmOverloads()
public final static Unit proactiveActionSuccess(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit proactiveActionSuccess(ChatEventHandler $self, ActionMetadata data, Date date, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit proactiveActionSuccess(ChatEventHandler $self, ActionMetadata data, Date date)
@JvmOverloads()
public final static Unit proactiveActionSuccess(ChatEventHandler $self, ActionMetadata data)

Send a proactive action success event to the analytics.

Link copied to clipboard
@JvmOverloads()
public final static Unit refresh(ChatEventHandler $self, ChatEventHandler.OnEventSentListener listener, ChatEventHandler.OnEventErrorListener errorListener)
@JvmOverloads()
public final static Unit refresh(ChatEventHandler $self, ChatEventHandler.OnEventSentListener listener)
@JvmOverloads()
public final static Unit refresh(ChatEventHandler $self)

Refresh the authentication token associated with the chat.