TeamsActivityHandler 类

继承
TeamsActivityHandler

构造函数

TeamsActivityHandler()

方法

on_conversation_update_activity

从通道接收会话更新活动时调用。 对话更新活动在响应在频道中添加或删除的用户时非常有用。 例如,机器人可以通过问候用户来响应正在添加的用户。

on_event_activity

在使用 的基本行为 <xref:botbuilder.core.teams.TeamsActivityHandler.on_turn> 时,从连接器接收事件活动时调用。

on_invoke_activity

从连接器接收调用活动时调用。 调用活动可用于传达许多不同的内容。

on_sign_in_invoke

从连接器收到 signIn 调用活动时调用。

on_teams_app_based_link_query

从连接器接收基于应用的链接查询活动时调用。

on_teams_card_action_invoke

从连接器收到卡操作调用活动时调用。

on_teams_channel_created

从连接器收到 Channel Created 事件活动时调用。 “创建的通道”对应于创建新通道的用户。

on_teams_channel_deleted

从连接器收到 Channel Deleted 事件活动时调用。 已删除频道对应于删除现有通道的用户。

on_teams_channel_renamed

从连接器收到 Channel Renamed 事件活动时调用。 已重命名频道对应于重命名现有通道的用户。

on_teams_channel_restored

从连接器收到通道还原事件活动时调用。 “还原通道”对应于还原以前删除的通道的用户。

on_teams_file_consent

从连接器收到文件同意卡活动时调用。

当用户对文件同意卡执行操作时发送的活动。

on_teams_file_consent_accept

当用户接受文件同意卡时调用。

当用户接受文件同意卡时发送的活动。

on_teams_file_consent_decline

当用户拒绝文件同意卡时调用。

当用户拒绝文件同意卡时发送的活动。

on_teams_meeting_end_event

在派生类中重写此项,以便为何时收到 Teams 会议结束事件提供逻辑。

on_teams_meeting_start_event

在派生类中重写此项,以提供何时收到 Teams 会议开始事件的逻辑。

on_teams_members_added

在派生类中重写此项,以便为机器人以外的成员何时加入通道提供逻辑,例如机器人的欢迎逻辑。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

on_teams_members_added_dispatch

在派生类中重写此项,以便为机器人以外的成员何时加入通道提供逻辑,例如机器人的欢迎逻辑。 它将获取具有所提供帐户的关联成员。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

on_teams_members_removed

在派生类中重写此项,以便为机器人以外的成员何时离开通道提供逻辑,例如机器人的再见逻辑。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

on_teams_members_removed_dispatch

在派生类中重写此项,以便为机器人以外的成员何时离开通道提供逻辑,例如机器人的再见逻辑。 它将获取具有所提供帐户的关联成员。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

on_teams_messaging_extension_bot_message_preview_edit

从连接器接收消息扩展机器人消息预览编辑活动时调用。

on_teams_messaging_extension_bot_message_preview_send

从连接器接收消息传递扩展机器人消息预览发送活动时调用。

on_teams_messaging_extension_card_button_clicked

在派生类中重写此项,以提供在消息扩展中单击卡片按钮时的逻辑。

on_teams_messaging_extension_configuration_query_settings_url

从连接器接收消息传送扩展配置查询设置 URL 活动时调用。

on_teams_messaging_extension_configuration_setting

在派生类中重写此项,以便为消息扩展设置配置时提供逻辑。

on_teams_messaging_extension_fetch_task

从连接器接收消息传送扩展提取活动时调用。

on_teams_messaging_extension_query

从连接器接收消息传送扩展查询活动时调用。

on_teams_messaging_extension_select_item

从连接器接收消息传递扩展选择项活动时调用。

on_teams_messaging_extension_submit_action

从连接器接收消息传递扩展提交操作活动时调用。

on_teams_messaging_extension_submit_action_dispatch

从连接器接收消息传递扩展提交操作调度活动时调用。

on_teams_o365_connector_card_action

