共用方式為

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