ActionScope class

包:

botbuilder-dialogs-adaptive

ActionScope 管理操作块的执行，并支持 Goto、Continue 和 Break 语义。

扩展

Dialog<O>

构造函数

ActionScope(Dialog[])

创建新的 ActionScope 实例。

属性

actions

要执行的操作。

继承属性

EndOfTurn	获取默认的轮次结束结果。
id
telemetryClient

方法

beginDialog(DialogContext, O)	启动 对话框 并将其推送到对话堆栈时调用。
continueDialog(DialogContext)	当 对话继续时调用，该对话是活动对话，用户使用新活动进行答复。
getConverter(Object)
getDependencies()	获取子 对话框 依赖项，以便可以将其添加到容器 Dialog 集。
getVersion()	获取表示此对话框版本的唯一 string。 如果对话框系统之间的版本更改将发出 DialogChanged 事件。
resumeDialog(DialogContext, DialogReason, any)	子 对话框 完成轮次时调用，将控件返回到此对话。

继承的方法

configure(Record<string, unknown>)	用于配置对象的 Fluent 方法。
endDialog(TurnContext, DialogInstance, DialogReason)	在派生类中重写时，在对话结束之前执行清理。
onDialogEvent(DialogContext, DialogEvent)	通过使用当前对话或当前对话启动的对话，使用 DialogContext.emitEvent()引发事件时调用。
repromptDialog(TurnContext, DialogInstance)	在派生类中重写时，将用户重新分配输入。

构造函数详细信息

ActionScope(Dialog[])

创建新的 ActionScope 实例。

new ActionScope(actions?: Dialog[])

参数

actions

Dialog[]

作用域的操作。

属性详细信息

actions

要执行的操作。

actions: Dialog[]

属性值

Dialog[]

继承属性详细信息

EndOfTurn

获取默认的轮次结束结果。

static EndOfTurn: DialogTurnResult

属性值

DialogTurnResult

注解

此结果指示对话（或对话中的逻辑步骤）已完成当前轮次的处理，仍然处于活动状态，并且正在等待更多输入。

继承自 Dialog.EndOfTurn

id

id: string

属性值

string

继承自 Dialog.id 的

telemetryClient

telemetryClient: BotTelemetryClient

属性值

BotTelemetryClient

继承自 Dialog.telemetryClient

方法详细信息

beginDialog(DialogContext, O)

启动 对话框 并将其推送到对话堆栈时调用。

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

参数

dc

DialogContext

当前会话轮次的 DialogContext。

_options

O

自选。 要传递给对话的初始信息。

返回

Promise<DialogTurnResult>

表示异步操作的 Promise。

continueDialog(DialogContext)

当 对话继续时调用，该对话是活动对话，用户使用新活动进行答复。

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

参数

dc

DialogContext

当前会话轮次的 DialogContext。

返回

Promise<DialogTurnResult>

表示异步操作的 Promise。

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

参数

property

Object

条件选择器配置的键。

返回

Converter | ConverterFactory

选择器配置的转换器。

getDependencies()

获取子 对话框 依赖项，以便可以将其添加到容器 Dialog 集。

function getDependencies(): Dialog[]

返回

Dialog[]

子 对话框 依赖项。

getVersion()

获取表示此对话框版本的唯一 string。 如果对话框系统之间的版本更改将发出 DialogChanged 事件。

function getVersion(): string

返回

string

唯一 string 仅当对话发生更改时，才会更改对话框。

resumeDialog(DialogContext, DialogReason, any)

子 对话框 完成轮次时调用，将控件返回到此对话。

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

参数

dc

DialogContext

当前会话轮次的 DialogContext。

_reason

DialogReason

（xref：botbuilder-dialogs.DialogReason），对话恢复的原因。

result

any

自选。 从调用的对话框返回的值。 返回的值的类型取决于子对话。

返回

Promise<DialogTurnResult>

表示异步操作的 Promise。

继承的方法详细信息

configure(Record<string, unknown>)

用于配置对象的 Fluent 方法。

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

参数

config

Record<string, unknown>

要应用的配置设置。

返回

this

操作完成后 可配置。

继承自 Configure.configure

endDialog(TurnContext, DialogInstance, DialogReason)

在派生类中重写时，在对话结束之前执行清理。

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

参数

_context

TurnContext

轮次的上下文对象。

_instance

DialogInstance

此对话框的当前状态信息。

_reason

DialogReason

对话结束的原因。

返回

Promise<void>

注解

在结束之前需要执行日志记录或清理的派生对话应重写此方法。 默认情况下，此方法不起作用。

当当前对话结束时，DialogContext 调用此方法。

另请参阅

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

继承自 Dialog.endDialog

onDialogEvent(DialogContext, DialogEvent)

通过使用当前对话或当前对话启动的对话，使用 DialogContext.emitEvent()引发事件时调用。

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

参数

dc

DialogContext

当前对话轮次的对话上下文。

e

DialogEvent

正在引发的事件。

返回

Promise<boolean>

如此 如果事件由当前对话框处理，并且冒泡应停止。

继承自 Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

在派生类中重写时，将用户重新分配输入。

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

参数

_context

TurnContext

轮次的上下文对象。

_instance

DialogInstance

此对话框的当前状态信息。

返回

Promise<void>

注解

支持验证和重新提示逻辑的派生对话应重写此方法。 默认情况下，此方法不起作用。

DialogContext 在当前对话应从用户重新请求输入时调用此方法。 此方法是针对提示对话实现的。

另请参阅

• DialogContext.repromptDialog
• 提示

继承自 Dialog.repromptDialog