从连接器接收 O365 连接器卡操作活动时调用。

on_teams_signin_token_exchange
on_teams_signin_verify_state

在从连接器收到 signIn 验证状态活动时调用。

on_teams_tab_fetch

在派生类中重写此项,以便在提取选项卡时提供逻辑。

on_teams_tab_submit

在派生类中重写此项,以提供提交选项卡时的逻辑。

on_teams_task_module_fetch

在派生类中重写此项,以便在提取任务模块时提供逻辑。

on_teams_task_module_submit

在派生类中重写此项,以便在提交任务模块时提供逻辑。

on_teams_team_archived

从连接器接收团队存档事件活动时调用。 已存档的团队对应于存档团队的用户。

on_teams_team_deleted

从连接器收到 Team Deleted 事件活动时调用。 已删除团队对应于删除团队的用户。

on_teams_team_hard_deleted

从连接器收到 Team Hard Deleted 事件活动时调用。 硬删除团队对应于用户硬删除团队。

on_teams_team_renamed

从连接器收到 Team Renamed 事件活动时调用。 已重命名团队对应于重命名现有团队的用户。

on_teams_team_renamed_activity

已弃用。 请使用 on_teams_team_renamed () 。 此方法将在整个 v4 中保留,以免破坏现有机器人。

从连接器收到 Team Renamed 事件活动时调用。 已重命名团队对应于重命名现有团队的用户。

on_teams_team_restored

从连接器收到 Team Restored 事件活动时调用。 团队还原对应于还原团队的用户。

on_teams_team_unarchived

从连接器收到 Team Unarchived 事件活动时调用。 团队取消存档对应于取消存档团队的用户。

on_conversation_update_activity

从通道接收会话更新活动时调用。 对话更新活动在响应在频道中添加或删除的用户时非常有用。 例如,机器人可以通过问候用户来响应正在添加的用户。

async on_conversation_update_activity(turn_context: TurnContext)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

注解

在派生类中,重写此方法以添加适用于所有聊天更新活动的逻辑。

on_event_activity

在使用 的基本行为 <xref:botbuilder.core.teams.TeamsActivityHandler.on_turn> 时,从连接器接收事件活动时调用。

async on_event_activity(turn_context: TurnContext)

参数

名称 说明
turn_context
必需

此轮次的上下文对象

返回

类型 说明

表示排队等待执行的工作的任务

注解

<xref:botbuilder.core.teams.TeamsActivityHandler.on_turn>当方法收到事件活动时,它会调用此方法。 如果活动名称为 tokens/response,则调用 <xref:botbuilder.core.teams.TeamsActivityHandler.on_token_response_event>;否则调用 <xref:botbuilder.core.teams.TeamsActivityHandler.on_event>。

在派生类中,重写此方法以添加适用于所有事件活动的逻辑。 在调用此基类方法之前,在特定的事件处理逻辑之前添加要应用的逻辑。 在调用此基类方法后,添加要应用于特定事件处理逻辑的逻辑。

事件活动将编程信息从客户端或通道传达给机器人。 事件活动的含义由事件活动名称属性定义,该属性在通道范围内有意义。

on_invoke_activity

从连接器接收调用活动时调用。 调用活动可用于传达许多不同的内容。

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个 InvokeResponse,表示排队等待执行的工作。

注解

调用活动将编程命令从客户端或通道传达给机器人。 调用活动的含义由“invoke_activity.name”属性定义,该属性在通道范围内有意义。

on_sign_in_invoke

从连接器收到 signIn 调用活动时调用。

async on_sign_in_invoke(turn_context: TurnContext)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

从连接器接收基于应用的链接查询活动时调用。

async on_teams_app_based_link_query(turn_context: TurnContext, query: AppBasedLinkQuery) -> MessagingExtensionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

query
必需

基于应用的链接查询的调用请求正文类型。

返回

类型 说明

查询的消息传送扩展响应。

on_teams_card_action_invoke

从连接器收到卡操作调用活动时调用。

