Class WaterfallDialog<O>

A waterfall is a dialog that's optimized for prompting a user with a series of questions.

Type Parameters

O extends object = {}

Hierarchy (View Summary)

Dialog<O>
- WaterfallDialog

Index

Constructors

constructor

Properties

EndOfTurn

Accessors

Methods

addStep beginDialog configure continueDialog endDialog getConverter getVersion onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent onStep repromptDialog resumeDialog runStep

Constructors

constructor

new WaterfallDialog<O extends object = {}>(
dialogId: string,
steps?: WaterfallStep<O>[],
): WaterfallDialog<O>
Creates a new waterfall dialog containing the given array of steps.
Type Parameters
- O extends object = {}
Parameters
- dialogId: string
  Unique ID of the dialog within the component or set its being added to.
- Optionalsteps: WaterfallStep<O>[]
  (Optional) array of asynchronous waterfall step functions.
Returns WaterfallDialog<O>
Remarks
See the addStep function for details on creating a valid step function.
Overrides Dialog.constructor
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:39

Properties

`Static`EndOfTurn

EndOfTurn: DialogTurnResult = ...

Gets a default end-of-turn result.

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.

Accessors

id

get id(): string
Unique ID of the dialog.

Returns string
The Id for the dialog.

Remarks
This will be automatically generated if not specified.
Inherited from Dialog.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:49
set id(value: string): void
Sets the unique ID of the dialog.
Parameters
- value: string
Returns void
Inherited from Dialog.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:59

Methods

addStep

addStep(step: WaterfallStep<O>): this
Adds a new step to the waterfall.
Parameters
- step: WaterfallStep<O>
  Asynchronous step function to call.
Returns this
Waterfall dialog for fluent calls to addStep().
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:64

beginDialog

beginDialog(
dialogContext: DialogContext,
options?: O,
): Promise<DialogTurnResult<any>>
Called when the WaterfallDialog is started and pushed onto the dialog stack.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of conversation.
- Optionaloptions: O
  Optional, initial information to pass to the Dialog.
Returns Promise<DialogTurnResult<any>>
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.
Overrides Dialog.beginDialog
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:82

configure

configure(config: Record<string, unknown>): this
Fluent method for configuring the object.
Parameters
- config: Record<string, unknown>
  Configuration settings to apply.
Returns this
The Configurable after the operation is complete.
Inherited from Dialog.configure
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:18

continueDialog

continueDialog(dialogContext: DialogContext): Promise<DialogTurnResult<any>>
Called when the WaterfallDialog is continued, where it is the active dialog and the user replies with a new Activity.
Parameters
- dialogContext: DialogContext
  The DialogContext for the current turn of conversation.
Returns Promise<DialogTurnResult<any>>
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.
Overrides Dialog.continueDialog
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:106

endDialog

endDialog(
    _context: TurnContext,
    _instance: DialogInstance,
    _reason: DialogReason,
): Promise<void>
When overridden in a derived class, performs clean up for the dialog before it ends.
Parameters
- _context: TurnContext
  The context object for the turn.
- _instance: DialogInstance
  Current state information for this dialog.
- _reason: DialogReason
  The reason the dialog is ending.
Returns Promise<void>
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
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:181

getConverter

getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory
Gets the converter for the selector configuration. *
Parameters
- _property: string
  The key of the conditional selector configuration. *
Returns Converter<unknown, unknown> | ConverterFactory
The converter for the selector configuration.
Inherited from Dialog.getConverter
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:53

getVersion

getVersion(): string
Gets the dialog version, composed of the ID and number of steps.

Returns string
Dialog version, composed of the ID and number of steps.
Overrides Dialog.getVersion
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:52

`Protected`onComputeId

onComputeId(): string
Called when a unique ID needs to be computed for a dialog.

Returns string
Remarks
SHOULD be overridden to provide a more contextually relevant ID. The preferred pattern for ID's is <dialog type>(this.hashedLabel('<dialog args>')).
Inherited from Dialog.onComputeId
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:248

onDialogEvent

onDialogEvent(
dialogContext: DialogContext,
event: DialogEvent,
): Promise<boolean>
Called when an event has been raised, using DialogContext.emitEvent method , by either the current dialog or a dialog that the current dialog started.
Parameters
- dialogContext: DialogContext
  The dialog context for the current turn of conversation.
