CoreBot class

包:

botbuilder-dialogs-adaptive-runtime

实现 CoreBot 的实例。

Extends

ActivityHandler

构造函数

CoreBot(ResourceExplorer, UserState, ConversationState, BotFrameworkAuthentication, SkillConversationIdFactoryBase, BotTelemetryClient, string, string, MemoryScope[], PathResolver[])

继承的方法

onCommand(BotHandler)	为 命令 活动注册活动事件处理程序。
onCommandResult(BotHandler)	为 CommandResult 活动注册活动事件处理程序。
onConversationUpdate(BotHandler)	注册 会话更新 事件的活动事件处理程序，为每个传入的聊天更新活动发出。
onDialog(BotHandler)	注册 对话框 事件的活动事件处理程序，作为传入活动的最后一个事件发出。
onEndOfConversation(BotHandler)	为 会话活动的结束 注册活动事件处理程序。
onEvent(BotHandler)	为每个传入事件活动发出 的事件 事件注册活动事件处理程序。
onInstallationUpdate(BotHandler)	为 installationupdate 活动注册活动事件处理程序。
onInstallationUpdateAdd(BotHandler)	为 installationupdate add 活动注册活动事件处理程序。
onInstallationUpdateRemove(BotHandler)	为 installationupdate remove 活动注册活动事件处理程序。
onMembersAdded(BotHandler)	为 成员添加 的事件注册活动事件处理程序，该事件针对包含添加到会话的成员的任何传入会话更新活动发出。
onMembersRemoved(BotHandler)	为 成员删除 事件注册活动处理程序，该事件针对包含从会话中删除的成员的任何传入会话更新活动发出。
onMessage(BotHandler)	为 消息 事件注册活动事件处理程序，为每个传入消息活动发出。
onMessageReaction(BotHandler)	为 消息反应 事件注册活动事件处理程序，为每个传入消息反应活动发出。
onReactionsAdded(BotHandler)	为 添加的响应 事件注册活动事件处理程序，该事件为描述添加到消息的反应的任何传入消息反应活动发出。
onReactionsRemoved(BotHandler)	为 已删除的反应 事件注册活动事件处理程序，该事件为描述从消息中删除的反应的任何传入消息反应活动发出。
onTokenResponseEvent(BotHandler)	为任何传入tokens/response事件活动发出的 token-response 事件注册活动事件处理程序。 这些是作为 OAuth 身份验证流的一部分生成的。
onTurn(BotHandler)	为 轮次 事件注册活动事件处理程序，无论类型如何，都会为每个传入活动发出。
onTyping(BotHandler)	为 键入 活动注册活动事件处理程序。
onUnrecognizedActivityType(BotHandler)	为 无法识别的活动类型 事件注册活动事件处理程序，该事件为具有 ActivityHandler 不提供事件处理程序的类型的传入活动发出。
run(TurnContext)	调用 以启动事件发出过程。

构造函数详细信息

CoreBot(ResourceExplorer, UserState, ConversationState, BotFrameworkAuthentication, SkillConversationIdFactoryBase, BotTelemetryClient, string, string, MemoryScope[], PathResolver[])

new CoreBot(resourceExplorer: ResourceExplorer, userState: UserState, conversationState: ConversationState, botFrameworkAuthentication: BotFrameworkAuthentication, skillConversationIdFactory: SkillConversationIdFactoryBase, botTelemetryClient: BotTelemetryClient, defaultLocale: string, defaultRootDialog: string, memoryScopes: MemoryScope[], pathResolvers: PathResolver[])

参数

resourceExplorer

ResourceExplorer

用于访问资源的服务。

userState

UserState

存储的用户状态。

conversationState

ConversationState

存储的聊天状态。

botFrameworkAuthentication

BotFrameworkAuthentication

用于在此环境中对 Bot Framework 协议网络调用进行身份验证的云环境。

skillConversationIdFactory

SkillConversationIdFactoryBase

用于为技能对话创建唯一会话 ID 的方法。

botTelemetryClient

BotTelemetryClient

机器人客户端到遥测。

defaultLocale

string

用于确定特定于语言的行为的默认区域设置。

defaultRootDialog

string

