共用方式為


botbuilder package

類別

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase

ChannelServiceHandlerBase 會實作 API,以將活動轉送到技能,並實作透過 Bot/配接器從 Skill 向上路由 ChannelAPI 呼叫。

ChannelServiceRoutes

使用 ChannelServiceHandler 方法路由傳送 API 呼叫。

CloudAdapter

實作 Bot Framework 通訊協定的配接器,可以裝載于公用和私人的不同雲端環境。

CloudChannelServiceHandler

類別,可協助使用 BotFrameworkAuthentication實作 Bot Framework 通訊協定。

EventFactory

包含用來建立各種事件種類的公用程式方法。

FileTranscriptStore

檔案文字記錄存放區會將文字記錄儲存在檔案系統中,並將每個活動儲存為檔案。

HandoffEventNames

定義遞交事件名稱的值。

InspectionMiddleware

檢查Middleware 以檢查執行時間活動和 BotState 的模擬器。

InspectionState

InspectionState 供檢查Middleware 用於執行時間活動和 BotState 的模擬器檢查。

RouteConstants

常數,表示緊接在 basePath 後面的 API 路徑。 這些目前是內部的,但我們將在未來重新評估使其公開。

範例

RouteConstants.Activities = '/v3/conversations/:conversationId/activities'。

SetSpeakMiddleware

支援 DirectLine 語音和電話語音通道,以確保在 Activity Speak 屬性上設定適當的 SSML 標籤。

CloudSkillHandler

技能的 Bot Framework 處理常式。

SkillHandler
SkillHandlerImpl
SkillHttpClient

BotFrameworkHttpClient 特製化用於封裝對話識別碼產生的技能。

StatusCodeError

擴充 Error 以提供特製化錯誤訊息。

StreamingHttpClient

的實作 HttpClient ,可新增與串流連線的相容性。

TokenResolver

在活動附件中尋找 OAuthCards,並對其採取動作

TeamsSSOTokenExchangeMiddleware

如果活動名稱為 signin/tokenExchange,此中介軟體會嘗試交換權杖,並重複數據刪除撥入電話,以確保只會處理一個交換要求。 如果使用者登入多個 Teams 用戶端,Bot 可能會收到來自每個用戶端的 「signin/tokenExchange」。 特定使用者登入的每個權杖交換要求都會有相同的 activity.value.id。

Bot 應該只處理其中一個權杖交換要求。 其他傳回 StatusCodes.PRECONDITION_FAILED。 對於生產環境的分散式 Bot,這需要分散式儲存體,以確保只會處理一個權杖交換。 此中介軟體支援在 botbuilder-azure 中找到的 CosmosDb 儲存體,或用於本機開發的 MemoryStorage。

TeamsActivityHandler

新增 Microsoft Teams 特定事件和互動的支援。

TeamsInfo

提供 Microsoft Teams 內發生的事件和互動的公用程式方法。

介面

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer

代表 Express 應用程式或 Restify 伺服器的介面。

ConnectorClientBuilder

建置連接器用戶端的抽象概念。

Request

表示Node.js HTTP 要求,包括最少的使用屬性集。 與 Restify、Express 和 Node.js core HTTP 相容。

Response
WebRequest

表示 Express 或 Restify 要求物件。 此介面支援架構,而且不適合直接針對您的程式碼呼叫。

WebResponse

表示 Express 或 Restify 回應物件。 此介面支援架構,而且不適合直接針對您的程式碼呼叫。

類型別名

RouteHandler

函式

validateAndFixActivity(Activity)

驗證 活動 並格式化時間戳記欄位。

teamsGetChannelId(Activity)

Teams 的活動協助程式方法。

teamsGetSelectedChannelId(Activity)

從目前活動取得小組選取的頻道識別碼。

teamsGetTeamId(Activity)

從目前 活動取得小組識別碼。

teamsGetTeamInfo(Activity)

從目前的 Activity取得 TeamsInfo 物件。

teamsGetTeamMeetingInfo(Activity)

會從目前的 Activity取得 TeamsMeetingInfo 物件。

teamsGetTenant(Activity)

從目前的 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

目前 活動的小組頻道識別碼或 Null。

teamsGetSelectedChannelId(Activity)

從目前活動取得小組選取的頻道識別碼。

function teamsGetSelectedChannelId(activity: Activity): string

參數

activity

Activity

目前的 活動

傳回

string

目前活動的小組選取的頻道或空字串。

teamsGetTeamId(Activity)

從目前 活動取得小組識別碼。

function teamsGetTeamId(activity: Activity): string | null

參數

activity

Activity

目前的 活動

傳回

string | null

目前 活動的小組識別碼或 Null。

teamsGetTeamInfo(Activity)

從目前的 Activity取得 TeamsInfo 物件。

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

參數

activity

Activity

目前的 活動

傳回

TeamInfo | null

目前 活動的小組資訊,或 Null。

teamsGetTeamMeetingInfo(Activity)

會從目前的 Activity取得 TeamsMeetingInfo 物件。

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

參數

activity

Activity

目前的 活動

傳回

TeamsMeetingInfo | null

目前 活動的小組會議資訊,或 Null。

teamsGetTenant(Activity)

從目前的 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。 必須包含在資訊清單的有效網域中。