Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NumberControlProps

Props for a NumberControl.

Hierarchy

Properties

Properties

Optional ambiguousPairs

ambiguousPairs: Array<[number, number]>

List of value-pairs that are known to be frequently misunderstood by NLU

Control behavior:

  • If the user disaffirms one value of a pair, the other will be suggested.

Optional apl

apl: NumberControlAPLProps

Props to customize the APL generated by this control.

Optional confirmationRequired

confirmationRequired: boolean | NumberConfirmationRequireFunction

Whether the Control has to obtain explicit confirmation of the value.

If true:

  • the Control will take initiative to explicitly confirm the value with a yes/no question.

id

id: string

Unique identifier for control instance

Optional inputHandling

inputHandling: ControlInputHandlingProps

Props to configure input handling.

Optional interactionModel

interactionModel: NumberControlInteractionModelProps

Props to customize the relationship between the control and the interaction model.

Optional prompts

prompts: NumberControlPromptsProps

Props to customize the prompt fragments that will be added by this.renderAct().

Optional reprompts

reprompts: NumberControlPromptsProps

Props to customize the reprompt fragments that will be added by this.renderAct().

Optional required

required: boolean | function

Determines if the Control must obtain a value.

  • If true the Control will take initiative to elicit a value.
  • If false the Control will not take initiative to elicit a value, but the user can provide one if they wish, e.g. "U: I would three of those".

Optional validation

validation: StateValidationFunction<NumberControlState> | Array<StateValidationFunction<NumberControlState>>

Function(s) that determine if the value is valid.

Default: true, i.e. any value is valid.

Usage:

  • Validation functions return either true or a ValidationResult to describe what validation failed.

Optional valueRenderer

valueRenderer: undefined | function

Function that maps the NumberControlState.value to rendered value that will be presented to the user as a list.

Default: returns the value unchanged in string format.