botbuilder package
類別
BotFrameworkAdapter | |
BotFrameworkHttpClient | |
ChannelServiceHandler | |
ChannelServiceHandlerBase |
ChannelServiceHandlerBase 會實作 API,以將活動轉送至技能,並實作透過 Bot/配接器從技能向上路由 ChannelAPI 呼叫。 |
ChannelServiceRoutes |
使用 ChannelServiceHandler 方法路由傳送 API 呼叫。 |
CloudAdapter |
實作 Bot Framework 通訊協定的配接器,而且可以裝載於公用和私人的不同雲端環境中。 |
CloudChannelServiceHandler |
類別,可協助使用 BotFrameworkAuthentication實作 Bot Framework 通訊協定。 |
EventFactory |
包含用來建立各種事件類型的公用程式方法。 |
FileTranscriptStore |
檔案文字記錄存放區會將文字記錄儲存在文件系統中,並將每個活動儲存為檔案。 |
HandoffEventNames |
定義交接事件名稱的值。 |
InspectionMiddleware |
檢查運行時間活動和 BotState 的模擬器檢查Middleware。 |
InspectionState |
InspectionState 供 InspectionMiddleware 用於模擬器檢查運行時間和 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 |
|
TokenResolver |
尋找活動附件中的 OAuthCard,並對其採取動作 |
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 |
函式
validate |
驗證 活動,並格式化時間戳欄位。 |
teams |
Teams 的活動協助程式方法。 |
teams |
從目前活動取得小組選取的頻道標識碼。 |
teams |
從目前 活動取得小組標識符。 |
teams |
從目前的 Activity取得 TeamsInfo 物件。 |
teams |
從目前的 Activity取得 TeamsMeetingInfo 物件。 |
teams |
從目前 Activity取得 TenantInfo 物件。 |
teams |
設定目前的 活動,以在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。