| java.lang.Object | |
| ↳ | com.salesforce.android.chat.core.model.ChatEntityField |
 Known Direct Subclasses
|
Class Overview
ChatEntityFields are used to define which Salesforce object fields a ChatEntity
interacts with and what the behavior should be. This behavior defines how to find or create
Salesforce records based on data about your users by linking that data to a specific Salesforce
object field.
Note that this will only work as expected if the mapped ChatUserData object you supply to
build(String, ChatUserData) is also supplied to
chatUserData(List).
ChatEntityField objects may be instantiated via ChatEntityField.Builder.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | ChatEntityField.Builder | Used to construct ChatEntityField objects for interacting with the fields of a
Salesforce object via ChatEntity. |
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
doCreate()
Whether or not a new Salesforce record should be created if no matching results are found after
performing a lookup if specified by passing true to
doFind(boolean). | ||||||||||
| boolean |
doFind()
Whether or not this entity field will perform a lookup query for records that match the
ChatUserData value within the specified record field. | ||||||||||
| ChatUserData |
getMappedChatUserData()
The
ChatUserData that this entity field is mapped to. | ||||||||||
| String |
getSalesforceObjectFieldName()
The field name of the Salesforce object that the mapped
ChatUserData relates to. | ||||||||||
| boolean |
isExactMatch()
Whether or not the lookup should match Salesforce record results based on an exact match with
the value provided by
ChatUserData. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Public Methods
public boolean doCreate ()
Whether or not a new Salesforce record should be created if no matching results are found after
performing a lookup if specified by passing true to doFind(boolean).
public boolean doFind ()
Whether or not this entity field will perform a lookup query for records that match the
ChatUserData value within the specified record field.
public ChatUserData getMappedChatUserData ()
The ChatUserData that this entity field is mapped to. The value of this object is used
when performing a Salesforce record lookup, and when writing to the fields of matching records.
public String getSalesforceObjectFieldName ()
The field name of the Salesforce object that the mapped ChatUserData relates to.
Since ChatEntityField objects are meant to define the behavior of a ChatEntity, the
Salesforce object is defined by the ChatEntity this field is added to via
addChatEntityField(ChatEntityField).
public boolean isExactMatch ()
Whether or not the lookup should match Salesforce record results based on an exact match with
the value provided by ChatUserData.