data/com.salesforce.android.smi.network.data.domain.prechat.choicelist/InternalChoiceListField

InternalChoiceListField

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.

Constructors

constructor(name: String, order: Int, labels: PreChatLabels, type: PreChatFieldType = PreChatFieldType.ChoiceList, required: Boolean, maxLength: Int, choiceListId: String, userInput: String = "", errorType: PreChatErrorType = PreChatErrorType.None, isHidden: Boolean = false, isEditable: Boolean = true, choiceList: ChoiceList = ChoiceList(choiceListId))

constructor(preChatField: PreChatField, choiceListId: String, choiceList: ChoiceList)

Properties

choiceList

@Transient

open override var choiceList: ChoiceList

The associated ChoiceList for the pre-chat field.

choiceListId

open override val choiceListId: String

The choice list ID, which maps to a particular choice list on the ChoiceListConfiguration.

errorType

open override var errorType: PreChatErrorType

The current validation error for this field, or PreChatErrorType.None if valid.

isEditable

open var isEditable: Boolean

Whether the user can modify this field. Non-editable fields display a pre-filled value.

isHidden

open override var isHidden: Boolean

Whether this field is hidden from the user. Hidden fields can still carry default values.

labels

open val labels: PreChatLabels

The localized label strings displayed to the user for this field.

maxLength

open val maxLength: Int

The maximum number of characters allowed for this field's input.

name

open val name: String

The programmatic name identifying this field in the deployment configuration.

order

open val order: Int

The display order of this field within the pre-chat form (lower values appear first).

required

open val required: Boolean

Whether this field must be filled before the form can be submitted.

type

open val type: PreChatFieldType

The input type of this field, which determines validation rules and keyboard behavior.

userInput

open override var userInput: String

The current user-provided value for this field. Set this to populate the field.

Functions

isValid

open override fun isValid(): Boolean

Returns true if the current userInput passes all validation rules for this field.

validate

open override fun validate(): PreChatErrorType

Validates the current userInput against this field's rules (required, format, max length).