ActionScope class

Creates a new ActionScope instance.

new ActionScope(actions?: Dialog[])

Parameters

The actions to execute.

actions: Dialog[]

Property Value

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

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.

function getConverter(property: Object): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

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

function getDependencies(): Dialog[]

Returns

The child Dialog dependencies.

Gets a unique string which represents the version of this dialog. If the version changes between turns the dialog system will emit a DialogChanged event.

function getVersion(): string

Returns

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

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, 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

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