ComponentDialog class

Creates a new instance of the Dialog class.

new ComponentDialog(dialogId?: string)

Parameters

Unique ID of the dialog.

string id

Property Value

The Id for the dialog.

The containers dialog set.

dialogs: DialogSet

Property Value

Inherited From DialogContainer.dialogs

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.

Inherited From DialogContainer.EndOfTurn

Adds a child Dialog or prompt to the components internal DialogSet.

function addDialog(dialog: Dialog<{}>): ComponentDialog<O>

Parameters

Returns

The ComponentDialog after the operation is complete.

Remarks

The Dialog.id of the first child added to the component will be assigned to the initialDialogId property.

Called when the dialog is started and pushed onto the parent's dialog stack. By default, this calls the Dialog.BeginDialogAsync(DialogContext, object, CancellationToken) method of the component dialog's initial dialog, as defined by InitialDialogId. Override this method in a derived class to implement interrupt logic.

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

Parameters

Returns

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.

Called when the dialog is continued, where it is the active dialog and the user replies with a new Activity. If this method is not overridden, the dialog automatically ends when the user replies.

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

Parameters

Returns

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.

Creates the inner dialog context

function createChildContext(outerDialogContext: DialogContext): DialogContext

Parameters

Returns

The created Dialog Context.

Called when the Dialog is ending.

function endDialog(context: TurnContext, instance: DialogInstance<any>, reason: DialogReason): Promise<void>

Parameters

Returns

A Promise representing the asynchronous operation.

Remarks

When this method is called from the parent dialog's context, the component Dialog cancels all of the dialogs on its inner dialog stack before ending.

Called when the dialog should re-prompt the user for input.

function repromptDialog(context: TurnContext, instance: DialogInstance<any>): Promise<void>

Parameters

Returns

A Promise representing the asynchronous operation.

Called when a child dialog on the parent's dialog stack completed this turn, returning control to this dialog component.

function resumeDialog(outerDialogContext: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult<any>>

Parameters

Returns

A Promise representing the asynchronous operation.

Remarks

If the task is successful, the result indicates whether this dialog is still active after this dialog turn has been processed. Generally, the child dialog was started with a call to beginDialog(DialogContext, object) in the parent's context. However, if the DialogContext.replaceDialog(string, object) method is called, the logical child dialog may be different than the original. If this method is not overridden, the dialog automatically calls its RepromptDialog(ITurnContext, DialogInstance) when the user replies.

Fluent method for configuring the object.

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

Parameters

Returns

The Configurable after the operation is complete.

Inherited From DialogContainer.configure

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

function findDialog(dialogId: string): undefined | Dialog<{}>

Parameters

Returns

The Dialog if found; otherwise null.

Inherited From DialogContainer.findDialog

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 DialogContainer.getConverter

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.

Inherited From DialogContainer.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(dialogContext: DialogContext, event: DialogEvent): Promise<boolean>

Parameters

Returns

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

Inherited From DialogContainer.onDialogEvent