public static class

ChatConfiguration.Builder

extends Object
java.lang.Object
   ↳ com.salesforce.android.chat.core.ChatConfiguration.Builder

Summary

Public Constructors
Builder(String organizationId, String buttonId, String deploymentId, String liveAgentPod)
Builder for ChatConfiguration.
Builder(ChatConfiguration configuration)
Public Methods
ChatConfiguration build()
Build a new ChatConfiguration instance.
ChatConfiguration.Builder chatEntities(ChatEntity... chatEntities)
Add ChatEntity objects which define the relationship between ChatUserData and Salesforce objects.
ChatConfiguration.Builder chatEntities(List<ChatEntity> chatEntities)
Add ChatEntity objects which define the relationship between ChatUserData and Salesforce objects.
ChatConfiguration.Builder chatUserData(List<ChatUserData> chatUserData)
Add ChatUserData objects which will allow you to present information to the agent about the user initiating the chat request.
ChatConfiguration.Builder chatUserData(ChatUserData... chatUserData)
Add ChatUserData objects which will allow you to present information to the agent about the user initiating the chat request.
ChatConfiguration.Builder liveAgentPod(String liveAgentPod)
Optionally override the LiveAgentPod provided to the builder constructor.
<T extends ChatEntity> ChatConfiguration.Builder preChatEntities(List<T> preChatEntities)
This method is deprecated. Please create ChatEntity objects and pass them to chatEntities(List)
<T extends ChatUserData> ChatConfiguration.Builder preChatFields(List<T> preChatFields)
This method is deprecated. Please create ChatUserData objects and pass them to chatUserData(List)
ChatConfiguration.Builder visitorName(String visitorName)
Optionally set the visitor name for this session.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder (String organizationId, String buttonId, String deploymentId, String liveAgentPod)

Builder for ChatConfiguration. Please note that the LiveAgent Pod parameter is expected to be the Fully-Qualified Domain Name of your pod and not the entire HTTPS URL.

Example: "pod1.la.salesforce.com"

Parameters
organizationId Your Salesforce Organization ID
buttonId The Button ID from your Organization's LiveAgent Chat configuration
deploymentId The Deployment ID from your Organization's LiveAgent Chat configuration
liveAgentPod The LiveAgent Pod FQDN for your Organization.

public Builder (ChatConfiguration configuration)

Public Methods

public ChatConfiguration build ()

Build a new ChatConfiguration instance.

Returns

public ChatConfiguration.Builder chatEntities (ChatEntity... chatEntities)

Add ChatEntity objects which define the relationship between ChatUserData and Salesforce objects. This permits you to query for and update records such as Contacts and Cases.

public ChatConfiguration.Builder chatEntities (List<ChatEntity> chatEntities)

Add ChatEntity objects which define the relationship between ChatUserData and Salesforce objects. This permits you to query for and update records such as Contacts and Cases.

public ChatConfiguration.Builder chatUserData (List<ChatUserData> chatUserData)

Add ChatUserData objects which will allow you to present information to the agent about the user initiating the chat request. ChatUserData can also be associated with ChatEntityField objects which are used to perform lookup queries for Salesforce records using the data value within.

public ChatConfiguration.Builder chatUserData (ChatUserData... chatUserData)

Add ChatUserData objects which will allow you to present information to the agent about the user initiating the chat request. ChatUserData can also be associated with ChatEntityField objects which are used to perform lookup queries for Salesforce records using the data value within.

public ChatConfiguration.Builder liveAgentPod (String liveAgentPod)

Optionally override the LiveAgentPod provided to the builder constructor.

Parameters
liveAgentPod the new liveAgentPod value.

public ChatConfiguration.Builder preChatEntities (List<T> preChatEntities)

This method is deprecated.
Please create ChatEntity objects and pass them to chatEntities(List)

public ChatConfiguration.Builder preChatFields (List<T> preChatFields)

This method is deprecated.
Please create ChatUserData objects and pass them to chatUserData(List)

public ChatConfiguration.Builder visitorName (String visitorName)

Optionally set the visitor name for this session.

Parameters
visitorName the name applied to outgoing chat messages for this session.