BotFrameworkHttpAdapter 类

定义

命名空间:: Microsoft.Bot.Builder.Integration.AspNet.WebApi

程序集:: Microsoft.Bot.Builder.Integration.AspNet.WebApi.dll

包:: Microsoft.Bot.Builder.Integration.AspNet.WebApi v4.22.7

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

一个用于处理机器人框架HTTP请求的机器人构建适配器实现。

public class BotFrameworkHttpAdapter : Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.WebApi.IBotFrameworkHttpAdapter

type BotFrameworkHttpAdapter = class
    inherit BotFrameworkHttpAdapterBase
    interface IBotFrameworkHttpAdapter

Public Class BotFrameworkHttpAdapter
Inherits BotFrameworkHttpAdapterBase
Implements IBotFrameworkHttpAdapter

继承: Object

BotAdapter

BotFrameworkAdapter

BotFrameworkHttpAdapterBase
BotFrameworkHttpAdapter

实现: IBotFrameworkHttpAdapter

构造函数

名称	说明
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>)	初始化 BotFrameworkHttpAdapter 类的新实例。
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>)	初始化 BotFrameworkHttpAdapter 类的新实例。

字段

名称	说明
BotIdentityKey	机器人身份密钥的字符串值。 (继承自 BotAdapter)
InvokeResponseKey	任何 InvokeResponseActivity 在 TurnState 上的关键值。 (继承自 BotAdapter)
OAuthScopeKey	OAuth 范围键的字符串值。 (继承自 BotAdapter)

属性

名称	说明
AppCredentialMap	获取该适配器的 AppCredentials 应用映射。 (继承自 BotFrameworkAdapter)
ChannelProvider	获取此适配器的通道提供程序。 (继承自 BotFrameworkAdapter)
ClaimsIdentity	获取或设置该适配器的索赔身份。 (继承自 BotFrameworkHttpAdapterBase)
ConnectedBot	让机器人连接到这个适配器。 (继承自 BotFrameworkHttpAdapterBase)
CredentialProvider	获取此适配器的凭据提供程序。 (继承自 BotFrameworkAdapter)
HttpClient	如果需要指定，我会定制 HttpClient 这个适配器。 (继承自 BotFrameworkAdapter)
Logger	拿到这个适配器的记录器。 (继承自 BotFrameworkAdapter)
MiddlewareSet	获取适配器管道中中间件的集合。 (继承自 BotAdapter)
OnTurnError	获取或设置一个错误处理程序，可以捕捉中间件或应用程序中的异常。 (继承自 BotAdapter)
RequestHandlers	获取或设置该适配器的请求处理程序。 (继承自 BotFrameworkHttpAdapterBase)

方法

