AttachmentPrompt class

创建新的 AttachmentPrompt 实例。

new AttachmentPrompt(dialogId: string, validator?: PromptValidator<Attachment[]>)

参数

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

string id

属性值

对话框的 ID。

注解

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

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

BotTelemetryClient telemetryClient

属性值

要用于日志记录的 BotTelemetryClient。

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

static EndOfTurn: DialogTurnResult

属性值

注解

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

继承自Dialog.EndOfTurn

当将提示对话推送到对话堆栈并正在激活时调用。

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

参数

返回

表示异步操作的 Promise。

注解

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

继承自Prompt.beginDialog

用于配置对象的 Fluent 方法。

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

参数

返回

操作完成后 可配置。

继承自Configure.configure

当提示对话框是活动对话框，用户用新活动答复时调用。

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

参数

返回

表示异步操作的 Promise。

注解

如果任务成功，则结果指示对话在对话框处理轮次后是否仍然处于活动状态。 提示通常继续接收用户的答复，直到接受用户的回复作为提示的有效输入。

继承自Prompt.continueDialog

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

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

参数

返回

注解

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

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

另请参阅

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

继承自Dialog.endDialog

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

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

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

参数

返回

表示异步操作的 Promise。

继承自prompt.repromptDialog

当提示对话框恢复为对话堆栈上的活动对话时调用，例如堆栈上以前的活动对话完成时。

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

参数

返回

表示异步操作的 Promise。

注解

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

继承自Prompt.resumeDialog