BeginSkill class

参考

包:: botbuilder-dialogs-adaptive

开始技能。

扩展: SkillDialog

构造函数

创建新的“BeginSkillDialog 实例”。

属性

$kind
activity	活动的模板。
activityProcessed	指示新对话是否应处理活动的值。
allowInterruptions	中断策略。
botId	将调用技能的Microsoft应用 ID。
connectionName	自选。父机器人的 OAuth 连接名称。
disabled	可选表达式（如果为 true）将禁用此操作。
resultProperty	用于存储对话框结果的可选属性路径。
skillAppId	技能的Microsoft应用 ID。
skillEndpoint	技能的 `/api/messages` 终结点。
skillHostEndpoint	技能主机的回调 URL。

继承属性

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

方法

beginDialog(DialogContext, BeginSkillDialogOptions)	启动对话框并将其推送到对话堆栈时调用。
continueDialog(DialogContext)	当对话继续时调用，该对话是活动对话，用户使用新活动进行答复。
endDialog(TurnContext, DialogInstance, DialogReason)	对话框结束时调用。
getConverter(Object)
repromptDialog(TurnContext, DialogInstance)	当对话框应重新提示用户输入时调用。
resumeDialog(DialogContext, DialogReason, any)	子对话框完成轮次时调用，将控件返回到此对话。

继承的方法

configure(Record<string, unknown>)	用于配置对象的 Fluent 方法。
getVersion()	用于帮助在重新部署时检测机器人更改的编码字符串。
onDialogEvent(DialogContext, DialogEvent)	通过使用当前对话或当前对话启动的对话，使用 `DialogContext.emitEvent()`引发事件时调用。

构造函数详细信息

BeginSkill(SkillDialogOptions)

创建新的“BeginSkillDialog 实例”。

new BeginSkill(options?: SkillDialogOptions)

参数

options: SkillDialogOptions

用于配置技能对话框的可选选项。

属性详细信息

$kind

static $kind: string

属性值

string

activity

活动的模板。

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

属性值

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

指示新对话是否应处理活动的值。

activityProcessed: BoolExpression

属性值

BoolExpression

注解

默认值为 true，这意味着新对话不应查看活动。可以将此项设置为 false 以将活动调度到新对话框。

allowInterruptions

中断策略。

allowInterruptions: BoolExpression

属性值

BoolExpression

botId

将调用技能的Microsoft应用 ID。

botId: StringExpression

属性值

StringExpression

注解

对从设置中检索机器人 ID 的 =settings.MicrosoftAppId 值进行反击。

connectionName

自选。父机器人的 OAuth 连接名称。

connectionName: StringExpression

属性值

StringExpression

disabled

可选表达式（如果为 true）将禁用此操作。

disabled?: BoolExpression

属性值

BoolExpression

resultProperty

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

resultProperty?: StringExpression

属性值

StringExpression

skillAppId

技能的Microsoft应用 ID。

skillAppId: StringExpression

属性值

StringExpression

skillEndpoint

技能的 /api/messages 终结点。

skillEndpoint: StringExpression

属性值

StringExpression

skillHostEndpoint

技能主机的回调 URL。

skillHostEndpoint: StringExpression

属性值

StringExpression

注解

对从设置中检索终结点的 =settings.SkillHostEndpoint 的值进行取消修改。

继承属性详细信息

EndOfTurn

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

static EndOfTurn: DialogTurnResult

属性值

DialogTurnResult

注解

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

继承自 Dialog.EndOfTurn

id

id: string

属性值

string

继承自 Dialog.id 的

telemetryClient

telemetryClient: BotTelemetryClient

属性值

BotTelemetryClient

继承自 Dialog.telemetryClient

方法详细信息

beginDialog(DialogContext, BeginSkillDialogOptions)

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

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

参数

dc: DialogContext

当前会话轮次的 DialogContext。

options: BeginSkillDialogOptions

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

Promise<DialogTurnResult>

表示异步操作的 Promise。

continueDialog(DialogContext)

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

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

参数

dc: DialogContext

当前会话轮次的 DialogContext。

Promise<DialogTurnResult>

表示异步操作的 Promise。

endDialog(TurnContext, DialogInstance, DialogReason)

对话框结束时调用。

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

参数

turnContext: TurnContext

（xref：botbuilder-core。TurnContext），此轮次的上下文对象。

instance: DialogInstance

（xref：botbuilder-dialogs.DialogInstance），与对话堆栈上此对话实例关联的状态信息。

reason: DialogReason

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

Promise<void>

表示异步操作的 Promise。

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

参数

property: Object

条件选择器配置的键。

Converter | ConverterFactory

选择器配置的转换器。

repromptDialog(TurnContext, DialogInstance)

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

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

参数

turnContext: TurnContext

（xref：botbuilder-core。TurnContext），此轮次的上下文对象。

instance: DialogInstance

（xref：botbuilder-dialogs.DialogInstance），此对话的状态信息。

Promise<void>

表示异步操作的 Promise。

resumeDialog(DialogContext, DialogReason, any)

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

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

参数

dc: DialogContext

当前会话轮次的 DialogContext。

reason: DialogReason

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

result: any

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

Promise<DialogTurnResult<any>>

表示异步操作的 Promise。

继承的方法详细信息

configure(Record<string, unknown>)

用于配置对象的 Fluent 方法。

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

参数

config: Record<string, unknown>

要应用的配置设置。

this

操作完成后可配置。

继承自 Configure.configure

getVersion()

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

function getVersion(): string

string

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

注解

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

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

继承自 Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

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

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

参数

dc: DialogContext

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

e: DialogEvent

正在引发的事件。

Promise<boolean>

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

继承自 Dialog.onDialogEvent