名称	说明
BuildCredentialsAsync(String, String)	构建 AppCredentials 一个对象，用于获取该 HttpClient 的令牌。 (继承自 BotFrameworkAdapter)
CanProcessOutgoingActivity(Activity)	评估是否可以处理出场活动。 (继承自 BotFrameworkHttpAdapterBase)
ConnectNamedPipeAsync(String, IBot, String)	创建一个新的StreamingRequestHandler，用于监听指定的命名管道并将请求传递给该适配器。 (继承自 BotFrameworkHttpAdapterBase)
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	向对话发送主动消息。 (继承自 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	向对话发送主动消息。 (继承自 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	将主动消息从机器人发送到聊天。 (继承自 BotFrameworkAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	将主动消息从机器人发送到聊天。 (继承自 BotFrameworkAdapter)
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	向对话发送主动消息。 (继承自 BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	将主动消息从机器人发送到聊天。 (继承自 BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上创建对话。 (继承自 BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	已过时. 在指定的通道上创建对话。过载会收到包含租户的ConversationReference。 (继承自 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上创建对话。 (继承自 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	已过时. 在指定的通道上创建对话。过载会收到包含租户的ConversationReference。 (继承自 BotFrameworkAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上创建对话。 (继承自 BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	为机器人创建一个带有凭据的OAuth客户端。 (继承自 BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext)	为机器人创建 OAuth 客户端。 (继承自 BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	删除对话中的现有活动。 (继承自 BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	将一名成员从当前对话中移除。 (继承自 BotFrameworkAdapter)
Dispose()	一个用于处理机器人框架HTTP请求的机器人构建适配器实现。 (继承自 BotFrameworkHttpAdapterBase)
Dispose(Boolean)	处置资源 StreamingRequestHandler。 (继承自 BotFrameworkHttpAdapterBase)
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	执行令牌交换操作，例如单一登录。 (继承自 BotFrameworkAdapter)
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	执行令牌交换操作，例如单一登录。 (继承自 BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	使用自定义的 AppCredentials 检索配置连接上特定资源的 Azure Active Directory 令牌。 (继承自 BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	利用机器人的 AppCredentials 获取配置连接中特定资源的 Azure Active Directory 令牌。 (继承自 BotFrameworkAdapter)
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	列出给定活动的成员。 (继承自 BotFrameworkAdapter)
GetConversationMembersAsync(ITurnContext, CancellationToken)	列出当前对话的成员。 (继承自 BotFrameworkAdapter)
GetConversationsAsync(ITurnContext, String, CancellationToken)	列出此机器人为给定频道服务器参与的对话。通道服务器以页面形式返回结果，每个页面都会包含 `continuationToken` 一个，可用于从服务器获取下一页的结果。 (继承自 BotFrameworkAdapter)
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	列出此机器人为给定频道服务器参与的对话。通道服务器以页面形式返回结果，每个页面都会包含 `continuationToken` 一个，可用于从服务器获取下一页的结果。 (继承自 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	使用自定义的 AppCredentials 获取要发送给用户以登录的连接名称的原始登录链接。 (继承自 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	使用自定义的 AppCredentials 获取要发送给用户以登录的连接名称的原始登录链接。 (继承自 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	使用机器人的 AppCredentials 获取要发送给用户进行登录的原始登录链接以获取连接名称。 (继承自 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	使用机器人的 AppCredentials 获取要发送给用户进行登录的原始登录链接以获取连接名称。 (继承自 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	获取要发送给用户用于登录的连接名称的原始登录链接。 (继承自 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	获取要发送给用户用于登录的连接名称的原始登录链接。 (继承自 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	获取要发送给用户用于登录的连接名称的原始登录链接。 (继承自 BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	使用自定义的 AppCredentials 检索给定用户的每个已配置连接的令牌状态。 (继承自 BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	使用机器人的 AppCredentials 检索给定用户的每个已配置连接的令牌状态。 (继承自 BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	尝试使用自定义的 AppCredentials 检索登录流中的用户的令牌。 (继承自 BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	尝试通过机器人的AppCredentials为登录流中的用户获取令牌。 (继承自 BotFrameworkAdapter)
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	创建轮次上下文并运行传入活动的中间件管道。 (继承自 BotFrameworkAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	创建轮次上下文并运行传入活动的中间件管道。 (继承自 BotFrameworkAdapter)
ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken)	该方法可以在任何控制器实现的 POST 方法内部调用。
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	发送一个外出活动。 (继承自 BotFrameworkHttpAdapterBase)
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	处理从流媒体通道发送的活动的主要适配器方法。创建轮次上下文并运行传入活动的中间件管道。 ArgumentNullException使用空参数。 (继承自 BotFrameworkHttpAdapterBase)
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	启动当前机器人轮次的活动处理。 (继承自 BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	将活动发送到对话。 (继承自 BotFrameworkAdapter)
SendStreamingActivityAsync(Activity, CancellationToken)	发送一个活动。 (继承自 BotFrameworkHttpAdapterBase)
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	使用自定义 AppCredentials 通过令牌服务器注销用户。 (继承自 BotFrameworkAdapter)
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	通过机器人的AppCredentials，将用户从令牌服务器中登出。 (继承自 BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	替换聊天中的现有活动。 (继承自 BotFrameworkAdapter)
Use(IMiddleware)	将中间件添加到适配器的管道。 (继承自 BotFrameworkAdapter)

显式接口实现

名称	说明
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	一个用于处理机器人框架HTTP请求的机器人构建适配器实现。 (继承自 BotFrameworkAdapter)

扩展方法

名称	说明
UseBotState(BotAdapter, BotState[])	在适配器中添加中间件，用于在回合上下文中注册一个或多个 BotState 对象。中间件在每回合开始时对回合上下文的状态对象进行注册。
UseState(BotAdapter, UserState, ConversationState, Boolean)	已过时. 向适配器注册用户和会话状态对象。这些对象将通过回合上下文的 TurnState.Get<T>() 方法提供。
UseStorage(BotAdapter, IStorage)	向适配器添加中间件，用于在回合上下文中注册 IStorage 对象。中间件在每回合开始时对回合上下文的状态对象进行注册。

适用于