java.lang.Object | ||
↳ | com.salesforce.android.chat.core.model.ChatUserData | |
↳ | com.salesforce.android.chat.core.model.PreChatField |
This class is deprecated.
Deprecated in favor of ChatUserData
Class which describes a PreChatField as configured for snap-ins in your salesforce organization.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | PreChatField.Builder |
This class is deprecated.
Deprecated in favor of ChatUserData .
|
|||||||||
class | PreChatField.PickListOption | Represent a PickList option as a serializable tuple. | |||||||||
@interface | PreChatField.Type |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | |||||||||||
String | PHONE | ||||||||||
String | PICKLIST | ||||||||||
String | STRING |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String |
getDisplayName()
This is the display name which should be used if displaying this input to a user.
| ||||||||||
String |
getExtraTypeInfo()
Supplies additional information which describes the function of the field.
| ||||||||||
String |
getFieldName()
This method is deprecated.
Construct a
ChatUserData object and use {getAgentLabel() } instead.
| ||||||||||
Integer |
getMaxValueLength()
The expected maximum length of the field.
| ||||||||||
List<PreChatField.PickListOption> |
getPickListOptions()
Return the currently configured picklist option.
| ||||||||||
int |
getSelectedPickListIndex()
Returns the currently selected index from the picklist.
| ||||||||||
String[] |
getTranscriptFields()
This method is deprecated.
Construct a
ChatUserData object and use {getTranscriptFieldNames() instead.
| ||||||||||
String |
getType()
Returns the input type of the field.
| ||||||||||
Boolean |
isHidden()
Returns whether or not this field should be hidden from the UI.
| ||||||||||
boolean |
isPickListItemSelected()
Whether or not a picklist item has been selected.
| ||||||||||
Boolean |
isReadOnly()
Whether this field is writable.
| ||||||||||
Boolean |
isRequired()
Whether this field should be considered required.
| ||||||||||
Boolean |
isSatisfied()
A field is satisfied if it is either read only, not required, or otherwise meets the following
criteria:
| ||||||||||
void |
setSelectedPickListIndex(int index)
Sets a selected index for the picklist options.
| ||||||||||
void |
setValue(Serializable value)
Sets the value for this field.
| ||||||||||
void |
unsetSelectedPickListIndex()
Resets the current picklist selection value.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.salesforce.android.chat.core.model.ChatUserData
| |||||||||||
From class
java.lang.Object
|
This is the display name which should be used if displaying this input to a user.
Supplies additional information which describes the function of the field.
The expected maximum length of the field.
Return the currently configured picklist option. The first value is the label applied to the option, the second value is what is what should be set to the value of the field if selected.
Returns the currently selected index from the picklist. If this option is not a picklist then this value is the default unselected value of -1.
This method is deprecated.
Construct a ChatUserData
object and use {getTranscriptFieldNames()
instead.
Get an array of Live Chat Transcript Field API Names that the value stored in this field will be mapped to.
Returns the input type of the field. This is used as a guide for how to present the field the the user.
PreChatField.Type
Whether or not a picklist item has been selected.
Whether this field is writable.
Whether this field should be considered required. If this is required then the value should be non null. This is an expectation on the nature of the field and is not enforced by this class.
A field is satisfied if it is either read only, not required, or otherwise meets the following criteria:
Sets a selected index for the picklist options. The option is ignored if the field is not a picklist or if the value is out of bounds.
index | the current index of the picklist to set. |
---|
Sets the value for this field. Note if this field is isReadOnly()
then this will not
change the current value.
value | the value set for the field. |
---|
Resets the current picklist selection value.