默认机器人根对话。

memoryScopes

MemoryScope[]

命名的根级对象，可以存在于对话上下文中，也可以存在于轮次状态之外。

pathResolvers

PathResolver[]

转换路径的快捷方式行为。

继承的方法详细信息

onCommand(BotHandler)

为 命令 活动注册活动事件处理程序。

function onCommand(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

若要处理 Command 事件，请使用 onCommand 类型特定的事件处理程序。

继承自 ActivityHandler.onCommand

onCommandResult(BotHandler)

为 CommandResult 活动注册活动事件处理程序。

function onCommandResult(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

若要处理 CommandResult 事件，请使用 onCommandResult 类型特定的事件处理程序。

继承自 ActivityHandler.onCommandResult

onConversationUpdate(BotHandler)

注册 会话更新 事件的活动事件处理程序，为每个传入的聊天更新活动发出。

function onConversationUpdate(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

对话更新活动描述对对话元数据的更改，例如标题、参与者或其他特定于通道的信息。

若要处理何时在会话中添加或删除成员，请使用 onMembersAdded 和 onMembersRemoved 子类型事件处理程序。

继承自 ActivityHandler.onConversationUpdate

onDialog(BotHandler)

注册 对话框 事件的活动事件处理程序，作为传入活动的最后一个事件发出。

function onDialog(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

继承自 ActivityHandler.onDialog

onEndOfConversation(BotHandler)

为 会话活动的结束 注册活动事件处理程序。

function onEndOfConversation(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

此活动通常从技能发送到指示该特定子会话结束的技能调用方。

若要处理会话结束，请使用 onEndOfConversation 特定于类型的事件处理程序。

继承自 ActivityHandler.onEndOfConversation

onEvent(BotHandler)

为每个传入事件活动发出 的事件 事件注册活动事件处理程序。

function onEvent(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

事件活动将编程信息从客户端或通道传达给机器人。 事件活动的含义由活动的 name 属性定义，该属性在通道范围内有意义。 事件活动设计用来输送交互信息（例如，按钮单击）和非交互信息（例如，关于客户端自动更新嵌入的语音模型的通知）。

若要处理 tokens/response 事件事件，请使用 onTokenResponseEvent 子类型事件处理程序。 若要处理其他命名事件，请将逻辑添加到此处理程序。

继承自 ActivityHandler.onEvent

onInstallationUpdate(BotHandler)

为 installationupdate 活动注册活动事件处理程序。

function onInstallationUpdate(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

若要处理 InstallationUpdate 事件，请使用 onInstallationUpdate 类型特定的事件处理程序。

继承自 ActivityHandler.onInstallationUpdate

onInstallationUpdateAdd(BotHandler)

为 installationupdate add 活动注册活动事件处理程序。

function onInstallationUpdateAdd(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。 若要处理 InstallationUpdateAdd 事件，请使用 onInstallationUpdateAdd 类型特定的事件处理程序。

继承自 ActivityHandler.onInstallationUpdateAdd

onInstallationUpdateRemove(BotHandler)

为 installationupdate remove 活动注册活动事件处理程序。

function onInstallationUpdateRemove(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

若要处理 InstallationUpdateRemove 事件，请使用 onInstallationUpdateRemove 类型特定的事件处理程序。

继承自 ActivityHandler.onInstallationUpdateRemove

onMembersAdded(BotHandler)

为 成员添加 的事件注册活动事件处理程序，该事件针对包含添加到会话的成员的任何传入会话更新活动发出。

function onMembersAdded(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

活动的 membersAdded 属性包含添加到会话的成员，其中可以包括机器人。

若要一般处理会话更新事件，请使用 onConversationUpdate 类型特定的事件处理程序。

继承自 ActivityHandler.onMembersAdded

onMembersRemoved(BotHandler)

为 成员删除 事件注册活动处理程序，该事件针对包含从会话中删除的成员的任何传入会话更新活动发出。

function onMembersRemoved(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

活动的 membersRemoved 属性包含从聊天中删除的成员，其中可以包括机器人。

若要一般处理会话更新事件，请使用 onConversationUpdate 类型特定的事件处理程序。

继承自 ActivityHandler.onMembersRemoved

onMessage(BotHandler)

为 消息 事件注册活动事件处理程序，为每个传入消息活动发出。

function onMessage(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

消息活动表示要显示在对话界面中的内容，可以包含文本、语音、交互式卡片以及二进制或未知附件。 并非所有邮件活动都包含文本，活动的 text 属性可以是 null 或 undefined。

继承自 ActivityHandler.onMessage

onMessageReaction(BotHandler)

为 消息反应 事件注册活动事件处理程序，为每个传入消息反应活动发出。

function onMessageReaction(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

消息回应活动表示在聊天内的现有消息活动上进行社交互动。 原始活动由消息反应活动的 replyToId 属性引用。 from 属性表示反应的源，例如对消息做出反应的用户。

若要处理何时向会话中的消息添加或从中删除反应，请使用 onReactionsAdded 和 onReactionsRemoved 子类型事件处理程序。

继承自 ActivityHandler.onMessageReaction

onReactionsAdded(BotHandler)

为 添加的响应 事件注册活动事件处理程序，该事件为描述添加到消息的反应的任何传入消息反应活动发出。

function onReactionsAdded(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

活动的 reactionsAdded 属性包括已添加的一个或多个反应。

若要一般处理消息反应事件，请使用 onMessageReaction 类型特定的事件处理程序。

继承自 ActivityHandler.onReactionsAdded

onReactionsRemoved(BotHandler)

为 已删除的反应 事件注册活动事件处理程序，该事件为描述从消息中删除的反应的任何传入消息反应活动发出。

function onReactionsRemoved(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

活动的 reactionsRemoved 属性包括已删除的一个或多个反应。

若要一般处理消息反应事件，请使用 onMessageReaction 类型特定的事件处理程序。

继承自 ActivityHandler.onReactionsRemoved

onTokenResponseEvent(BotHandler)

为任何传入tokens/response事件活动发出的 token-response 事件注册活动事件处理程序。 这些是作为 OAuth 身份验证流的一部分生成的。

function onTokenResponseEvent(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

活动的 value 属性包含用户令牌。

如果机器人在对话框中使用 OAuthPrompt 处理身份验证，则对话需要接收此活动才能完成身份验证流。

若要处理其他命名事件和一般事件，请使用 onEvent 类型特定的事件处理程序。

继承自 ActivityHandler.onTokenResponseEvent

onTurn(BotHandler)

为 轮次 事件注册活动事件处理程序，无论类型如何，都会为每个传入活动发出。

function onTurn(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

继承自 ActivityHandler.onTurn

onTyping(BotHandler)

为 键入 活动注册活动事件处理程序。

function onTyping(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

若要处理 Type 事件，请使用 onTyping 类型特定的事件处理程序。

继承自 ActivityHandler.onTyping

onUnrecognizedActivityType(BotHandler)

为 无法识别的活动类型 事件注册活动事件处理程序，该事件为具有 ActivityHandler 不提供事件处理程序的类型的传入活动发出。

function onUnrecognizedActivityType(handler: BotHandler): this

参数

handler

BotHandler

事件处理程序。

返回

this

对 ActivityHandler 对象的引用。

注解

ActivityHandler不会为 Bot Framework 活动架构中定义的所有活动类型定义事件。 此外，通道和自定义适配器可以创建具有不在架构中的类型的 活动 。 当活动处理程序收到此类事件时，它会发出无法识别的活动类型事件。

活动的 type 属性包含活动类型。

继承自 ActivityHandler.onUnrecognizedActivityType

run(TurnContext)

调用 以启动事件发出过程。

function run(context: TurnContext): Promise<void>

参数

context

TurnContext

当前轮次的上下文对象。

返回

Promise<void>

注解

通常，将此方法作为函数处理程序提供，适配器在接收的活动已由适配器预先处理并通过任何中间件路由后，该函数处理程序由适配器调用以执行机器人的逻辑。

例如：

 server.post('/api/messages', (req, res) => {
     adapter.processActivity(req, res, async (context) => {
         // Route to bot's activity logic.
         await bot.run(context);
     });
});

另请参阅

• BotFrameworkAdapter.processActivity

继承自 ActivityHandler.run