Package-level declarations

Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ChoiceList(val choiceListId: String, val choiceListValues: List<ChoiceListValue> = emptyList())

The choice list that is associated with a particular ChoiceListField.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ChoiceListConfiguration(val choiceList: List<ChoiceList>, val choiceListValueDependencies: List<ChoiceListValueDependency>)

A ChoiceListConfiguration that defines the mappings between a pre-chat field and the choice list associated with it.

Link copied to clipboard

A choice list pre-chat field for a Conversation.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ChoiceListValue(val order: Int, val choiceListValueName: String, val choiceListValueId: String, val isDefaultValue: Boolean, val label: String)

A single value in a ChoiceList with instructions for how it should be displayed.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ChoiceListValueDependency(val parentChoiceListValueId: String, val childChoiceListValueId: String)

A mapping between a parent choice list and its dependent child choice list value.

Link copied to clipboard
class InternalChoiceListField(name: String, order: Int, labels: PreChatLabels, type: PreChatFieldType = PreChatFieldType.ChoiceList, required: Boolean, maxLength: Int, val choiceListId: String, userInput: String = "", errorType: PreChatErrorType = PreChatErrorType.None, isHidden: Boolean = false, isEditable: Boolean = true, var choiceList: ChoiceList = ChoiceList(choiceListId)) : ChoiceListField, InternalPreChatField

A pre-chat form field backed by a ChoiceList, allowing users to select from predefined options.