Class WaterfallStepContext<O>

context

dialogs

parent

services

stack

state

activeDialog

• get activeDialog(): DialogInstance<any>

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

  Returns DialogInstance<any>

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

child

• get child(): DialogContext

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

  Returns DialogContext

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

dialogManager

• get dialogManager(): DialogManager

  Gets the current dialog manager instance.

  Returns DialogManager

  The current dialog manager instance.

beginDialog

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

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

  Parameters

  • dialogId: string

    ID of the dialog to start.

  • Optionaloptions: object

    Optional. Arguments to pass into the dialog when it starts.

  Returns Promise<DialogTurnResult<any>>

  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 DialogTurnResult.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.

cancelAllDialogs

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

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

  Parameters

  • cancelParents: boolean = false

    Optional. If true all parent dialogs will be cancelled as well.

  • OptionaleventName: string

    Optional. Name of a custom event to raise as dialogs are cancelled. This defaults to DialogEvents.cancelDialog.

  • OptionaleventValue: any

    Optional. Value to pass along with custom cancellation event.

  Returns Promise<DialogTurnResult<any>>

  a promise resolving to the dialog turn result.

  Remarks

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

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

continueDialog

• continueDialog(): Promise<DialogTurnResult<any>>

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

  Returns Promise<DialogTurnResult<any>>

  a promise resolving to the dialog turn result.

  Remarks

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

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

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

emitEvent

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

  Searches for a dialog with a given ID.

  Parameters

  • name: string

    Name of the event to raise.

  • Optionalvalue: any

    Optional. Value to send along with the event.

  • bubble: boolean = true

    Optional. Flag to control whether the event should be bubbled to its parent if not handled locally. Defaults to a value of true.

  • fromLeaf: boolean = false

    Optional. Whether the event is emitted from a leaf node.

  Returns Promise<boolean>

  true if the event was handled.

  Remarks

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

endDialog

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

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

  Parameters

  • Optionalresult: any

    Optional. A result to pass to the parent logic. This might be the next dialog on the stack, or if this was the last dialog on the stack, a parent dialog context or the agent's turn handler.

  Returns Promise<DialogTurnResult<any>>

  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 agent through the returned object's DialogTurnResult.result property.

  The DialogTurnResult.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.

findDialog

• findDialog(dialogId: string): Dialog<{}>

  Searches for a dialog with a given ID.

  Parameters

  • dialogId: string

    ID of the dialog to search for.

  Returns Dialog<{}>

  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.

getLocale

• getLocale(): string

  Obtain the CultureInfo in DialogContext.

  Returns string

  a locale string.

prompt

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

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

  Parameters

  • dialogId: string

    ID of the prompt dialog to start.

  • promptOrOptions: string | PromptOptions | Partial<Activity>

    The text of the initial prompt to send the user, the activity to send as the initial prompt, or the object with which to format the prompt dialog.

  Returns Promise<DialogTurnResult<any>>

  Remarks

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

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

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

  Parameters

  • dialogId: string

    ID of the prompt dialog to start.

  • promptOrOptions: string | PromptOptions | Partial<Activity>

    The text of the initial prompt to send the user, the Activity to send as the initial prompt, or the object with which to format the prompt dialog.

  • choices: (string | Choice)[]

    Optional. Array of choices for the user to choose from, for use with a ChoicePrompt.

  Returns Promise<DialogTurnResult<any>>

  Remarks

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

replaceDialog

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

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

  Parameters

  • dialogId: string

    ID of the dialog to start.

  • Optionaloptions: object

    Optional. Arguments to pass into the new dialog when it starts.

  Returns Promise<DialogTurnResult<any>>

  a promise resolving to the dialog turn result.

  Remarks

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

  The DialogTurnResult.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.

repromptDialog

• repromptDialog(): Promise<void>

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

  Returns Promise<void>

  Remarks

  This calls the active dialog's Dialog.repromptDialog method.