ActivityHandler 类

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

使用指定的正文创建成功的 InvokeResponse。

参数:

返回:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

当机器人发送自适应卡片作执行时调用。

参数:

返回:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

在使用 onTurn(TurnContext turnContext) 的基本行为时收到命令活动时调用。 命令是执行作的请求，接收方通常使用一个或多个 commandResult 活动进行响应。 接收方还应显式拒绝不支持的命令活动。

参数:

返回:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

当使用 onTurn(TurnContext turnContext) 的基本行为时收到 CommandResult 活动时调用。 CommandResult 活动可用于传达命令执行的结果。

参数:

返回:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

使用 onTurn(TurnContext turnContext) 的基本行为时，从通道接收会话更新活动时调用。

聊天更新活动在响应添加到对话或删除的用户时非常有用。

例如，机器人可以通过问候用户来响应正在添加的用户。 默认情况下，如果已添加任何用户或 onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) 已删除任何用户，此方法将调用 onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext)。 该方法检查成员 ID，以便它仅响应有关机器人本身以外的成员的更新。

参数:

返回:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

重写派生类中的此项，以提供特定于ActivityTypes.END_OF_CONVERSATION活动的逻辑。

参数:

返回:

protected CompletableFuture onEvent(TurnContext turnContext)

在使用 onEventActivity(TurnContext turnContext) 的基本行为时，在收到令牌/响应以外的事件时调用。

如果机器人旨在处理杂项事件，则可以选择性地重写此方法。

默认情况下，此方法不执行任何作。

当 onEventActivity(TurnContext turnContext) 方法收到具有“token/response”以外的 Activity#getName() 的事件时，它将调用此方法。

参数:

返回:

protected CompletableFuture onEventActivity(TurnContext turnContext)

使用 onTurn(TurnContext turnContext) 的基本行为时，从连接器接收事件活动时调用。

事件活动可用于传达许多不同的内容。

默认情况下，如果活动的名称为“token/response”或 onEvent(TurnContext turnContext)，此方法将调用 onTokenResponseEvent(TurnContext turnContext)。 “tokens/response”事件可由 com.microsoft.bot.schema.OAuthCard触发。

当 onTurn(TurnContext turnContext) 方法收到事件活动时，它将调用此方法。

如果事件 Activity#getName 为“token/response”，则调用 onTokenResponseEvent(TurnContext turnContext) 否则，将调用 onEvent(TurnContext turnContext)。

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

事件活动将来自客户端或通道的编程信息传达给机器人。 事件活动的含义由 Activity#getName 属性定义，该属性在通道范围内有意义。 可以通过 com.microsoft.bot.schema.OAuthCard 或 OAuth 提示触发“令牌/响应”事件。

参数:

返回:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

重写派生类中的此项，以提供特定于 ActivityTypes.InstallationUpdate 活动的逻辑。

参数:

返回:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

重写派生类中的此项，以提供特定于 ActivityTypes.InstallationUpdate 活动的逻辑，将“action”设置为“add”。

参数:

返回:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

重写派生类中的此项，以提供特定于 ActivityTypes.InstallationUpdate 活动的逻辑，将“action”设置为“remove”。

参数:

返回:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

使用 onTurn 的基本行为时，从连接器接收调用活动时调用。

调用活动可用于传达许多不同的内容。 默认情况下，如果活动的名称为“signin/verifyState”或“signin/tokenExchange”，则此方法将调用 onSignInInvokeAsync。

OAuthCard 可以触发“signin/verifyState”或“signin/tokenExchange”调用。

参数:

返回:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

在派生类中重写此项，以便在机器人加入聊天（例如机器人的欢迎逻辑）以外的成员时提供逻辑。

当 onConversationUpdateActivity(TurnContext turnContext) 方法收到一个会话更新活动，该活动指示除 bo 以外的一个或多个用户正在加入会话时，它将调用此方法。

参数:

返回:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

在派生类中重写此项，以便在机器人离开聊天（例如机器人的好转逻辑）以外的成员时提供逻辑。

当 onConversationUpdateActivity(TurnContext turnContext) 方法收到会话更新活动，该活动指示机器人离开聊天以外的一个或多个用户时，它将调用此方法。

参数:

返回:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

