WaterfallDialog class

Creates a new waterfall dialog containing the given array of steps.

new WaterfallDialog(dialogId: string, steps?: WaterfallStep<O>[])

Parameters

Remarks

See the addStep function for details on creating a valid step function.

Unique ID of the dialog.

string id

Property Value

The Id for the dialog.

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult<any>

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

Adds a new step to the waterfall.

function addStep(step: WaterfallStep<O>): WaterfallDialog<O>

Parameters

Returns

Waterfall dialog for fluent calls to addStep().

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

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

Parameters

Returns

A Promise representing the asynchronous operation.

Remarks

If the task is successful, the result indicates whether the Dialog is still active after the turn has been processed by the dialog.

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

function continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult<any>>

Parameters

Returns

A Promise representing the asynchronous operation.

Remarks

If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog. The result may also contain a return value.

Gets the dialog version, composed of the ID and number of steps.

function getVersion(): string

Returns

Dialog version, composed of the ID and number of steps.

Called when a child WaterfallDialog completed its turn, returning control to this dialog.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

Parameters

Returns

A Promise representing the asynchronous operation.

Fluent method for configuring the object.

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

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Dialog.configure

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

function endDialog(_context: TurnContext, _instance: DialogInstance<any>, _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.

Inherited From Dialog.endDialog

Gets the converter for the selector configuration. *

function getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory<unknown, unknown>

Parameters

Returns

The converter for the selector configuration.

Inherited From Dialog.getConverter

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

function onDialogEvent(dialogContext: DialogContext, event: 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, prompts the user again for input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance<any>): 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.

Inherited From Dialog.repromptDialog