Package com.zopim.android.sdk.api

Class ZopimChat

java.lang.Object

com.zopim.android.sdk.api.ZopimChat

All Implemented Interfaces:

Chat, ChatApi, ChatApiCommands

public class ZopimChat
extends java.lang.Object
implements Chat

Definition for initialization and configuration of the chat.

Firstly, to initialize the chat call ZopimChat.init(String) with the correct account key obtained at your Zopim account configuration page.

A global chat configuration can be provided at initialization which will apply to all chat sessions that get started. Additionally, each chat session can be configured separately during chat start ZopimChat#start(android.support.v4.app.FragmentActivity). Starting a chat will provide an instance of Chat used for chat communication. That chat is the bound to the lifecycle of the activity that was used to start the chat.

See Also:

Getting Started, Chat

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZopimChat.DefaultConfig Configuration class for global chat configuration
static class	ZopimChat.SessionConfig Configuration class for session chat configuration

Method Summary

Modifier and Type	Method and Description
void	addNote(java.lang.String note) Appends a note to the current visitor note
static void	clearPushToken() Clear the push token.
void	disconnect() Disconnect the current chat, used when switching to push mode.
boolean	emailTranscript(java.lang.String email) Emails the current chat transcript
void	endChat() Ends the current chat.
ChatConfig	getConfig() Gets chat config for the current chat session as configured via ZopimChatApi
static DataSource	getDataSource() Deprecated. use ZopimChatApi.getDataSource() instead
static java.lang.Long	getInitializationTimeout() Deprecated. use ZopimChatApi.getInitializationTimeout() instead
static java.lang.Long	getReconnectTimeout() Deprecated. use ZopimChatApi.getReconnectTimeout() instead
boolean	hasEnded() Tells if this chat session has ended and can not be continued.
static ZopimChat.DefaultConfig	init(java.lang.String accountKey) Initiates chat and returns ZopimChat.DefaultConfig global configuration builder to be used for configuring the global chat settings.
void	resend(java.lang.String messageId) Re-sends the visitor message.
void	resetTimeout() Resets chat timeout.
static Chat	resume(FragmentActivity activity) Attempts to resume the existing chat if possible.
void	send(java.io.File file) Sends the file to the current chat log.
void	send(java.lang.String message) Sends the visitor message.
void	sendChatComment(java.lang.String comment) Sets a comment to the current chat session.
void	sendChatRating(ChatLog.Rating rating) Sets rating for the current chat session.
boolean	sendOfflineMessage(java.lang.String name, java.lang.String email, java.lang.String message) Sends email to agents defined in the dashboard for this account.
void	setDepartment(java.lang.String department) Sets a department to the current chat session.
void	setEmail(java.lang.String email) Sets the email for the user in the current chat session.
void	setName(java.lang.String name) Sets the name for the user in the current chat session.
void	setNote(java.lang.String note) Sets a note to the visitor profile
void	setPhoneNumber(java.lang.String phoneNumber) Sets phone number information for the user that is in the current chat session.
static void	setPushToken(java.lang.String token) Set the push token.
static void	setVisitorInfo(VisitorInfo visitorInfo) Configures the global VisitorInfo
static Chat	start(FragmentActivity activity) Starts the chat with global configuration.
static void	trackEvent(java.lang.String description) Leaves an event trace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

public static ZopimChat.DefaultConfig init(java.lang.String accountKey)

Initiates chat and returns ZopimChat.DefaultConfig global configuration builder to be used for configuring the global chat settings. This configuration will apply to all new instances of a chat session unless a new session configuration is provided when starting the new chat.

Parameters:

accountKey - Your account key obtained from the Zopim widget config page. Will configure chat to use your Zopim instance.

Returns:

configuration builder for setting the global chat configuration

start

public static Chat start(FragmentActivity activity)

Starts the chat with global configuration. Chat needs to be previously initialized.

Parameters:

activity - that holds the chat session

Returns:

chat session instance

resume

public static Chat resume(FragmentActivity activity)

Attempts to resume the existing chat if possible. Chat needs to be previously initialized.

Resuming a chat will be possible if the previous chat was not ended via ZopimChat.endChat() or expired. Chat timeout time, defined here ChatSession.DEFAULT_CHAT_SESSION_TIMEOUT is the time that expired after the last message exchange. If resuming was successful it will restore chat configuration from the server. If chat can not be resumed this will still return the chat instance but it won't be able to chat because it has ended ZopimChat.hasEnded().

Resumed chat might not be immediately ready to communicate.

Parameters:

activity - that holds the chat session

Returns:

chat session instance

setPushToken

public static void setPushToken(java.lang.String token)

Set the push token.

Parameters:

token - the Google/FCM device token

clearPushToken

public static void clearPushToken()

Clear the push token.

trackEvent

public static void trackEvent(java.lang.String description)

Leaves an event trace.

It is possible to track event prior chat session being started. Tracked events will be sent as soon as chat session is connected and any further event after that point will be sent immediately.

Parameters:

description - of the event

getDataSource

@Deprecated
public static DataSource getDataSource()

Deprecated. use ZopimChatApi.getDataSource() instead

Gets chat data source defined in DataSource and PathDataSource

Data source provides subscription to data update broadcasts. It also enables to get current state of a data path.

Returns:

data source

setVisitorInfo

public static void setVisitorInfo(VisitorInfo visitorInfo)

Configures the global VisitorInfo

Visitor info can be set at any point, but the changes will take effect at next chat session start

Parameters:

visitorInfo - visitor data from VisitorInfo

getReconnectTimeout

@Deprecated
public static java.lang.Long getReconnectTimeout()

Deprecated. use ZopimChatApi.getReconnectTimeout() instead

