Share via

CloudAdapter class

  • 参考
包:
botbuilder

实现 Bot Framework 协议的适配器，可以托管在公共和专用的不同云环境中。

Extends

CloudAdapterBase

构造函数

CloudAdapter(BotFrameworkAuthentication)

初始化 CloudAdapter 类的新实例。

继承属性

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

方法

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

用于将适配器连接到命名管道。
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

通过将逻辑函数应用于每个流式处理请求来处理 Web 套接字连接。
process(Request, Response, (context: TurnContext) => Promise<void>)

通过应用逻辑函数处理 Web 请求。

继承的方法

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[])

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

构造函数详细信息

CloudAdapter(BotFrameworkAuthentication)

初始化 CloudAdapter 类的新实例。

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

参数

botFrameworkAuthentication

BotFrameworkAuthentication

可选的 BotFrameworkAuthentication 实例

继承属性详细信息

BotIdentityKey 

BotIdentityKey: symbol

属性值

symbol

继承自 BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

属性值

symbol

继承自 BotAdapter.ConnectorClientKey

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

属性值

symbol

继承自 CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey 

OAuthScopeKey: symbol

属性值

symbol

继承自 BotAdapter.OAuthScopeKey

onTurnError 

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

属性值

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

继承自 BotAdapter.onTurnError

UserTokenClientKey 

UserTokenClientKey: symbol

属性值

symbol

继承自 CloudAdapterBase.UserTokenClientKey

方法详细信息

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

用于将适配器连接到命名管道。

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

参数

pipeName

string

要连接到的管道名称 (注意：通过将“.incoming”和“.outgoing”追加到此名称) 生成两个命名管道服务器

logic

(context: TurnContext) => Promise<void>

要为生成的机器人轮次调用的逻辑函数。

appId

string

机器人应用程序 ID

audience

string

用于出站通信的受众。 将因云环境而异。

callerId

string

可选，来电显示

retryCount

number

（可选）重试失败连接的次数 (默认为 7)

返回

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

通过将逻辑函数应用于每个流式处理请求来处理 Web 套接字连接。

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

参数

req
Request

传入的 HTTP 请求

socket

INodeSocket

相应的 INodeSocket

head

INodeBuffer

相应的 INodeBuffer

logic

(context: TurnContext) => Promise<void>

要应用的逻辑函数

返回

Promise<void>

表示异步操作的承诺。

process(Request, Response, (context: TurnContext) => Promise<void>)

通过应用逻辑函数处理 Web 请求。

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

参数

req
Request

相应的 HTTP 响应

res
Response
logic

(context: TurnContext) => Promise<void>

要应用的逻辑函数

返回

Promise<void>

表示异步操作的承诺。

继承的方法详细信息

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>

继承自 CloudAdapterBase.continueConversation

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>

继承自 CloudAdapterBase.continueConversationAsync

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>

继承自 CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

参数

context

TurnContext

reference

Partial<ConversationReference>

返回

Promise<void>

继承自 CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

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

参数

context

TurnContext

activities

Partial<Activity>[]

返回

Promise<ResourceResponse[]>

继承自 CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>) 

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

参数

context

TurnContext

activity

Partial<Activity>

返回

Promise<ResourceResponse | void>

继承自 CloudAdapterBase.updateActivity

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