BeginDialog class

创建新的 BeginDialog 实例。

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

参数

static $kind: string

属性值

如果为 true，则为 true 的可选表达式将禁用此操作。

disabled?: BoolExpression

属性值

（可选）用于存储对话框结果的属性路径。

resultProperty?: StringExpression

属性值

一个值，该值指示是否应让新对话处理活动。

activityProcessed: BoolExpression

属性值

继承自baseInvokeDialog.activityProcessed

要调用的对话。

dialog: DialogExpression

属性值

继承自baseInvokeDialog.dialog

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

static EndOfTurn: DialogTurnResult

属性值

注解

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

继承自 Dialog.EndOfTurn

id: string

属性值

继承自 Dialog.id 的

对话框的可配置选项。

options: ObjectExpression<object>

属性值

继承自baseInvokeDialog.options

telemetryClient: BotTelemetryClient

属性值

继承自 Dialog.telemetryClient

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

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

参数

返回

表示异步操作的 Promise。

function getConverter(property: Object): Converter | ConverterFactory

参数

返回

选择器配置的转换器。

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

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

参数

返回

表示异步操作的 Promise。

用于配置对象的 Fluent 方法。

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

参数

返回

操作完成后 可配置。

继承自 Configure.configure

在派生类中重写时，继续对话。

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

参数

返回

解析为对话框轮次结果的承诺。

注解

支持多轮对话的派生对话应重写此方法。 默认情况下，此方法指示对话框已完成并返回。

DialogContext 在继续对话时调用此方法。

若要向对话上下文发出信号，表明此对话已完成，请等待 DialogContext.endDialog 退出此方法。

另请参阅

• DialogContext.continueDialog

继承自 Dialog.continueDialog

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

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

参数

返回

注解

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

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

另请参阅

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

继承自 Dialog.endDialog

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

function getDependencies(): Dialog<__type>[]

返回

子 对话框 依赖项。

继承自baseInvokeDialog.getDependencies

用于帮助在重新部署时检测机器人更改的编码字符串。

function getVersion(): string

返回

唯一字符串，仅当对话发生更改时，才应以重启对话框的方式更改。

注解

这默认返回对话 ID，但可以重写以提供更精确的更改检测逻辑。 堆栈上具有其版本更改的任何对话框都将导致引发 versionChanged 事件。 如果机器人未处理此事件，将引发错误，从而导致运行机器人错误处理程序逻辑。

返回空字符串将一起禁用组件的版本跟踪。

继承自 Dialog.getVersion

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

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

参数

返回

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

继承自 Dialog.onDialogEvent

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

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

参数

返回

注解

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

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

另请参阅

• DialogContext.repromptDialog
• 提示

继承自 Dialog.repromptDialog