共用方式為

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>

要針對產生的 Bot 回合呼叫的邏輯函式。

appId

string

Bot 應用程式識別碼

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