ChoiceInput class

Initializes a new instance of the InputDialog class

new ChoiceInput(property?: string, prompt?: Partial<Activity> | string)

Parameters

static $kind: string

Property Value

Additional options passed to the ChoiceFactory and used to tweak the style of choices rendered to the user.

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

Property Value

List of choices to present to user.

choices: ObjectExpression<ChoiceSet>

Property Value

The prompts default locale that should be recognized.

defaultLocale?: StringExpression

Property Value

Control the format of the response (value or index of the choice).

outputFormat: EnumExpression<ChoiceOutputFormat>

Property Value

Additional options passed to the underlying recognizeChoices() function.

recognizerOptions?: ObjectExpression<FindChoicesOptions>

Property Value

Style of the "yes" and "no" choices rendered to the user when prompting.

style: EnumExpression<ListStyle>

Property Value

Remarks

Defaults to ListStyle.auto.

Interruption policy.

allowInterruptions: BoolExpression

Property Value

Inherited From InputDialog.allowInterruptions

A value indicating whether the input should always prompt the user regardless of there being a value or not.

alwaysPrompt: BoolExpression

Property Value

Inherited From InputDialog.alwaysPrompt

The default value for the input dialog when maxTurnCount is exceeded.

defaultValue?: ValueExpression

Property Value

Inherited From InputDialog.defaultValue

The activity template to send when maxTurnCount has be reached and the default value is used.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Inherited From InputDialog.defaultValueResponse

An optional expression which if is true will disable this action.

disabled?: BoolExpression

Property Value

Inherited From InputDialog.disabled

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult

Property Value

Remarks

This result indicates that a dialog (or a logical step within a dialog) has completed processing for the current turn, is still active, and is waiting for more input.

Inherited From Dialog.EndOfTurn

id: string

Property Value

Inherited From Dialog.id

The activity template to send to the user whenever the value provided is invalid or not.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Inherited From InputDialog.invalidPrompt

Maximum number of times to ask the user for this value before the dialog gives up.

maxTurnCount?: IntExpression

Property Value

Inherited From InputDialog.maxTurnCount

static OPTIONS_PROPERTY: string

Property Value

Inherited From InputDialog.OPTIONS_PROPERTY

The activity to send to the user.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Inherited From InputDialog.prompt

The value expression which the input will be bound to.

property: StringExpression

Property Value

Inherited From InputDialog.property

telemetryClient: BotTelemetryClient

Property Value

Inherited From Dialog.telemetryClient

static TURN_COUNT_PROPERTY: string

Property Value

Inherited From InputDialog.TURN_COUNT_PROPERTY

The activity template for retrying prompt.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Inherited From InputDialog.unrecognizedPrompt

The expressions to run to validate the input.

validations: string[]

Property Value

Inherited From InputDialog.validations

A value expression which can be used to initialize the input prompt.

value: ValueExpression

Property Value

Inherited From InputDialog.value

static VALUE_PROPERTY: string

Property Value

Inherited From InputDialog.VALUE_PROPERTY

function getConverter(property: Object): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

Called when the Dialog is started and pushed onto the dialog stack.

function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>

Parameters

Returns

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.beginDialog

Fluent method for configuring the object.

function configure(config: Record<string, unknown>): this

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Configurable.configure

Called when the Dialog is continued, where it is the active dialog and the user replies with a new activity.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameters

Returns

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.continueDialog

When overridden in a derived class, performs clean up for the dialog before it ends.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parameters

Returns

Remarks

Derived dialogs that need to perform logging or cleanup before ending should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog is ending.

See also

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

Inherited From Dialog.endDialog

An encoded string used to aid in the detection of bot changes on re-deployment.

function getVersion(): string

Returns

Unique string which should only change when dialog has changed in a way that should restart the dialog.

Remarks

This defaults to returning the dialogs id but can be overridden to provide more precise change detection logic. Any dialog on the stack that has its version change will result in a versionChanged event will be raised. If this event is not handled by the bot, an error will be thrown resulting in the bots error handler logic being run.

Returning an empty string will disable version tracking for the component all together.

Inherited From Dialog.getVersion

Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameters

Returns

True if the event is handled by the current dialog and bubbling should stop.

Inherited From Dialog.onDialogEvent

When overridden in a derived class, reprompts the user for input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameters

Returns

Remarks

Derived dialogs that support validation and re-prompt logic should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog should re-request input from the user. This method is implemented for prompt dialogs.

See also

• DialogContext.repromptDialog
• Prompt

Inherited From Dialog.repromptDialog

Called when a child Dialog completes its turn, returning control to this dialog.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameters

Returns

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.resumeDialog