Dialog class

Creates a new instance of the Dialog class.

new Dialog(dialogId?: string)

Parameters

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult<any>

Property Value

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.

Unique ID of the dialog.

string id

Property Value

The Id for the dialog.

When overridden in a derived class, starts the dialog.

function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult<any>>

Parameters

Returns

Remarks

Derived dialogs must override this method.

The DialogContext calls this method when it creates a new DialogInstance for this dialog, pushes it onto the dialog stack, and starts the dialog.

A dialog that represents a single-turn conversation should await endDialog before exiting this method.

When overridden in a derived class, continues the dialog.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult<any>>

Parameters

Returns

A promise resolving to the dialog turn result.

Remarks

Derived dialogs that support multiple-turn conversations should override this method. By default, this method signals that the dialog is complete and returns.

The DialogContext calls this method when it continues the dialog.

To signal to the dialog context that this dialog has completed, await endDialog before exiting this method.

When overridden in a derived class, performs clean up for the dialog before it ends.

function endDialog(_context: TurnContext, _instance: DialogInstance<any>, _reason: DialogReason): Promise<void>

Parameters

Returns

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.

An encoded string used to aid in the detection of agent changes on re-deployment.

function getVersion(): string

Returns

Unique string which should only change when dialog has changed in a way that should restart the dialog.

Remarks

This defaults to returning the dialog's id but can be overridden to provide more precise change detection logic. Any dialog on the stack that has its version change will result in a versionChanged event will be raised. If this event is not handled by the agent, an error will be thrown resulting in the agent error handler logic being run.

Returning an empty string will disable version tracking for the component all together.

Called when an event has been raised, using DialogContext.emitEvent method, by either the current dialog or a dialog that the current dialog started.

function onDialogEvent(dialogContext: DialogContext, event: DialogEvent): Promise<boolean>

Parameters

Returns

True if the event is handled by the current dialog and bubbling should stop.

When overridden in a derived class, prompts the user again for input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance<any>): Promise<void>

Parameters

Returns

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.

When overridden in a derived class, resumes the dialog after the dialog above it on the stack completes.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

Parameters

Returns

A promise resolving to the dialog turn result.

Remarks

Derived dialogs that support multiple-turn conversations should override this method. By default, this method signals that the dialog is complete and returns.

The DialogContext calls this method when it resumes the dialog. If the previous dialog on the stack returned a value, that value is in the result parameter.

To start a child dialog, use beginDialog or prompt; however, this dialog will not necessarily be the one that started the child dialog. To signal to the dialog context that this dialog has completed, await endDialog before exiting this method.

Fluent method for configuring the object.

function configure(config: Record<string, unknown>): Dialog<O>

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Configurable.configure

Gets the converter for the selector configuration. *

function getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory<unknown, unknown>

Parameters

Returns

The converter for the selector configuration.

Inherited From Configurable.getConverter