通过

CloudAdapterBase class

  • 参考
包:
botbuilder-core

实现 Bot Framework 协议的适配器，可以托管在不同的云环境中，无论是公共还是私有云。

Extends
BotAdapter

构造函数

CloudAdapterBase(BotFrameworkAuthentication)

创建新的 CloudAdapterBase 实例。

属性

ConnectorFactoryKey
onTurnError

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

继承属性

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

方法

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)
continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)
createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)
deleteActivity(TurnContext, Partial<ConversationReference>)
sendActivities(TurnContext, Partial<Activity>[])
updateActivity(TurnContext, Partial<Activity>)

继承的方法

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

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

构造函数详细信息

CloudAdapterBase(BotFrameworkAuthentication)

创建新的 CloudAdapterBase 实例。

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

参数

botFrameworkAuthentication

BotFrameworkAuthentication

用于验证和创建令牌的 BotFrameworkAuthentication 。

属性详细信息

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

属性值

symbol

onTurnError

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

(context: TurnContext, error: Error) => Promise<void> onTurnError

属性值

(context: TurnContext, error: Error) => Promise<void>

表示异步操作的承诺。

注解

使用以下参数调用错误处理程序：

名称 类型 说明
context TurnContext 轮次的上下文对象。
error Error 引发Node.js错误。

UserTokenClientKey 

UserTokenClientKey: symbol

属性值

symbol

继承属性详细信息

BotIdentityKey 

BotIdentityKey: symbol

属性值

symbol

继承自BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

属性值

symbol

继承自BotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

属性值

symbol

继承自BotAdapter.OAuthScopeKey

方法详细信息

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)

警告

现已弃用此 API。

function continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>

参数

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

返回

Promise<void>

continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>) 

function continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: (context: TurnContext) => Promise<void> | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>

参数

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

(context: TurnContext) => Promise<void> | string

maybeLogic

(context: TurnContext) => Promise<void>

返回

Promise<void>

createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>) 

function createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>

参数

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

返回

Promise<void>

deleteActivity(TurnContext, Partial<ConversationReference>) 

function deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>

参数

context
TurnContext
reference

Partial<ConversationReference>

返回

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

function sendActivities(context: TurnContext, activities: Partial<Activity>[]): Promise<ResourceResponse[]>

参数

context
TurnContext
activities

Partial<Activity>[]

返回

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

function updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>

参数

context
TurnContext
activity

Partial<Activity>

返回

Promise<ResourceResponse | void>

继承的方法详细信息

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

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

function use(middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]): this

参数

middlewares

(context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]

要添加的中间件或中间件处理程序。

返回

this

更新的适配器对象。

注解

中间件在初始化时添加到适配器。 每次轮次，适配器都会按添加它的顺序调用其中间件。

继承自BotAdapter.use