Gets reconnect timeout that was configured via ZopimChatApi.DefaultConfig.reconnectTimeout If timeout was not configured it will return the ChatSession.DEFAULT_RECONNECT_TIMEOUT

Returns:

reconnect timeout

getInitializationTimeout

@Deprecated
public static java.lang.Long getInitializationTimeout()

Deprecated. use ZopimChatApi.getInitializationTimeout() instead

Gets initialization timeout that was configured via ZopimChatApi.DefaultConfig.initializationTimeout If timeout was not configured it will return the ChatSession.DEFAULT_CHAT_INITIALIZATION_TIMEOUT

Returns:

initialization timeout

getConfig

public ChatConfig getConfig()

Description copied from interface: ChatApi

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.

Specified by:

getConfig in interface Chat

Specified by:

getConfig in interface ChatApi

Returns:

chat configuration

hasEnded

public boolean hasEnded()

Description copied from interface: ChatApi

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

Specified by:

hasEnded in interface ChatApi

Returns:

true if ended, false otherwise

resetTimeout

public void resetTimeout()

Description copied from interface: ChatApi

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

Specified by:

resetTimeout in interface ChatApi

send

public void send(java.lang.String message)

Description copied from interface: ChatApiCommands

Sends the visitor message.

This message will appear in the agent dashboard in an active chat queue.

Specified by:

send in interface ChatApiCommands

Parameters:

message - to be sent

See Also:

Agent Visitor List

send

public void send(java.io.File file)

Description copied from interface: ChatApiCommands

Sends the file to the current chat log. Successful file send will trigger a chat log update with information about the file being uploaded.

File must pass validation check and upload requirements defined in Zopim attachments page

A successful file upload will be visible in the agent dashboard.

Specified by:

send in interface ChatApiCommands

Parameters:

file - to send

See Also:

ChatLogObserver, Agent Dashboard

resend

public void resend(java.lang.String messageId)

Description copied from interface: ChatApiCommands

Re-sends the visitor message.

This message will appear in the agent dashboard.

Specified by:

resend in interface ChatApiCommands

Parameters:

messageId - id of the message to resend

See Also:

Agent Visitor List

sendOfflineMessage

public boolean sendOfflineMessage(java.lang.String name,
                                  java.lang.String email,
                                  java.lang.String message)

Description copied from interface: ChatApiCommands

Sends email to agents defined in the dashboard for this account.

Email must be provided in order for the agent to be able to respond.

Specified by:

sendOfflineMessage in interface ChatApiCommands

Parameters:

name - of the visitor

email - of the visitor

message - inquiry

Returns:

true if was able to send, false otherwise

sendChatRating

public void sendChatRating(ChatLog.Rating rating)

Description copied from interface: ChatApiCommands

Sets rating for the current chat session.

This will appear as a response to the chat rating questionnaire sent by an agent to the visitor.

Specified by:

sendChatRating in interface ChatApiCommands

Parameters:

rating - to set

sendChatComment

public void sendChatComment(java.lang.String comment)

Description copied from interface: ChatApiCommands

Sets a comment to the current chat session.

Specified by:

sendChatComment in interface ChatApiCommands

Parameters:

comment - to set

emailTranscript

public boolean emailTranscript(java.lang.String email)

Description copied from interface: ChatApiCommands

Emails the current chat transcript

It will send an email to the provided address with the current chat log

Specified by:

emailTranscript in interface ChatApiCommands

Parameters:

email - address to send the transcript to

Returns:

true if email was sent, false otherwise

endChat

public void endChat()

Description copied from interface: ChatApiCommands

Ends the current chat. This will update the connection status to closed.

Specified by:

endChat in interface ChatApiCommands

disconnect

public void disconnect()

Description copied from interface: ChatApiCommands

Disconnect the current chat, used when switching to push mode.

Specified by:

disconnect in interface ChatApiCommands

setDepartment

public void setDepartment(java.lang.String department)

Description copied from interface: ChatApiCommands

Sets a department to the current chat session.

Configuring a department in the chat will deliver the chat to the right group of agents supporting that department's inquiries. This information will be visible in the agent dashboard.

Provided department should be one of the departments available in this account. The list of available departments will be available in LivechatDepartmentsPath after initialization is complete ChatService#onChatInitialized(). Setting a non defined department will have no effect.

Specified by:

setDepartment in interface ChatApiCommands

Parameters:

department - visitor is chatting with

See Also:

Departments Dashboard

setPhoneNumber

public void setPhoneNumber(java.lang.String phoneNumber)

Description copied from interface: ChatApiCommands

Sets phone number information for the user that is in the current chat session.

This information will be visible in the agent dashboard.

Specified by:

setPhoneNumber in interface ChatApiCommands

Parameters:

phoneNumber - of the visitor

See Also:

Agent Dashboard

setName

public void setName(java.lang.String name)

Description copied from interface: ChatApiCommands

Sets the name for the user in the current chat session.

This information will be visible in the agent dashboard.

Specified by:

setName in interface ChatApiCommands

Parameters:

name - of the visitor

See Also:

Agent Dashboard

setEmail

public void setEmail(java.lang.String email)

Description copied from interface: ChatApiCommands

Sets the email for the user in the current chat session.

This information will be visible in the agent dashboard.

Specified by:

setEmail in interface ChatApiCommands

Parameters:

email - of the visitor

See Also:

Agent Dashboard

setNote

public void setNote(java.lang.String note)

Description copied from interface: ChatApiCommands

Sets a note to the visitor profile

Specified by:

setNote in interface ChatApiCommands

Parameters:

note - about the visitor

addNote

public void addNote(java.lang.String note)

Description copied from interface: ChatApiCommands

Appends a note to the current visitor note

Specified by:

addNote in interface ChatApiCommands

Parameters:

note - about the visitor to append