Share via

WaterfallStepInfo interface

Package:
@microsoft/agents-hosting-dialogs

Values passed to the WaterfallStepContext constructor.

Properties

index

The index of the current step in the waterfall dialog.
options

The options passed to the waterfall dialog when it was started.
reason

The reason the current step is being executed.
result

The result returned by the previous step or dialog.
values

A dictionary of values shared across all steps in the waterfall dialog.

Methods

onNext(any)

A function to proceed to the next step in the waterfall dialog.

Property Details

index

The index of the current step in the waterfall dialog.

index: number

Property Value

number

options

The options passed to the waterfall dialog when it was started.

options: O

Property Value

O

reason

The reason the current step is being executed.

reason: DialogReason

Property Value

DialogReason

result

The result returned by the previous step or dialog.

result: any

Property Value

any

values

A dictionary of values shared across all steps in the waterfall dialog.

values: object

Property Value

object

Method Details

onNext(any)

A function to proceed to the next step in the waterfall dialog.

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

Parameters

result

any

Optional result to pass to the next step.

Returns

Promise<DialogTurnResult<any>>

A promise resolving to the result of the next dialog turn.