Prompt class
所有提示的基类。
- Extends
属性
id | 对话的唯一 ID。 设置对话的唯一 ID。 |
telemetry |
获取此对话框的遥测客户端。 设置此对话框的遥测客户端。 |
继承属性
End |
获取默认的轮次结束结果。 |
方法
begin |
在将提示对话框推送到对话堆栈并被激活时调用。 |
continue |
当提示对话为活动对话且用户使用新活动进行回复时调用。 |
reprompt |
请求提示对话框以重新提示用户输入时调用。 |
resume |
当提示对话恢复为对话堆栈上的活动对话时调用,例如当堆栈上的上一个活动对话完成时调用。 |
继承的方法
configure(Record<string, unknown>) | 用于配置 对象的 Fluent 方法。 |
end |
在派生类中重写时,在对话结束之前对对话执行清理。 |
get |
|
get |
一个编码字符串,用于帮助在重新部署时检测机器人更改。 |
on |
在引发事件时调用,使用 |
属性详细信息
id
对话的唯一 ID。 设置对话的唯一 ID。
string id
属性值
string
对话框的 ID。
注解
如果未指定,将自动生成此参数。
telemetryClient
获取此对话框的遥测客户端。 设置此对话框的遥测客户端。
BotTelemetryClient telemetryClient
属性值
BotTelemetryClient
用于日志记录 的 BotTelemetryClient 。
继承属性详细信息
EndOfTurn
获取默认的轮次结束结果。
static EndOfTurn: DialogTurnResult
属性值
注解
此结果指示对话 (或对话中的逻辑步骤) 已完成当前轮次的处理,仍处于活动状态,并且正在等待更多输入。
方法详细信息
beginDialog(DialogContext, PromptOptions)
在将提示对话框推送到对话堆栈并被激活时调用。
function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>
参数
对话当前轮次的 DialogContext 。
- options
- PromptOptions
可选。 PromptOptions,要传递给正在启动的提示的其他信息。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise
。
注解
如果任务成功,则结果指示提示在提示处理轮次后是否仍然处于活动状态。
continueDialog(DialogContext)
当提示对话为活动对话且用户使用新活动进行回复时调用。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
参数
对话当前轮次的 DialogContext 。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise
。
注解
如果任务成功,则结果指示对话在对话处理轮次后是否仍然处于活动状态。 提示通常会继续接收用户的回复,直到它接受用户的回复作为提示的有效输入。
repromptDialog(TurnContext, DialogInstance)
请求提示对话框以重新提示用户输入时调用。
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>
参数
- context
-
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>
参数
对话当前轮次的 DialogContext。
- _reason
- DialogReason
一个枚举,指示对话恢复的原因。
- _result
-
any
(可选)从堆栈上一个对话框返回的值。 返回的值的类型取决于上一个对话框。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise。
注解
如果任务成功,则结果指示对话在对话处理轮次后是否仍然处于活动状态。
继承的方法详细信息
configure(Record<string, unknown>)
用于配置 对象的 Fluent 方法。
function configure(config: Record<string, unknown>): this
参数
- config
-
Record<string, unknown>
要应用的配置设置。
返回
this
endDialog(TurnContext, DialogInstance, DialogReason)
在派生类中重写时,在对话结束之前对对话执行清理。
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>
参数
- _context
-
TurnContext
轮次的上下文对象。
- _instance
- DialogInstance
此对话框的当前状态信息。
- _reason
- DialogReason
对话结束的原因。
返回
Promise<void>
注解
需要在结束前执行日志记录或清理的派生对话应替代此方法。 默认情况下,此方法不起作用。
当当前对话结束时, DialogContext 将调用此方法。
另请参阅
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactory
参数
- _property
-
string
条件选择器配置的键。
返回
选择器配置的转换器。
getVersion()
一个编码字符串,用于帮助在重新部署时检测机器人更改。
function getVersion(): string
返回
string
唯一字符串,仅当对话已以应重启对话框的方式更改时才应更改。
注解
这默认返回对话 ID ,但可以重写以提供更精确的更改检测逻辑。 堆栈上具有其版本更改的任何对话都将导致 versionChanged
引发事件。 如果机器人未处理此事件,则会引发错误,从而导致运行机器人错误处理程序逻辑。
返回空字符串将一起禁用组件的版本跟踪。
onDialogEvent(DialogContext, DialogEvent)
在引发事件时调用,使用 DialogContext.emitEvent()
由当前对话或当前对话启动的对话调用。
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>
参数
当前会话轮次的对话上下文。
正在引发的事件。
返回
Promise<boolean>
如此 如果事件由当前对话框处理,并且浮泡应停止。