Share via

BotAdapter 类

  • 参考

定义

命名空间:
Microsoft.Bot.Builder
程序集:
Microsoft.Bot.Builder.dll
包:
Microsoft.Bot.Builder v4.18.1

表示可将机器人连接到服务终结点的机器人适配器。 此类为抽象类。

public abstract class BotAdapter
type BotAdapter = class
Public MustInherit Class BotAdapter
继承
Object
BotAdapter
派生

注解

机器人适配器封装了身份验证过程，并将活动发送到机器人连接器服务并从机器人连接器服务接收活动。 当机器人收到活动时，适配器会创建上下文对象，将其传递给机器人的应用程序逻辑，并将响应发送回用户的通道。

使用 Use(IMiddleware) 将 对象添加到 IMiddleware 适配器的中间件集合。 适配器处理传入的活动并通过机器人中间件管道将其定向到机器人的逻辑，然后再返回。 当每个活动流入和流出机器人时，每个中间件都可以在机器人逻辑运行前后对其进行检查或执行操作。

构造函数

BotAdapter()

初始化 BotAdapter 类的新实例。

字段

BotIdentityKey

机器人标识密钥的字符串值。
InvokeResponseKey

将位于 TurnState 上的任何 InvokeResponseActivity 的键值。
OAuthScopeKey

OAuth 范围密钥的字符串值。

属性

MiddlewareSet

获取适配器管道中的中间件集合。
OnTurnError

获取或设置一个错误处理程序，该处理程序可以捕获中间件或应用程序中的异常。

方法

ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)

向对话发送主动消息。
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)

在指定通道上创建对话。
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)

在派生类中重写时，删除会话中的现有活动。
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

创建轮次上下文并为传入的 TRUSTED 活动运行中间件管道。
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)

启动当前机器人轮次的活动处理。
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)

在派生类中重写时，将活动发送到会话。
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)

在派生类中重写时，将替换会话中的现有活动。
Use(IMiddleware)

将中间件添加到适配器的管道。

扩展方法

UseBotState(BotAdapter, BotState[])

将中间件添加到适配器，以在轮次上下文中注册一个或多个 BotState 对象。 中间件在每个轮次开始时在轮次上下文中注册状态对象。
UseState(BotAdapter, UserState, ConversationState, Boolean)
已过时.

向适配器注册用户和会话状态对象。 这些对象将通过轮次上下文的 TurnState.Get<T>() 方法提供。
UseStorage(BotAdapter, IStorage)

将中间件添加到适配器，以在轮次上下文中注册对象 IStorage 。 中间件在每个轮次开始时在轮次上下文中注册状态对象。

适用于

另请参阅