- event: DialogEvent
  The event being raised.
Returns Promise<boolean>
True if the event is handled by the current dialog and bubbling should stop.
Inherited from Dialog.onDialogEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:193

`Protected`onPostBubbleEvent

onPostBubbleEvent(_dc: DialogContext, _e: DialogEvent): Promise<boolean>
Called after an event was bubbled to all parents and wasn't handled.
Parameters
- _dc: DialogContext
  The dialog context for the current turn of conversation.
- _e: DialogEvent
  The event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform default processing logic for an event. Returning true will prevent any processing of the event by child dialogs.
Inherited from Dialog.onPostBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:237

`Protected`onPreBubbleEvent

onPreBubbleEvent(_dc: DialogContext, _e: DialogEvent): Promise<boolean>
Called before an event is bubbled to its parent.
Parameters
- _dc: DialogContext
  The dialog context for the current turn of conversation.
- _e: DialogEvent
  The event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform interception of an event as returning true will prevent any further bubbling of the event to the dialogs parents and will also prevent any child dialogs from performing their default processing.
Inherited from Dialog.onPreBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:222

`Protected`onStep

onStep(step: WaterfallStepContext<O>): Promise<DialogTurnResult<any>>
Called when an individual waterfall step is being executed.
Parameters
- step: WaterfallStepContext<O>
  Context object for the waterfall step to execute.
Returns Promise<DialogTurnResult<any>>
A promise with the DialogTurnResult.

Remarks
SHOULD be overridden by derived class that want to add custom logging semantics.
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:142

repromptDialog

repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>
When overridden in a derived class, prompts the user again for input.
Parameters
- _context: TurnContext
  The context object for the turn.
- _instance: DialogInstance
  Current state information for this dialog.
Returns Promise<void>
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
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:162

resumeDialog

resumeDialog(
    dc: DialogContext,
    reason: DialogReason,
    result?: any,
): Promise<DialogTurnResult<any>>
Called when a child WaterfallDialog completed its turn, returning control to this dialog.
Parameters
- dc: DialogContext
  The DialogContext for the current turn of the conversation.
- reason: DialogReason
  DialogReason why the dialog resumed.
- Optionalresult: any
  Optional, value returned from the dialog that was called. The type of the value returned is dependent on the child dialog.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.
Overrides Dialog.resumeDialog
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:125

`Protected`runStep

runStep(
    dc: DialogContext,
    index: number,
    reason: DialogReason,
    result?: any,
): Promise<DialogTurnResult<any>>
Executes a step of the WaterfallDialog.
Parameters
- dc: DialogContext
  The DialogContext for the current turn of conversation.
- index: number
  The index of the current waterfall step to execute.
- reason: DialogReason
  The DialogReason the waterfall step is being executed.
- Optionalresult: any
  Optional, result returned by a dialog called in the previous waterfall step.
Returns Promise<DialogTurnResult<any>>
A Promise that represents the work queued to execute.
- Defined in packages/agents-hosting-dialogs/src/waterfallDialog.ts:155

Class WaterfallDialog<O>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WaterfallDialog<O>

Remarks

Properties

StaticEndOfTurn

Remarks

Accessors

id

Returns string

Remarks

Parameters

Returns void

Methods

addStep

Parameters

Returns this

beginDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

configure

Parameters

Returns this

continueDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

endDialog

Parameters

Returns Promise<void>

Remarks

getConverter

Parameters

Returns Converter<unknown, unknown> | ConverterFactory

getVersion

Returns string

ProtectedonComputeId

Returns string

Remarks

onDialogEvent

Parameters

Returns Promise<boolean>

ProtectedonPostBubbleEvent

Parameters

Returns Promise<boolean>

Remarks

ProtectedonPreBubbleEvent

Parameters

Returns Promise<boolean>

Remarks

ProtectedonStep

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

repromptDialog

Parameters

Returns Promise<void>

Remarks

resumeDialog

Parameters

Returns Promise<DialogTurnResult<any>>

ProtectedrunStep

Parameters

Returns Promise<DialogTurnResult<any>>

Settings

On This Page

`Static`EndOfTurn

`Protected`onComputeId

`Protected`onPostBubbleEvent

`Protected`onPreBubbleEvent

`Protected`onStep

`Protected`runStep