SkillDialog class

一个示例对话框，可以包装对技能的远程调用。

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

参数

注解

beginDialog() 中的 options 参数必须是具有对话框初始参数的 SkillDialogArgs 对象。

对话框的唯一 ID。 设置对话框的唯一 ID。

string id

属性值

对话框的 ID。

注解

如果未指定，则会自动生成此代码。

获取此对话框的遥测客户端。 设置此对话框的遥测客户端。

BotTelemetryClient telemetryClient

属性值

要用于日志记录的 BotTelemetryClient。

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

static EndOfTurn: DialogTurnResult

属性值

注解

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

继承自Dialog.EndOfTurn

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

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

参数

返回

表示异步操作的 Promise。

注解

如果任务成功，则结果指示对话在对话框处理轮次后是否仍然处于活动状态。

当技能对话 继续时调用，其中活动对话是活动对话，用户使用新的 活动进行答复。

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

参数

返回

表示异步操作的 Promise。

注解

如果任务成功，则结果指示对话在对话框处理轮次后是否仍然处于活动状态。 结果还可能包含返回值。

技能对话结束时调用。

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

参数

返回

表示异步操作的 Promise。

当技能对话框应重新提示用户输入时调用。

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

参数

返回

表示异步操作的 Promise。

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

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

参数

返回

表示异步操作的 Promise。

用于配置对象的 Fluent 方法。

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

参数

返回

操作完成后 可配置。

继承自Configure.configure

function getConverter(_property: string): Converter | ConverterFactory

参数

返回

选择器配置的转换器。

继承自Configurable.getConverter

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

function getVersion(): string

返回

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

注解

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

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

继承自Dialog.getVersion

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

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

参数

返回

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

继承自Dialog.onDialogEvent