java.lang.Object | |
↳ | com.salesforce.android.chat.core.model.ChatEntity |
Known Direct Subclasses |
An ChatEntity object defines a set of behavior for interacting with a Salesforce object, ie. Case
or Contact. This class allows you to define the relationship between custom data (supplied to
the chat session in one or more ChatUserData
objects) and Salesforce objects.
Customizing the behavior that is performed using this entity and the custom user data when a chat
session starts is defined by mapping a ChatEntity to one or many ChatEntityField
objects,
which link ChatUserData
values to specific fields of the matching Salesforce records.
ChatEntity objects may be instantiated via ChatEntity.Builder
.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | ChatEntity.Builder | Used to construct ChatEntity objects for interacting with Salesforce objects. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
List<ChatEntityField> |
getChatEntityFields()
The
ChatEntityField objects associated with this ChatEntity that define which Salesforce
object fields are found and updated with data provided from ChatUserData . | ||||||||||
String |
getLinkedSalesforceObjectFieldName()
The field name of the Salesforce object that this entity is linked to.
| ||||||||||
String |
getLinkedSalesforceObjectType()
The name of the Salesforce object that this entity is linked to.
| ||||||||||
String |
getLinkedTranscriptFieldName()
The name of the transcript field that the resulting Salesforce record will be linked to.
| ||||||||||
String |
getSalesforceObjectType()
The name of the Salesforce object type that this entity relates to.
| ||||||||||
boolean |
getShowOnCreate()
Whether or not the Salesforce records found or created as a result of this entity's behavior
will be shown to the agent in the agent console.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
The ChatEntityField
objects associated with this ChatEntity that define which Salesforce
object fields are found and updated with data provided from ChatUserData
.
The field name of the Salesforce object that this entity is linked to.
The name of the Salesforce object that this entity is linked to. The related object field name
can be obtained by calling getLinkedSalesforceObjectFieldName()
.
The name of the transcript field that the resulting Salesforce record will be linked to.
The name of the Salesforce object type that this entity relates to.
Whether or not the Salesforce records found or created as a result of this entity's behavior will be shown to the agent in the agent console.