BeginDialog class

Creates a new BeginDialog instance.

new BeginDialog(dialogIdToCall: string, options?: O)

Parameters

static $kind: string

Property Value

An optional expression which if is true will disable this action.

disabled?: BoolExpression

Property Value

(Optional) property path to store the dialog result in.

resultProperty?: StringExpression

Property Value

A value indicating whether to have the new dialog should process the activity.

activityProcessed: BoolExpression

Property Value

Inherited From BaseInvokeDialog.activityProcessed

The dialog to call.

dialog: DialogExpression

Property Value

Inherited From BaseInvokeDialog.dialog

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

id: string

Property Value

Inherited From Dialog.id

Configurable options for the dialog.

options: ObjectExpression<object>

Property Value

Inherited From BaseInvokeDialog.options

telemetryClient: BotTelemetryClient

Property Value

Inherited From Dialog.telemetryClient

Called when the Dialog is started and pushed onto the dialog stack.

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

Parameters

Returns

A Promise representing the asynchronous operation.

function getConverter(property: Object): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

Called when a child Dialog completed its turn, returning control to this dialog.

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

Parameters

Returns

A Promise representing the asynchronous operation.

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

Gets the child Dialog dependencies so they can be added to the containers Dialog set.

function getDependencies(): Dialog<__type>[]

Returns

The child Dialog dependencies.

Inherited From BaseInvokeDialog.getDependencies

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

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.

Inherited From Dialog.onDialogEvent

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