Package com.zopim.android.sdk.api

Interface ChatApi

All Superinterfaces:

ChatApiCommands

All Known Subinterfaces:

Chat

All Known Implementing Classes:

UninitializedChat, ZopimChat, ZopimChatApi

public interface ChatApi
extends ChatApiCommands

Interface definition of the chat

This interface describes available communication and configuration APIs for a given chat session.

Method Summary

Modifier and Type	Method and Description
ChatApiConfig	getConfig() Gets chat config for the current chat session as configured via ZopimChatApi
boolean	hasEnded() Tells if this chat session has ended and can not be continued.
void	resetTimeout() Resets chat timeout.

Methods inherited from interface com.zopim.android.sdk.api.ChatApiCommands

addNote, disconnect, emailTranscript, endChat, resend, send, send, sendChatComment, sendChatRating, sendOfflineMessage, setDepartment, setEmail, setName, setNote, setPhoneNumber

Method Detail

getConfig

ChatApiConfig getConfig()

Gets chat config for the current chat session as configured via ZopimChatApi

It will reflect ZopimChatApi.DefaultConfig configuration values unless overridden via ZopimChatApi.SessionConfig at chat start.

Returns:

chat configuration

hasEnded

boolean hasEnded()

Tells if this chat session has ended and can not be continued.

Returns:

true if ended, false otherwise

resetTimeout

void resetTimeout()

Resets chat timeout. This will offset the timeout by the value configured via ZopimChatApi.DefaultConfig.sessionTimeout(long).