Input

sealed class Input

Represents an input on a form. The type of input is variable based on the form configuration.

Parameters

id

The unique identifier for this input.

label

The TitleItem of this input.

hintText

The text to help explain the purpose of the input.

required

Determines whether this input is required for the form.

inputType

The InputType data type of the input.

Inheritors

Types

Link copied to clipboard
class DatePickerInput(val id: String, val label: TitleItem.DefaultTitleItem, val hintText: String? = null, val required: Boolean? = false, val dateFormat: String? = null, val startDate: String? = null, val minimumDate: String? = null, val maximumDate: String? = null) : Input

Represents a date input on a form.

Link copied to clipboard
@JsonClass(generateAdapter = false)
enum InputType : Enum<Input.InputType>

An enum that describes possible Input.inputType types

Link copied to clipboard
class OptionPickerInput(val id: String, val label: TitleItem.DefaultTitleItem, val hintText: String? = null, val required: Boolean? = false, val optionItems: List<OptionItem.TypedOptionItem.TitleOptionItem>, val selectedOptionIndex: Int?) : Input

Represents a selectable input on a form for a single selection.

Link copied to clipboard
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.

Link copied to clipboard
class TextInput(val id: String, val label: TitleItem.DefaultTitleItem, val hintText: String? = null, val required: Boolean? = false, val textInputType: Input.TextInput.TextInputType? = TextInputType.Singleline, val placeholder: String? = null, val prefixText: String? = null, val maximumCharacterCount: Int? = null, val textContentType: Input.TextInput.TextContentType? = null, val keyboardType: Input.TextInput.TextKeyboardType? = null) : Input

Represents a text input on a form.

Link copied to clipboard
interface ValidationError

Properties

Link copied to clipboard
val hintText: String? = null
Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val required: Boolean? = false

Functions

Link copied to clipboard

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