SendActivity class

将活动发送回用户。

Extends

Dialog<O>

构造函数

SendActivity(Partial<Activity> | string)

创建新的 SendActivity 实例。

属性

$kind
activity

获取或设置活动的模板。

disabled

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

继承属性

EndOfTurn

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

id
telemetryClient

方法

beginDialog(DialogContext, O)

启动新的 对话框 并将其推送到对话堆栈上。

getConverter(Object)

继承的方法

configure(Record<string, unknown>)

用于配置 对象的 Fluent 方法。

continueDialog(DialogContext)

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

endDialog(TurnContext, DialogInstance, DialogReason)

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

getVersion()

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

onDialogEvent(DialogContext, DialogEvent)

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

repromptDialog(TurnContext, DialogInstance)

在派生类中重写时,重新调用用户进行输入。

resumeDialog(DialogContext, DialogReason, any)

在派生类中重写时,在堆栈上的对话完成后恢复对话。

构造函数详细信息

SendActivity(Partial<Activity> | string)

创建新的 SendActivity 实例。

new SendActivity(activity?: Partial<Activity> | string)

参数

activity

Partial<Activity> | string

(xref:botframework-schema。要向用户发送的活动) 或消息文本。

属性详细信息

$kind

static $kind: string

属性值

string

activity

获取或设置活动的模板。

activity: TemplateInterface<Partial<Activity>, D & O>

属性值

TemplateInterface<Partial<Activity>, D & O>

disabled

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

disabled?: BoolExpression

属性值

BoolExpression

继承属性详细信息

EndOfTurn

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

static EndOfTurn: DialogTurnResult

属性值

DialogTurnResult

注解

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

继承自 Dialog.EndOfTurn

id

id: string

属性值

string

继承自 Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

属性值

BotTelemetryClient

继承自 Dialog.telemetryClient

方法详细信息

beginDialog(DialogContext, O)

启动新的 对话框 并将其推送到对话堆栈上。

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

参数

dc

DialogContext

DialogContext当前轮次会话的 。

options

O

可选。 要传递到对话的初始信息。

返回

Promise<DialogTurnResult>

表示异步操作的 Promise

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

参数

property

Object

条件选择器配置的键。

返回

Converter | ConverterFactory

选择器配置的转换器。

继承的方法详细信息

configure(Record<string, unknown>)

用于配置 对象的 Fluent 方法。

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

参数

config

Record<string, unknown>

要应用的配置设置。

返回

this

操作完成后的 可配置

继承自 Configure.configure

continueDialog(DialogContext)

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

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

参数

dc

DialogContext

当前对话轮次的上下文。

返回

Promise<DialogTurnResult>

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

注解

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

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

若要向对话上下文发出此对话已完成的信号,请在退出此方法之前等待 DialogContext.endDialog

另请参阅

继承自 Dialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

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

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

参数

_context

TurnContext

轮次的上下文对象。

_instance

DialogInstance

此对话框的当前状态信息。

_reason

DialogReason

对话框结束的原因。

返回

Promise<void>

注解

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

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

另请参阅

继承自 Dialog.endDialog

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

repromptDialog(TurnContext, DialogInstance)

在派生类中重写时,重新调用用户进行输入。

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

参数

_context

TurnContext

轮次的上下文对象。

_instance

DialogInstance

此对话框的当前状态信息。

返回

Promise<void>

注解

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

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

另请参阅

继承自 Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

在派生类中重写时,在堆栈上的对话完成后恢复对话。

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

参数

dc

DialogContext

当前对话轮次的上下文。

reason

DialogReason

对话恢复的原因。 这通常是 DialogReason.endCalled

result

any

可选。 结束的对话框中的返回值(如果有)。

返回

Promise<DialogTurnResult>

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

注解

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

DialogContext 在恢复对话时调用此方法。 如果堆栈上的上一个对话框返回了一个值,则该值位于 参数中 result

若要启动 对话,请使用 DialogContext.beginDialogDialogContext.prompt;但是,此对话不一定是启动子对话的对话。 若要向对话上下文发出此对话已完成的信号,请在退出此方法之前等待 DialogContext.endDialog

另请参阅

继承自 Dialog.resumeDialog