TeamsActivityHandler class
添加了对 Microsoft Teams 特定事件和交互的支持。
- Extends
-
ActivityHandler
注解
开发人员可以通过两种方法处理从 Microsoft Teams 发送的对话更新活动:
- 重写以 开头且不以
..Event()
(结尾的方法on..
,例如onTeamsMembersAdded()
) ,或者 - 将回调传递给以
on..
((例如onTeamsMembersAddedEvent()
) )开头的方法...Event()
,以保持与较旧的 {@see ActivityHandler} 实现保持一致。
开发人员应将上述 #1 或 #2 用于所有对话更新活动,而不是对同一活动 使用 #2 和 #3。 这意味着,开发人员应重写 onTeamsMembersAdded()
,而不是同时使用 onTeamsMembersAdded()
和 onTeamsMembersAddedEvent()
。
想要处理 Invoke 活动的开发人员 必须 重写从 handle...()
(开始的方法,例如 handleTeamsTaskModuleFetch()
) 。
方法
继承的方法
on |
为 命令 活动注册活动事件处理程序。 |
on |
为 CommandResult 活动注册活动事件处理程序。 |
on |
为每个传入 的会话更新活动发出的对话更新 事件注册活动事件处理程序。 |
on |
为 对话 事件注册活动事件处理程序,作为传入活动的最后一个事件发出。 |
on |
为 会话活动的结束 注册活动事件处理程序。 |
on |
为每个传入事件活动发出 的事件 事件注册活动事件处理程序。 |
on |
为 installationupdate 活动注册活动事件处理程序。 |
on |
为 installationupdate add 活动注册活动事件处理程序。 |
on |
为 installationupdate remove 活动注册活动事件处理程序。 |
on |
为 添加的成员 事件注册活动事件处理程序,该事件针对包含添加到会话的成员的任何传入会话更新活动发出。 |
on |
为 成员删除 事件注册活动事件处理程序,该事件针对包含从会话中删除的成员的任何传入会话更新活动发出。 |
on |
注册 消息 事件的活动事件处理程序,为每个传入消息活动发出。 |
on |
注册 消息反应 事件的活动事件处理程序,为每个传入消息反应活动发出。 |
on |
为 添加的响应 事件注册活动事件处理程序,为描述添加到消息中的响应的任何传入消息反应活动发出。 |
on |
为 已删除的反应 事件注册一个活动事件处理程序,该事件针对描述从消息中删除的响应的任何传入消息反应活动发出。 |
on |
为任何传入 |
on |
为 轮次 事件注册一个活动事件处理程序,该处理程序针对每个传入活动发出,而不考虑类型。 |
on |
为 键入 活动注册活动事件处理程序。 |
on |
为 无法识别的活动类型 事件注册活动事件处理程序,该事件为具有 ActivityHandler 未提供事件处理程序的类型的传入活动发出。 |
run(Turn |
调用以启动事件发出过程。 |
方法详细信息
onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 TeamsChannelCreated 事件的处理程序,例如创建频道时的 。
function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队频道创建事件的回调。
返回
this
表示已排队工作的承诺。
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsChannelDeleted 事件注册处理程序,例如删除频道时的 处理程序。
function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队频道已删除事件的回调。
返回
this
表示已排队工作的承诺。
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsChannelRenamed 事件注册处理程序,例如重命名频道时的 。
function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队频道重命名事件的回调。
返回
this
表示排队工作的承诺。
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsChannelRestored 事件注册处理程序,例如,当频道还原时。
function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理 teams 频道还原事件的回调。
返回
this
表示排队工作的承诺。
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 Teams 会议结束时间的处理程序。
function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
处理会议结束事件的回调。
返回
this
表示排队工作的承诺。
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 Teams 会议开始时间的处理程序。
function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
处理会议开始事件的回调。
返回
this
表示排队工作的承诺。
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsMembersAdded 事件注册处理程序,例如,当机器人以外的成员加入频道时,例如机器人的欢迎逻辑。
function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队成员添加事件的回调。
返回
this
表示排队工作的承诺。
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsMembersRemoved 事件注册处理程序,例如,当机器人以外的其他成员离开频道时,例如机器人的再见逻辑。
function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队成员已删除事件的回调。
返回
this
表示排队工作的承诺。
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
在发送“已读回执”时注册处理程序。
function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
处理读取回执事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsTeamArchived 事件注册处理程序,例如存档团队时的 处理程序。
function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队存档事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 TeamsTeamDeleted 事件的处理程序,例如,删除团队时。
function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队团队删除事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsTeamHardDeleted 事件注册处理程序,例如,当团队被硬删除时。
function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队硬删除事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 TeamsTeamRenamed 事件的处理程序,例如重命名团队时的 。
function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队重命名事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
为 TeamsTeamRestored 事件注册处理程序,例如,在还原团队时注册 。
function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队团队还原事件的回调。
返回
this
表示排队工作的承诺。
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
注册 TeamsTeamUnarchived 事件的处理程序,例如,当团队未存档时。
function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
参数
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
用于处理团队团队未存档事件的回调。
返回
this
表示排队工作的承诺。
继承的方法详细信息
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
事件活动发出的 tokens-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 对象的引用。
注解
若要处理 Typing 事件,请使用 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);
});
});
另请参阅
继承自 ActivityHandler.run