DialogContainer class

Creates a new instance of the Dialog class.

new DialogContainer(dialogId?: string)

Parameters

The containers dialog set.

dialogs: DialogSet

Property Value

Unique ID of the dialog. Sets the unique ID of the dialog.

string id

Property Value

The Id for the dialog.

Remarks

This will be automatically generated if not specified.

Set the telemetry client, and also apply it to all child dialogs. Future dialogs added to the component will also inherit this client. Get the current telemetry client.

BotTelemetryClient telemetryClient

Property Value

The BotTelemetryClient to use for logging.

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult

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.

Inherited From Dialog.EndOfTurn

Creates an inner dialog context for the containers active child.

function createChildContext(dc: DialogContext): DialogContext | undefined

Parameters

Returns

A new dialog context for the active child or undefined if there is no active child.

Finds a child dialog that was previously added to the container.

function findDialog(dialogId: string): Dialog | undefined

Parameters

Returns

The Dialog if found; otherwise null.

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

function onDialogEvent(dc: DialogContext, e: 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, starts the dialog.

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

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 DialogContext.endDialog before exiting this method.

See also

• DialogContext.beginDialog
• DialogContext.replaceDialog

Inherited From Dialog.beginDialog

Fluent method for configuring the object.

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

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Configurable.configure

When overridden in a derived class, continues the dialog.

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

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 DialogContext.endDialog before exiting this method.

See also

• DialogContext.continueDialog

Inherited From Dialog.continueDialog

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

function endDialog(_context: TurnContext, _instance: DialogInstance, _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.

See also

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

Inherited From Dialog.endDialog

function getConverter(_property: string): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

Inherited From Configurable.getConverter

An encoded string used to aid in the detection of bot 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 dialogs 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 bot, an error will be thrown resulting in the bots error handler logic being run.

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

Inherited From Dialog.getVersion

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

function repromptDialog(_context: TurnContext, _instance: DialogInstance): 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.

See also

• DialogContext.repromptDialog
• Prompt

Inherited From Dialog.repromptDialog

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>

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 DialogContext.beginDialog or DialogContext.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 DialogContext.endDialog before exiting this method.

See also

• DialogContext.endDialog

Inherited From Dialog.resumeDialog