public interface ChatApi
Defines the set of APIs available in a given chat session.
APIs will be linked to the account configured during initialization of ZopimChat.init(String)
Modifier and Type | Method and Description |
---|---|
boolean |
emailTranscript(String email)
Emails the current chat transcript
|
void |
endChat()
Ends the current chat.
|
void |
send(String message)
Sends the message to the agents.
|
boolean |
sendOfflineMessage(String name,
String email,
String message)
Sends email to agents defined in the dashboard for this account.
|
void |
setDepartment(String department)
Sets a department to the current chat session.
|
void |
setEmail(String email)
Sets the email for the user in the current chat session.
|
void |
setName(String name)
Sets the name for the user in the current chat session.
|
void |
setPhoneNumber(String phoneNumber)
Sets phone number information for the user that is in the current chat session.
|
void send(String message)
This message will appear in the agent dashboard in an active chat queue.
message
- to be sentboolean sendOfflineMessage(String name, String email, String message)
Email must be provided in order for the agent to be able to respond.
name
- of the visitoremail
- of the visitormessage
- inquiryvoid endChat()
boolean emailTranscript(String email)
It will send an email to the provided address with the current chat log
email
- address to send the transcript tovoid setDepartment(String department)
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.
department
- visitor is chatting withvoid setPhoneNumber(String phoneNumber)
This information will be visible in the agent dashboard.
phoneNumber
- of the visitorvoid setName(String name)
This information will be visible in the agent dashboard.
name
- of the visitorvoid setEmail(String email)
This information will be visible in the agent dashboard.
email
- of the visitor