AdaptiveDialog class

Creates a new AdaptiveDialog instance.

new AdaptiveDialog(dialogId?: string)

Parameters

static $kind: string

Property Value

Whether to end the dialog when there are no actions to execute.

autoEndDialog: BoolExpression

Property Value

Remarks

If true, when there are no actions to execute, the current dialog will end. If false, when there are no actions to execute, the current dialog will simply end the turn and still be active. Defaults to a value of true.

static conditionTracker: string

Property Value

The property to return as the result when the dialog ends when there are no more Actions and AutoEndDialog = true.

defaultResultProperty: string

Property Value

Remarks

Defaults to a value of dialog.result.

Optional. Language Generator override.

generator?: LanguageGenerator

Property Value

Optional. Recognizer used to analyze any message utterances.

recognizer?: Recognizer

Property Value

Sets the JSON Schema for the dialog. Gets the JSON Schema for the dialog.

object schema

Property Value

The dialog schema.

Optional. The selector for picking the possible events to execute.

selector: TriggerSelector

Property Value

Trigger handlers to respond to conditions which modify the executing plan.

triggers: OnCondition[]

Property Value

The containers dialog set.

dialogs: DialogSet

Property Value

Inherited From DialogContainer.dialogs

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

telemetryClient: BotTelemetryClient

Property Value

Inherited From DialogContainer.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.

Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.

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

Parameters

Returns

A Promise representing the asynchronous operation.

Creates a child DialogContext for the given context.

function createChildContext(dc: DialogContext): DialogContext

Parameters

Returns

The child DialogContext or null if no AdaptiveDialogState.actions are found for the given context.

Called when the dialog is ending.

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

Parameters

Returns

A Promise representing the asynchronous operation.

function getConverter(property: Object): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

Gets Dialog enumerated dependencies.

function getDependencies(): Dialog[]

Returns

(xref:botbuilder-dialogs.Dialog)'s enumerated dependencies.

Reprompts the user.

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

Parameters

Returns

A Promise representing the asynchronous operation.

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

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.

Inherited From DialogContainer.findDialog

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