WaterfallStepInfo interface

Package:

botbuilder-dialogs

Values passed to the WaterfallStepContext constructor.

Properties

index	The index of the current waterfall step being executed.
options	Any options passed to the steps waterfall dialog when it was started with DialogContext.beginDialog().
reason	The reason the waterfall step is being executed.
result	Results returned by a dialog or prompt that was called in the previous waterfall step.
values	A dictionary of values which will be persisted across all waterfall steps.

Methods

onNext(any)

Called to skip to the next waterfall step.

Property Details

index

The index of the current waterfall step being executed.

index: number

Property Value

number

options

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

options: O

Property Value

O

reason

The reason the waterfall step is being executed.

reason: DialogReason

Property Value

DialogReason

result

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

result: any

Property Value

any

values

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

values: object

Property Value

object

Method Details

onNext(any)

Called to skip to the next waterfall step.

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

Parameters

result

any

(Optional) result to pass to the next step.

Returns

Promise<DialogTurnResult>