BotFrameworkAdapter 类

public static final String CONNECTOR_CLIENT_KEY

用于存储 ConnectorClient 的密钥。

public static final String INVOKE_RESPONSE_KEY

用于存储 InvokeResponse 的密钥。

public static final String TEAMSCONNECTOR_CLIENT_KEY

用于存储 TeamsConnectorClient 的密钥。 仅用于测试。

public BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

使用凭据提供程序初始化 BotFrameworkAdapter 类的新实例。

参数:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

使用凭据提供程序初始化 BotFrameworkAdapter 类的新实例。

参数:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

使用凭据提供程序初始化 BotFrameworkAdapter 类的新实例。

参数:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

使用凭据提供程序初始化 BotFrameworkAdapter 类的新实例。

参数:

protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

将 ConnectorClient 插入缓存中。 仅用于单元测试。

参数:

protected CompletableFuture buildAppCredentials(String appId, String scope)

为指定的 appId 和范围创建 AppCredentials 对象。

参数:

返回:

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

向对话发送主动消息。

调用此方法以主动将消息发送到对话。 大多数通道要求用户启动与机器人的对话，然后机器人才能向用户发送活动。

替代:

参数:

返回:

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

向对话发送主动消息。

调用此方法以主动将消息发送到对话。 大多数通道要求用户启动与机器人的对话，然后机器人才能向用户发送活动。

替代:

参数:

返回:

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

将主动消息从机器人发送到聊天。

调用此方法以主动将消息发送到对话。 大多数通道要求用户启动与机器人的对话，然后机器人才能向用户发送活动。

此重载不同于 Node 实现，需要传入 BotId。 .Net 代码允许多个机器人托管在节点不支持的单个适配器中。

processActivity(String authHeader, Activity activity, BotCallbackHandler callback) runPipeline(TurnContext context, BotCallbackHandler callback)

替代:

参数:

返回:

public CompletableFuture createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

创建连接器客户端异步。

参数:

返回:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

在指定的通道上创建对话。 若要开始对话，机器人必须知道其帐户信息和该通道上的用户帐户信息。 大多数通道仅支持启动直接消息（非组）对话。

适配器尝试在通道上创建新会话，然后通过其中间件管道将 conversationUpdate 活动发送到 callback 方法。

如果与指定用户建立对话，则活动的 Activity#getConversation 的 ID 将包含新会话的 ID。

参数:

返回:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

在指定的通道上创建对话。 若要开始对话，机器人必须知道其帐户信息和该通道上的用户帐户信息。 大多数通道仅支持启动直接消息（非组）对话。

适配器尝试在通道上创建新会话，然后通过其中间件管道将 conversationUpdate 活动发送到 callback 方法。

如果与指定用户建立对话，则活动的 Activity#getConversation 的 ID 将包含新会话的 ID。

参数:

返回:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

为机器人创建 OAuth 客户端。

注意：这主要受保护，以便单元测试可以重写以提供模拟 OAuthClient。

参数:

返回:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

删除对话中的现有活动。

替代:

参数:

返回:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

从当前对话中删除成员。

参数:

返回:

public CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

执行令牌交换操作，例如单一登录。

参数:

返回:

public CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

执行令牌交换操作，例如单一登录。

参数:

返回:

public CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

使用自定义的 AppCredentials 检索配置连接上特定资源的 Azure Active Directory 令牌。

参数:

返回:

public CompletableFuture> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

检索配置连接上特定资源的 Azure Active Directory 令牌。

参数:

返回:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

列出给定活动的成员。

参数:

返回:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

列出给定活动的成员。

参数:

返回:

protected Map getConnectorClientCache()

获取 ConnectorClient 缓存。 用于单元测试。

返回:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

列出当前对话的成员。

参数:

返回:

public CompletableFuture getConversations(TurnContextImpl context)

列出此机器人为给定频道服务器参与的对话。 通道服务器返回页面结果，每个页面将包含一个“continuationToken”，可用于从服务器中提取下一页结果。 可以在标准活动处理期间调用此重载，此时将使用机器人的服务 URL 和当前活动处理管道中的凭据。

参数:

返回:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

列出此机器人为给定频道服务器参与的对话。 通道服务器返回页面结果，每个页面将包含一个“continuationToken”，可用于从服务器中提取下一页结果。 可以在标准活动处理期间调用此重载，此时将使用机器人的服务 URL 和当前活动处理管道中的凭据。

参数:

返回:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

列出此机器人为给定频道服务器参与的对话。 通道服务器返回页面结果，每个页面将包含一个“continuationToken”，可用于从服务器中提取下一页结果。

参数:

返回:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

列出此机器人为给定频道服务器参与的对话。 通道服务器返回页面结果，每个页面将包含一个“continuationToken”，可用于从服务器中提取下一页结果。 可以从会话上下文外部调用此重载，因为只需要机器人的 ServiceUrl 和凭据。

参数:

返回:

protected Map getCredentialsCache()

获取 AppCredentials 缓存。 用于单元测试。

返回:

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

使用自定义的 AppCredentials 获取要发送给用户以登录的连接名称的原始登录链接。

参数:

返回:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

使用机器人的 AppCredentials 获取要发送给用户进行登录的原始登录链接以获取连接名称。

参数:

返回:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

返回:

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

返回:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

从缓存或新建的缓存中返回 ConnectorClient。

注意：这主要是为了允许单元测试重写此项以提供模拟 ConnectorClient

参数:

返回:

public CompletableFuture getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

返回:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

返回:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

返回:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

使用自定义的 AppCredentials 检索给定用户的每个已配置连接的令牌状态。

参数:

返回:

public CompletableFuture> getTokenStatus(TurnContext context, String userId, String includeFilter)

检索给定用户的每个已配置连接的令牌状态。

参数:

返回:

public CompletableFuture getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

尝试使用自定义的 AppCredentials 检索登录流中的用户的令牌。

参数:

返回:

public CompletableFuture getUserToken(TurnContext context, String connectionName, String magicCode)

尝试检索登录流中的用户的令牌。

参数:

返回:

protected static String keyForAppCredentials(String appId, String scope)

生成用于访问应用凭据缓存的密钥。

参数:

返回:

protected static String keyForConnectorClient(String serviceUrl, String appId, String scope)

生成用于访问连接器客户端缓存的密钥。

参数:

返回:

public CompletableFuture processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

创建轮次上下文并运行传入活动的中间件管道。

参数:

返回:

public CompletableFuture processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

创建轮次上下文并运行传入活动的中间件管道。

参数:

返回:

public CompletableFuture sendActivities(TurnContext context, List activities)

将活动发送到对话。

替代:

参数:

返回:

     <xref uid="com.microsoft.bot.builder.TurnContext.onSendActivities(com.microsoft.bot.builder.SendActivitiesHandler)" data-throw-if-not-resolved="false" data-raw-source="TurnContext#onSendActivities(SendActivitiesHandler)"></xref>

public CompletableFuture signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId)

使用自定义 AppCredentials 通过令牌服务器注销用户。

参数:

返回:

public CompletableFuture signOutUser(TurnContext context, String connectionName, String userId)

使用令牌服务器注销用户。

参数:

返回:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

替换聊天中的现有活动。

替代:

参数:

返回:

public BotFrameworkAdapter use(Middleware middleware)

将中间件添加到适配器的管道。 中间件在初始化时添加到适配器。 对于每个轮次，适配器按添加中间件的顺序调用中间件。

替代:

参数:

返回: