chat-sdk-core/com.nice.cxonechat.state/FieldDefinition/Hierarchy

Hierarchy

interface Hierarchy : FieldDefinition

Details of a hierarchical or tree field.

Usually displayed as a collapsing tree, with each node displaying text corresponding to the label field of the corresponding HierarchyNode. The value of the field can only be set to one of the HierarchyNode.nodeId values from the hierarchy of nodes, where the corresponding HierarchyNode.isLeaf property is true.

Properties

Link copied to clipboard
abstract val fieldId: String

Identifier for the field.

Link copied to clipboard
abstract val isRequired: Boolean

True iff the value is required. This is only valid for fields within a survey

Link copied to clipboard
abstract val label: String

Human-readable label for the field.

Link copied to clipboard
abstract val values: Sequence<HierarchyNode<String>>

Top level options.

Functions

Link copied to clipboard
abstract fun validate(value: String)

Check if value is valid for this field definition.