重写派生类中的此项，以提供特定于 ActivityTypes#MESSAGE 活动的逻辑，例如聊天逻辑。

当 onTurn(TurnContext turnContext) 方法收到消息活动时，它将调用此方法。

参数:

返回:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

使用 onTurn(TurnContext turnContext) 的基本行为时，从连接器接收事件活动时调用。

消息反应对应于将“like”或“sad”等（通常为表情符号）添加到以前发送的活动的用户。 消息反应仅受一些通道支持。

message reaction 对应于的活动在 replyToId 属性中指示。 此属性的值是以前发送的活动的活动 ID，作为发送调用的响应返回给机器人。

当 onTurn(TurnContext turnContext) 方法收到消息反应活动时，它将调用此方法。 如果消息反应指示已将反应添加到消息中，则会调用 onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext)。 如果消息反应指示从消息中删除了反应，则它将调用 onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext)。

在派生类中，重写此方法以添加应用于所有消息反应活动的逻辑。 在调用基类方法之前添加要应用的反应之前要应用的逻辑。 在调用基类后添加要应用的反应后应用逻辑或移除逻辑。

参数:

返回:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

在派生类中重写此项，以便在向会话中添加对上一活动的反应时提供逻辑。

消息反应对应于将“赞”或“悲伤”等（通常为表情符号）添加到对话中之前发送的消息。 消息反应仅支持几个通道。 消息响应的活动由活动的 Activity#getReplyToId() 属性标识。 此属性的值是以前发送的活动的活动 ID。 当机器人发送活动时，通道会向其分配 ID，该 ID 在结果 com.microsoft.bot.schema.ResourceResponse#getId 中可用。

参数:

返回:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

重写派生类中的此项，以便在从会话中删除对上一活动的反应时提供逻辑。

消息反应对应于将“赞”或“悲伤”等（通常为表情符号）添加到对话中之前发送的消息。 消息反应仅支持几个通道。 消息响应的活动由活动的 Activity#getReplyToId() 属性标识。 此属性的值是以前发送的活动的活动 ID。 当机器人发送活动时，通道会向其分配 ID，该 ID 在结果 com.microsoft.bot.schema.ResourceResponse#getId 中可用。

参数:

返回:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

当使用 onInvokeActivity 的基本行为时收到“signin/verifyState”或“signin/tokenExchange”事件时调用。

如果使用 OAuthPrompt，请重写此方法以将此活动转发到当前对话框。 默认情况下，此方法不执行任何作。

当 onInvokeActivity 方法收到名为“tokens/response”的 Invoke 时，它将调用此方法。

如果机器人使用 OAuthPrompt，请将传入活动转发到当前对话框。

参数:

返回:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

当使用 onEventActivity(TurnContext turnContext) 的基本行为时收到“token/response”事件时调用。

如果使用 OAuthPrompt，请重写此方法以将此 Activity 转发到当前对话框。

默认情况下，此方法不执行任何作。

当 onEventActivity(TurnContext turnContext) 方法收到 Activity#getName() 为“token/response”的事件时，它将调用此方法。

参数:

返回:

public CompletableFuture onTurn(TurnContext turnContext)

适配器（例如，运行时 BotFrameworkAdapter）调用，以处理入站 Activity。

此方法基于要处理的活动类型调用此类中的其他方法，从而允许派生类以受控方式提供特定于类型的逻辑。

在派生类中，重写此方法以添加适用于所有活动类型的逻辑。 在调用基类 onTurn(TurnContext turnContext) 方法之前，在类型特定的逻辑之前添加要应用的逻辑。 在调用基类 onTurn(TurnContext turnContext) 方法后，添加要应用于特定于类型的逻辑的逻辑。

参数:

返回:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

重写派生类中的此项，以提供特定于 ActivityTypes.Type 活动的逻辑。

参数:

返回:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

使用 onTurn(TurnContext turnContext) 的基本行为时，在收到消息、会话更新或事件以外的活动时调用。

如果重写，这可能响应任何其他活动类型，例如 com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE 或 com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION。

默认情况下，此方法不执行任何作。

当 onTurn(TurnContext turnContext) 方法收到不是消息、对话更新、消息反应或事件活动的活动时，它将调用此方法。

参数:

返回: