data/com.salesforce.android.smi.network.data.domain.conversationEntry.entryPayload.message.component.form.input/Input/SelectInput

SelectInput

class SelectInput(val id: String, val label: TitleItem.DefaultTitleItem, val hintText: String? = null, val required: Boolean? = false, val optionItems: List<OptionItem.TypedOptionItem.TitleOptionItem>, val multipleSelection: Boolean = false) : Input

Represents a selectable input on a form for single or multiple selections.

Parameters

optionItems

A List of OptionItem.TypedOptionItem.TitleOptionItem selectable options.

multipleSelection

Determines whether this input allows for multiple selections.

Constructors

constructor(id: String, label: TitleItem.DefaultTitleItem, hintText: String? = null, required: Boolean? = false, optionItems: List<OptionItem.TypedOptionItem.TitleOptionItem>, multipleSelection: Boolean = false)

Types

SelectInputValidationError

enum SelectInputValidationError : Enum<Input.SelectInput.SelectInputValidationError> , Input.ValidationError

Properties

val hintText: String? = null

val id: String

val inputType: Input.InputType

val label: TitleItem.DefaultTitleItem

multipleSelection

val multipleSelection: Boolean = false

val optionItems: List<OptionItem.TypedOptionItem.TitleOptionItem>

val required: Boolean? = false

@Transient

var value: List<OptionItem.TypedOptionItem.TitleOptionItem>

The currently selected OptionItem.TypedOptionItem.TitleOptionItem values for this input.

Functions

open override fun asInputValue(): InputValue.SelectedOptionsInputValue

Converts the input to its corresponding InputValue type

open override fun validate(): Input.ValidationError?

Use this validation to determine if the current value for this input is valid.