async on_teams_card_action_invoke(turn_context: TurnContext) -> InvokeResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个 InvokeResponse,表示排队等待执行的工作。

on_teams_channel_created

从连接器收到 Channel Created 事件活动时调用。 “创建的通道”对应于创建新通道的用户。

async on_teams_channel_created(channel_info: ChannelInfo, team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
channel_info
必需

描述通道的通道信息对象。

team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_channel_deleted

从连接器收到 Channel Deleted 事件活动时调用。 已删除频道对应于删除现有通道的用户。

async on_teams_channel_deleted(channel_info: ChannelInfo, team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
channel_info
必需

描述通道的通道信息对象。

team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_channel_renamed

从连接器收到 Channel Renamed 事件活动时调用。 已重命名频道对应于重命名现有通道的用户。

async on_teams_channel_renamed(channel_info: ChannelInfo, team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
channel_info
必需

描述通道的通道信息对象。

team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_channel_restored

从连接器收到通道还原事件活动时调用。 “还原通道”对应于还原以前删除的通道的用户。

async on_teams_channel_restored(channel_info: ChannelInfo, team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
channel_info
必需

描述通道的通道信息对象。

team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

从连接器收到文件同意卡活动时调用。

当用户对文件同意卡执行操作时发送的活动。

async on_teams_file_consent(turn_context: TurnContext, file_consent_card_response: FileConsentCardResponse) -> InvokeResponse

参数

名称 说明
turn_context
必需
file_consent_card_response
必需

返回

类型 说明

一个 InvokeResponse,具体取决于文件同意卡的操作。

当用户接受文件同意卡时调用。

当用户接受文件同意卡时发送的活动。

async on_teams_file_consent_accept(turn_context: TurnContext, file_consent_card_response: FileConsentCardResponse)

参数

名称 说明
turn_context
必需
file_consent_card_response
必需

返回

类型 说明

表示排队等待执行的工作的任务。

当用户拒绝文件同意卡时调用。

当用户拒绝文件同意卡时发送的活动。

async on_teams_file_consent_decline(turn_context: TurnContext, file_consent_card_response: FileConsentCardResponse)

参数

名称 说明
turn_context
必需
file_consent_card_response
必需

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_meeting_end_event

在派生类中重写此项,以便为何时收到 Teams 会议结束事件提供逻辑。

async on_teams_meeting_end_event(meeting: MeetingEndEventDetails, turn_context: TurnContext)

参数

名称 说明
meeting
必需

会议的详细信息。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_meeting_start_event

在派生类中重写此项,以提供何时收到 Teams 会议开始事件的逻辑。

async on_teams_meeting_start_event(meeting: MeetingStartEventDetails, turn_context: TurnContext)

参数

名称 说明
meeting
必需

会议的详细信息。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_members_added

在派生类中重写此项,以便为机器人以外的成员何时加入通道提供逻辑,例如机器人的欢迎逻辑。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

async on_teams_members_added(teams_members_added: [<class 'botbuilder.schema.teams._models_py3.TeamsChannelAccount'>], team_info: ~botbuilder.schema.teams._models_py3.TeamInfo, turn_context: ~botbuilder.core.turn_context.TurnContext)

参数

名称 说明
teams_members_added
必需
team_info
必需
turn_context
必需

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_members_added_dispatch

在派生类中重写此项,以便为机器人以外的成员何时加入通道提供逻辑,例如机器人的欢迎逻辑。 它将获取具有所提供帐户的关联成员。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

async on_teams_members_added_dispatch(members_added: [<class 'botbuilder.schema._models_py3.ChannelAccount'>], team_info: ~botbuilder.schema.teams._models_py3.TeamInfo, turn_context: ~botbuilder.core.turn_context.TurnContext)

参数

名称 说明
members_added
必需
team_info
必需
turn_context
必需

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_members_removed

在派生类中重写此项,以便为机器人以外的成员何时离开通道提供逻辑,例如机器人的再见逻辑。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

async on_teams_members_removed(teams_members_removed: [<class 'botbuilder.schema.teams._models_py3.TeamsChannelAccount'>], team_info: ~botbuilder.schema.teams._models_py3.TeamInfo, turn_context: ~botbuilder.core.turn_context.TurnContext)

参数

名称 说明
teams_members_removed
必需
team_info
必需
turn_context
必需

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_members_removed_dispatch

在派生类中重写此项,以便为机器人以外的成员何时离开通道提供逻辑,例如机器人的再见逻辑。 它将获取具有所提供帐户的关联成员。

由会话更新活动描述。 :p aram team_info:表示团队的团队信息对象。 :p aram turn_context:此轮次的上下文对象。

async on_teams_members_removed_dispatch(members_removed: [<class 'botbuilder.schema._models_py3.ChannelAccount'>], team_info: ~botbuilder.schema.teams._models_py3.TeamInfo, turn_context: ~botbuilder.core.turn_context.TurnContext)

参数

名称 说明
members_removed
必需
team_info
必需
turn_context
必需

返回

类型 说明

表示排队等待执行的工作的任务。

on_teams_messaging_extension_bot_message_preview_edit

从连接器接收消息扩展机器人消息预览编辑活动时调用。

async on_teams_messaging_extension_bot_message_preview_edit(turn_context: TurnContext, action: MessagingExtensionAction) -> MessagingExtensionActionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

action
必需

消息传递扩展操作。

返回

类型 说明

操作的消息传递扩展操作响应。

on_teams_messaging_extension_bot_message_preview_send

从连接器接收消息传递扩展机器人消息预览发送活动时调用。

async on_teams_messaging_extension_bot_message_preview_send(turn_context: TurnContext, action: MessagingExtensionAction) -> MessagingExtensionActionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

action
必需

消息传送扩展操作。

返回

类型 说明

操作的消息传递扩展操作响应。

on_teams_messaging_extension_card_button_clicked

在派生类中重写此项,以提供在消息扩展中单击卡片按钮时的逻辑。

async on_teams_messaging_extension_card_button_clicked(turn_context: TurnContext, card_data)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

card_data
必需

表示卡片数据的对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_messaging_extension_configuration_query_settings_url

从连接器接收消息传送扩展配置查询设置 URL 活动时调用。

async on_teams_messaging_extension_configuration_query_settings_url(turn_context: TurnContext, query: MessagingExtensionQuery) -> MessagingExtensionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

query
必需

消息传递扩展查询。

返回

类型 说明

查询的消息传送扩展响应。

on_teams_messaging_extension_configuration_setting

在派生类中重写此项,以便为消息扩展设置配置时提供逻辑。

async on_teams_messaging_extension_configuration_setting(turn_context: TurnContext, settings)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

settings
必需

表示配置设置的对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_messaging_extension_fetch_task

从连接器接收消息传送扩展提取活动时调用。

async on_teams_messaging_extension_fetch_task(turn_context: TurnContext, action: MessagingExtensionAction) -> MessagingExtensionActionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

action
必需

消息传送扩展操作。

返回

类型 说明

操作的消息传递扩展操作响应。

on_teams_messaging_extension_query

从连接器接收消息传送扩展查询活动时调用。

async on_teams_messaging_extension_query(turn_context: TurnContext, query: MessagingExtensionQuery) -> MessagingExtensionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

query
必需

搜索命令的查询。

返回

类型 说明

查询的消息传送扩展响应。

on_teams_messaging_extension_select_item

从连接器接收消息传递扩展选择项活动时调用。

async on_teams_messaging_extension_select_item(turn_context: TurnContext, query) -> MessagingExtensionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

query
必需

表示查询的 对象。

返回

类型 说明

查询的消息传送扩展响应。

on_teams_messaging_extension_submit_action

从连接器接收消息传递扩展提交操作活动时调用。

async on_teams_messaging_extension_submit_action(turn_context: TurnContext, action: MessagingExtensionAction) -> MessagingExtensionActionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

action
必需

消息传送扩展操作。

返回

类型 说明

操作的消息传递扩展操作响应。

on_teams_messaging_extension_submit_action_dispatch

从连接器接收消息传递扩展提交操作调度活动时调用。

async on_teams_messaging_extension_submit_action_dispatch(turn_context: TurnContext, action: MessagingExtensionAction) -> MessagingExtensionActionResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

action
必需

消息传送扩展操作。

返回

类型 说明

操作的消息传递扩展操作响应。

on_teams_o365_connector_card_action

从连接器接收 O365 连接器卡操作活动时调用。

async on_teams_o365_connector_card_action(turn_context: TurnContext, query: O365ConnectorCardActionQuery)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

query
必需

O365 连接器卡 HttpPOST 调用查询。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_signin_token_exchange

async on_teams_signin_token_exchange(turn_context: TurnContext)

参数

名称 说明
turn_context
必需

on_teams_signin_verify_state

在从连接器收到 signIn 验证状态活动时调用。

async on_teams_signin_verify_state(turn_context: TurnContext)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_tab_fetch

在派生类中重写此项,以便在提取选项卡时提供逻辑。

async on_teams_tab_fetch(turn_context: TurnContext, tab_request: TabRequest)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

tab_request
必需

选项卡调用请求值有效负载。

返回

类型 说明

请求的 Tab 响应。

on_teams_tab_submit

在派生类中重写此项,以提供提交选项卡时的逻辑。

async on_teams_tab_submit(turn_context: TurnContext, tab_submit: TabSubmit)

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

tab_submit
必需

选项卡提交调用请求值有效负载。

返回

类型 说明

请求的 Tab 响应。

on_teams_task_module_fetch

在派生类中重写此项,以便在提取任务模块时提供逻辑。

async on_teams_task_module_fetch(turn_context: TurnContext, task_module_request: TaskModuleRequest) -> TaskModuleResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

task_module_request
必需

任务模块调用请求值有效负载。

返回

类型 说明

请求的任务模块响应。

on_teams_task_module_submit

在派生类中重写此项,以便在提交任务模块时提供逻辑。

async on_teams_task_module_submit(turn_context: TurnContext, task_module_request: TaskModuleRequest) -> TaskModuleResponse

参数

名称 说明
turn_context
必需

此轮次的上下文对象。

task_module_request
必需

任务模块调用请求值有效负载。

返回

类型 说明

请求的任务模块响应。

on_teams_team_archived

从连接器接收团队存档事件活动时调用。 已存档的团队对应于存档团队的用户。

async on_teams_team_archived(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_deleted

从连接器收到 Team Deleted 事件活动时调用。 已删除团队对应于删除团队的用户。

async on_teams_team_deleted(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_hard_deleted

从连接器收到 Team Hard Deleted 事件活动时调用。 硬删除团队对应于用户硬删除团队。

async on_teams_team_hard_deleted(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_renamed

从连接器收到 Team Renamed 事件活动时调用。 已重命名团队对应于重命名现有团队的用户。

async on_teams_team_renamed(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_renamed_activity

已弃用。 请使用 on_teams_team_renamed () 。 此方法将在整个 v4 中保留,以免破坏现有机器人。

从连接器收到 Team Renamed 事件活动时调用。 已重命名团队对应于重命名现有团队的用户。

async on_teams_team_renamed_activity(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_restored

从连接器收到 Team Restored 事件活动时调用。 团队还原对应于还原团队的用户。

async on_teams_team_restored(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。

on_teams_team_unarchived

从连接器收到 Team Unarchived 事件活动时调用。 团队取消存档对应于取消存档团队的用户。

async on_teams_team_unarchived(team_info: TeamInfo, turn_context: TurnContext)

参数

名称 说明
team_info
必需

表示团队的团队信息对象。

turn_context
必需

此轮次的上下文对象。

返回

类型 说明

一个任务,表示排队要执行的工作。