WaterfallStepContext class

Creates a new WaterfallStepContext instance.

new WaterfallStepContext(dc: DialogContext, info: WaterfallStepInfo<O>)

Parameters

DialogInstance | undefined activeDialog

Property Value

The state information for the dialog on the top of the dialog stack, or undefined if the stack is empty.

DialogContext | undefined child

Property Value

Dialog context for child if the active dialog is a container.

DialogManager dialogManager

Property Value

The current dialog manager instance. This property is deprecated.

The index of the current waterfall step being executed.

number index

Property Value

The index of the current waterfall step being executed.

Any options passed to the steps waterfall dialog when it was started with DialogContext.beginDialog().

O options

Property Value

Any options the waterfall dialog was called with.

The reason the waterfall step is being executed.

DialogReason reason

Property Value

The reason the waterfall step is being executed.

Results returned by a dialog or prompt that was called in the previous waterfall step.

any result

Property Value

The result from the previous waterfall step.

A dictionary of values which will be persisted across all waterfall steps.

object values

Property Value

A dictionary of values which will be persisted across all waterfall steps.

Gets the context object for the turn.

context: TurnContext

Property Value

Inherited From DialogContext.context

Gets the dialogs that can be called directly from this context.

dialogs: DialogSet

Property Value

Inherited From DialogContext.dialogs

The parent dialog context for this dialog context, or undefined if this context doesn't have a parent.

parent: DialogContext | undefined

Property Value

Remarks

When it attempts to start a dialog, the dialog context searches for the Dialog.id in its dialogs. If the dialog to start is not found in this dialog context, it searches in its parent dialog context, and so on.

Inherited From DialogContext.parent

Gets the services collection which is contextual to this dialog context.

services: TurnContextStateCollection

Property Value

Inherited From DialogContext.services

Gets the current dialog stack.

stack: DialogInstance[]

Property Value

Inherited From DialogContext.stack

Gets the DialogStateManager which manages view of all memory scopes.

state: DialogStateManager

Property Value

Inherited From DialogContext.state

Skips to the next waterfall step.

function next(result?: any): Promise<DialogTurnResult>

Parameters

Returns

A promise with the DialogTurnResult.

Remarks

return await step.skip();

Starts a dialog instance and pushes it onto the dialog stack. Creates a new instance of the dialog and pushes it onto the stack.

function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parameters

Returns

a promise resolving to the dialog turn result.

Remarks

If there's already an active dialog on the stack, that dialog will be paused until it is again the top dialog on the stack.

The status of returned object describes the status of the dialog stack after this method completes.

This method throws an exception if the requested dialog can't be found in this dialog context or any of its ancestors.

For example:

const result = await dc.beginDialog('greeting', { name: user.name });

See also

• endDialog
• prompt
• replaceDialog
• Dialog.beginDialog

Inherited From DialogContext.beginDialog

Cancels all dialogs on the dialog stack, and clears stack.

function cancelAllDialogs(cancelParents?: boolean, eventName?: string, eventValue?: any): Promise<DialogTurnResult>

Parameters

Returns

a promise resolving to the dialog turn result.

Remarks

This calls each dialog's Dialog.endDialog method before removing the dialog from the stack.

If there were any dialogs on the stack initially, the status of the return value is cancelled; otherwise, it's empty.

This example clears a dialog stack, dc, before starting a 'bookFlight' dialog.

await dc.cancelAllDialogs();
return await dc.beginDialog('bookFlight');

See also

• endDialog

Inherited From DialogContext.cancelAllDialogs

Continues execution of the active dialog, if there is one, by passing this dialog context to its Dialog.continueDialog method.

function continueDialog(): Promise<DialogTurnResult>

Returns

a promise resolving to the dialog turn result.

Remarks

After the call completes, you can check the turn context's responded property to determine if the dialog sent a reply to the user.

The status of returned object describes the status of the dialog stack after this method completes.

Typically, you would call this from within your bot's turn handler.

For example:

const result = await dc.continueDialog();
if (result.status == DialogTurnStatus.empty && dc.context.activity.type == ActivityTypes.message) {
    // Send fallback message
    await dc.context.sendActivity(`I'm sorry. I didn't understand.`);
}

Inherited From DialogContext.continueDialog

Searches for a dialog with a given ID.

function emitEvent(name: string, value?: any, bubble?: boolean, fromLeaf?: boolean): Promise<boolean>

Parameters

Returns

true if the event was handled.

Remarks

Emits a named event for the current dialog, or someone who started it, to handle.

Inherited From DialogContext.emitEvent

Ends a dialog and pops it off the stack. Returns an optional result to the dialog's parent.

function endDialog(result?: any): Promise<DialogTurnResult>

Parameters

Returns

a promise resolving to the dialog turn result.

Remarks

The parent dialog is the next dialog on the dialog stack, if there is one. This method calls the parent's Dialog.resumeDialog method, passing the result returned by the ending dialog. If there is no parent dialog, the turn ends and the result is available to the bot through the returned object's result property.

The status of returned object describes the status of the dialog stack after this method completes.

Typically, you would call this from within the logic for a specific dialog to signal back to the dialog context that the dialog has completed, the dialog should be removed from the stack, and the parent dialog should resume.

For example:

return await dc.endDialog(returnValue);

See also

• beginDialog
• replaceDialog
• Dialog.endDialog

Inherited From DialogContext.endDialog

Searches for a dialog with a given ID.

function findDialog(dialogId: string): Dialog | undefined

Parameters

Returns

The dialog for the provided ID.

Remarks

If the dialog to start is not found in the DialogSet associated with this dialog context, it attempts to find the dialog in its parent dialog context.

See also

• dialogs
• parent

Inherited From DialogContext.findDialog

Obtain the CultureInfo in DialogContext.

function getLocale(): string

Returns

a locale string.

Inherited From DialogContext.getLocale

Helper function to simplify formatting the options for calling a prompt dialog.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult>

Parameters

Returns

Remarks

This helper method formats the object to use as the options parameter, and then calls beginDialog to start the specified prompt dialog.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

Inherited From DialogContext.prompt

Helper function to simplify formatting the options for calling a prompt dialog.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: string | Choice[]): Promise<DialogTurnResult>

Parameters

Returns

Remarks

This helper method formats the object to use as the options parameter, and then calls beginDialog to start the specified prompt dialog.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

Inherited From DialogContext.prompt

Ends the active dialog and starts a new dialog in its place.

function replaceDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parameters

Returns

a promise resolving to the dialog turn result.

Remarks

This is particularly useful for creating a loop or redirecting to another dialog.

The status of returned object describes the status of the dialog stack after this method completes.

This method is similar to ending the current dialog and immediately beginning the new one. However, the parent dialog is neither resumed nor otherwise notified.

See also

• beginDialog
• endDialog

Inherited From DialogContext.replaceDialog

Requests the active dialog to re-prompt the user for input.

function repromptDialog(): Promise<void>

Returns

Remarks

This calls the active dialog's repromptDialog method.

For example:

await dc.repromptDialog();

Inherited From DialogContext.repromptDialog