botbuilder package

类

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase 实现 API 以将活动转发到技能，并通过机器人/适配器实现从技能向上路由 ChannelAPI 调用。
ChannelServiceRoutes	使用 ChannelServiceHandler 方法路由 API 调用。
CloudAdapter	实现 Bot Framework 协议的适配器，可以托管在公共和专用的不同云环境中。
CloudChannelServiceHandler	帮助使用 BotFrameworkAuthentication 实现 Bot Framework 协议的类。
EventFactory	包含用于创建各种事件类型的实用工具方法。
FileTranscriptStore	文件脚本存储区将脚本存储在文件系统中，每个活动作为一个文件。
HandoffEventNames	定义移交事件名称的值。
InspectionMiddleware	检查运行时活动和 BotState 的模拟器检查的Middleware。
InspectionState	InspectionState，供 InspectionMiddleware 用于运行时活动和 BotState 的模拟器检查。
RouteConstants	表示紧跟 basePath 的 API 路径的常量。 这些目前是内部的，但我们将在未来重新评估将其公开。 示例 RouteConstants.Activities = '/v3/conversations/：conversationId/activities'。
SetSpeakMiddleware	支持 DirectLine 语音和电话通道，以确保在 Activity Speak 属性上设置适当的 SSML 标记。
CloudSkillHandler	用于技能的 Bot Framework 处理程序。
SkillHandler
SkillHandlerImpl
SkillHttpClient	BotFrameworkHttpClient 专用于用于封装对话 ID 生成的技能。
StatusCodeError	扩展 Error 以提供专用的错误消息。
StreamingHttpClient	的 HttpClient 实现，它增加了与流式处理连接的兼容性。
TokenResolver	在活动附件中查找 OAuthCard 并对其执行操作
TeamsSSOTokenExchangeMiddleware	如果活动名称为 signin/tokenExchange，则此中间件将尝试交换令牌，并删除传入调用的重复数据，确保仅处理一个交换请求。 如果用户登录到多个 Teams 客户端，机器人可能会从每个客户端接收“signin/tokenExchange”。 特定用户登录的每个令牌交换请求将具有相同 activity.value.id。 机器人只能处理其中一个令牌交换请求。 其他返回 StatusCodes.PRECONDITION_FAILED。 对于生产中的分布式机器人，这需要分布式存储，确保只处理一个令牌交换。 此中间件支持 botbuilder-azure 或 MemoryStorage 中用于本地开发的 CosmosDb 存储。
TeamsActivityHandler	添加了对 Microsoft Teams 特定事件和交互的支持。
TeamsInfo	为 Microsoft Teams 中发生的事件和交互提供实用工具方法。

接口

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	表示 Express 应用程序或 Restify 服务器的接口。
ConnectorClientBuilder	用于生成连接器客户端的抽象。
Request	表示Node.js HTTP 请求，包括最少的使用属性集。 与 Restify、Express 和 Node.js 核心 http 兼容。
Response
WebRequest	表示 Express 或 Restify 请求对象。 此接口支持框架，不应直接为代码调用。
WebResponse	表示 Express 或 Restify 响应对象。 此接口支持框架，不应直接为代码调用。

类型别名

RouteHandler

函数

validateAndFixActivity(Activity)	验证 活动 并设置时间戳字段的格式。
teamsGetChannelId(Activity)	Teams 的活动帮助程序方法。
teamsGetSelectedChannelId(Activity)	从当前活动获取团队的所选频道 ID。
teamsGetTeamId(Activity)	从当前 活动获取团队 ID。
teamsGetTeamInfo(Activity)	从当前 活动获取 TeamsInfo 对象。
teamsGetTeamMeetingInfo(Activity)	从当前 活动获取 TeamsMeetingInfo 对象。
teamsGetTenant(Activity)	从当前 活动获取 TenantInfo 对象。
teamsNotifyUser(Partial<Activity>, boolean, string)	将当前 活动 配置为在 Teams 中生成通知。

函数详细信息

validateAndFixActivity(Activity)

验证 活动 并设置时间戳字段的格式。

function validateAndFixActivity(activity: Activity): Activity

参数

activity

Activity

(xref：botbuilder-core。要验证的活动) 。

返回

Activity

活动。

teamsGetChannelId(Activity)

Teams 的活动帮助程序方法。

function teamsGetChannelId(activity: Activity): string | null

参数

activity

Activity

当前 活动。

返回

string | null

当前 活动团队的频道 ID 或 null。

teamsGetSelectedChannelId(Activity)

从当前活动获取团队的所选频道 ID。

function teamsGetSelectedChannelId(activity: Activity): string

参数

activity

Activity

当前 活动。

返回

string

当前活动团队的所选频道或空字符串。

teamsGetTeamId(Activity)

从当前 活动获取团队 ID。

function teamsGetTeamId(activity: Activity): string | null

参数

activity

Activity

当前 活动。

返回

string | null

当前 活动的团队 ID，或 null。

teamsGetTeamInfo(Activity)

从当前 活动获取 TeamsInfo 对象。

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

参数

activity

Activity

当前 活动。

返回

TeamInfo | null

当前 活动的团队信息，或 null。

teamsGetTeamMeetingInfo(Activity)

从当前 活动获取 TeamsMeetingInfo 对象。

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

参数

activity

Activity

当前 活动。

返回

TeamsMeetingInfo | null

当前 活动的团队会议信息，或 null。

teamsGetTenant(Activity)

从当前 活动获取 TenantInfo 对象。

function teamsGetTenant(activity: Activity): TenantInfo | null

参数

activity

Activity

当前 活动。

返回

TenantInfo | null

当前 活动的租户信息，或 null。

teamsNotifyUser(Partial<Activity>, boolean, string)

将当前 活动 配置为在 Teams 中生成通知。

function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string)

参数

activity

Partial<Activity>

当前 活动。

alertInMeeting

boolean

发送到会议聊天，这将导致 Teams 客户端在通知弹出窗口和聊天线程中呈现它。

externalResourceUrl

string

外部资源的 URL。 必须包含在清单的有效域中。