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 chatThis interface describes available communication and configuration APIs for a given chat session.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ChatApiConfiggetConfig()Gets chat config for the current chat session as configured viaZopimChatApibooleanhasEnded()Tells if this chat session has ended and can not be continued.voidresetTimeout()Resets chat timeout.-
Methods inherited from interface com.zopim.android.sdk.api.ChatApiCommands
emailTranscript, endChat, resend, send, send, sendChatComment, sendChatRating, sendOfflineMessage, setDepartment, setEmail, setName, setPhoneNumber
-
-
-
-
Method Detail
-
getConfig
ChatApiConfig getConfig()
Gets chat config for the current chat session as configured viaZopimChatApiIt will reflect
ZopimChatApi.DefaultConfigconfiguration values unless overridden viaZopimChatApi.SessionConfigat 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 viaZopimChatApi.DefaultConfig.sessionTimeout(long).
-
-