botbuilder-core package

參考

類別

ActivityFactory	ActivityFactory 產生文字，然後使用簡單的 Markdown 語意，例如 chatdown 來建立 Activity。
ActivityHandler	Bot 的事件發出活動處理常式。擴充 ActivityHandlerBase。
ActivityHandlerBase	定義 Bot 事件發出活動處理常式的核心行為。
AutoSaveStateMiddleware	中介軟體，會在回合結束時自動儲存任何狀態變更。
BotAdapter	定義可將 Bot 連線至服務端點之 Bot 配接器的核心行為。
BotComponent	BotComponent 的定義，允許註冊服務、自訂動作、記憶體範圍和配接器。若要讓您的元件可供衍生自 BotComponent 的系統使用，並註冊服務以新增功能。這些元件接著會由需要這些元件的系統在適當的位置取用。使用 Composer 時，只要在組態中註冊元件，bot 執行時間就會自動在元件上呼叫 configureServices。
BotState	架構狀態持續性範圍的基類。
BotStatePropertyAccessor	介面 `BotState` 的特定實作 `StatePropertyAccessor` 。
BotStateSet	應該以單一單位平行方式載入或儲存的外掛程式集合 `BotState` 。如需這個類別的實作，請參閱 `AutoSaveStateMiddleware` 。
NullTelemetryClient	實作 BotTelemetryClient的 Null Bot 遙測用戶端。
BrowserLocalStorage	使用瀏覽器本機儲存體的儲存體提供者。
BrowserSessionStorage	使用瀏覽器會話儲存體的儲存體提供者。
CardFactory	提供方法，以格式化 Bot 可以傳回的各種卡片類型。
CloudAdapterBase	實作 Bot Framework 通訊協定的配接器，可以裝載于公用和私人的不同雲端環境中。
ComponentRegistration	ComponentRegistration 是用來從元件探索資產的簽章類別。
ConfigurationBotFrameworkAuthentication	從具有驗證值或組態實例的物件建立BotFrameworkAuthentication實例。
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory，使用 ConfigurationServiceClientCredentialFactoryOptions 或組態實例，以 AppId 和應用程式密碼建置 ServiceClientCredentials。
ConversationState	讀取和寫入 Bot 的交談狀態至儲存體。
InvokeException	叫用回應錯誤的自訂例外狀況。
MemoryStorage	Bot 的記憶體型儲存體提供者。
MemoryTranscriptStore	記憶體文字記錄存放區會將文字記錄儲存在 Map 中的動態記憶體中。
MessageFactory	一組公用程式函式，可協助 Bot 可以傳回的各種訊息類型格式設定。
MiddlewareSet	一組 `Middleware` 外掛程式。
PrivateConversationState	讀取和寫入 Bot 的 PrivateConversation 狀態至儲存體。
QueueStorage	將 Activity 排入佇列的基類，以供稍後處理。
RegisterClassMiddleware	將物件新增至或向目前回合內容註冊服務的中介軟體。
ShowTypingMiddleware	將為每個訊息自動傳送輸入指示器的中介軟體。
SkillConversationIdFactory	SkillConversationIdFactory，可儲存及擷取 ConversationReference 實例。
SkillConversationIdFactoryBase	定義處理站的方法，用來建立技能交談的唯一交談識別碼。
SkypeMentionNormalizeMiddleware	要修補的中介軟體提及 Skype 中的實體，因為它們不符合預期的值。如果使用提及，與 Skype 互動的 Bot 應該使用此中介軟體。
StringUtils	包含字串公用程式方法的協助程式類別。
TelemetryConstants	定義與 BotTelemetryClient 物件搭配使用的通用屬性名稱。
TelemetryLoggerMiddleware	用於記錄傳入、傳出、更新或刪除活動訊息的中介軟體。使用 botTelemetryClient 介面。
TestAdapter	用於單元測試的測試配接器。此配接器可用來模擬將訊息從使用者傳送至 Bot。
TestFlow	支援類別 `TestAdapter` ，允許簡單建構一連串的測試。
ConsoleTranscriptLogger	ConsoleTranscriptLogger ，會將活動寫入主控台輸出。
TranscriptLoggerMiddleware	將傳入和傳出的活動記錄到 TranscriptStore。
TurnContext	提供 Bot 回合的內容。
TurnContextStateCollection	在 TurnCoNtext中保存回合存留期的值。
UserState	讀取和寫入 Bot 至儲存體的使用者狀態。

介面

CachedBotState	實例從 `BotState` 內容物件快取的狀態資訊。
StatePropertyAccessor	定義存取 BotState 物件中建立之狀態屬性的方法。
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	代表「WebResource」的來源內部介面 @azure/ms-rest-js
ExtendedUserTokenProvider	適用于 BotAdapters 的使用者權杖 OAuth 單一登入和權杖交換 API 的介面
IntentScore	分數加上任何關於意圖的額外資訊。
Middleware	物件型中介軟體所實作的介面。
PropertyManager	能夠分解屬性存取子的類別所實作的介面。
RecognizerResult	從辨識器傳回的值。
BotFrameworkSkill	註冊 BotFrameworkHttpProtocol 型技能端點。
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	儲存和擷取純舊 JSON 物件的儲存體提供者介面。
StoreItem	儲存在儲存體中並具有選擇性 eTag 的物件。
StoreItems	具名 `StoreItem` 物件的對應。
PagedResult	結果的頁面。
TranscriptInfo	預存文字記錄的中繼資料。
TranscriptLogger	文字記錄器會儲存交談的活動以進行召回。
TranscriptStore	文字記錄器會儲存交談的活動以進行召回。
IUserTokenProvider	適用于 BotAdapters 的使用者權杖 OAuth API 介面
TokenPollingSettings	提供權杖輪詢的詳細資料。

類型別名

BotHandler	描述 Bot 活動事件處理常式，以搭配 ActivityHandler 物件使用。
ConfigurationBotFrameworkAuthenticationOptions	包含用來設定 ConfigurationBotFrameworkAuthentication 實例的設定。
ConfigurationServiceClientCredentialFactoryOptions	包含用來設定 ConfigurationServiceClientCredentialFactory 實例的設定。
MiddlewareHandler	函式型中介軟體所實作的簽章。 `type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;`
StorageKeyFactory	回呼以計算儲存體金鑰。 `type StorageKeyFactory = (context: TurnContext) => Promise<string>;`
TestActivityInspector	函式的簽章，可用來檢查使用 `TestAdapter` 測試的 Bot 所傳回的個別活動。 `type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;`
DeleteActivityHandler	處理常式，可參與目前回合的刪除活動事件。
SendActivitiesHandler	處理常式，可參與目前回合的傳送活動事件。
UpdateActivityHandler	處理常式，可參與目前回合的更新活動事件。

列舉

Severity

定義事件的嚴重性層級。

函式

useBotState(BotAdapter, BotState[])	將中介軟體新增至配接器，以在回合內容上註冊一或多個 BotState 物件。中介軟體會在每次回合開始時，于回合內容上註冊狀態物件。
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	如果已實作BotPageViewTelemetryClient，請使用 BotTelemetryClient上的trackPageView方法來記錄DialogView。或者，透過 TrackTrace 將資訊記錄出來。
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	建立 ConfigurationBotFrameworkAuthentication 類別的新實例。
createServiceClientCredentialFactoryFromConfiguration(Configuration)	建立 ConfigurationServiceClientCredentialFactory 類別的新實例。
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	公用程式函式，用來計算的 `StoreItem` 變更雜湊。

函式詳細資料

useBotState(BotAdapter, BotState[])

將中介軟體新增至配接器，以在回合內容上註冊一或多個 BotState 物件。中介軟體會在每次回合開始時，于回合內容上註冊狀態物件。

function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter

參數

botAdapter: BotAdapter

要在其中註冊狀態物件的配接器。

botStates: BotState[]

要註冊的狀態物件。

傳回

BotAdapter

更新的配接器。

assertBotComponent(unknown, unknown[])

警告

此 API 現已淘汰。

Use BotComponent.z.parse() instead.

function assertBotComponent(val: unknown, _args: unknown[]): asserts

參數

val: unknown

_args: unknown[]

傳回

asserts

telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)

如果已實作BotPageViewTelemetryClient，請使用 BotTelemetryClient上的trackPageView方法來記錄DialogView。或者，透過 TrackTrace 將資訊記錄出來。

function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)

參數

telemetryClient: BotTelemetryClient

實作 BotTelemetryClient 的 TelemetryClient。

dialogName: string

要記錄專案/開始專案的對話方塊名稱。

properties: [key: string]: any

您可以用來搜尋和分類事件的具名字串值。

metrics: [key: string]: number

與此事件相關聯的度量。

createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

建立 ConfigurationBotFrameworkAuthentication 類別的新實例。

function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication

參數

configuration: Configuration

組態實例。

credentialsFactory: ServiceClientCredentialsFactory

ServiceClientCredentialsFactory實例。

authConfiguration: AuthenticationConfiguration

Configuration物件。

botFrameworkClientFetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>

要用於 BotFrameworkClient的自訂 Fetch 實作。

connectorClientOptions: ConnectorClientOptions

ConnectorClientOptions物件。

傳回

BotFrameworkAuthentication

ConfigurationBotFrameworkAuthentication實例。

備註

提供給建構函式的組態實例應該具有根目錄中所需的驗證值，並使用 ConfigurationBotFrameworkAuthenticationOptions 的屬性做為其金鑰。

createServiceClientCredentialFactoryFromConfiguration(Configuration)

建立 ConfigurationServiceClientCredentialFactory 類別的新實例。

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

參數

configuration: Configuration

組態實例。

傳回

ConfigurationServiceClientCredentialFactory

ConfigurationServiceClientCredentialFactory實例。

備註

提供給建構函式的組態實例應該具有根目錄中所需的驗證值，並使用 ConfigurationServiceClientCredentialFactoryOptions 的屬性作為其索引鍵。

assertStoreItems(unknown, unknown[])

警告

此 API 現已淘汰。

Use zod.record(zod.unknown()) instead.

function assertStoreItems(val: unknown, _args: unknown[]): asserts

參數

val: unknown

_args: unknown[]

傳回

asserts

calculateChangeHash(StoreItem)

公用程式函式，用來計算的 StoreItem 變更雜湊。

function calculateChangeHash(item: StoreItem): string

參數

item: StoreItem

要計算變更雜湊的專案。

傳回

string

變更雜湊字串

備註

此範例會計算已讀取之物件的變更雜湊，然後只有在修改後才會將它寫回：

// Calculate state objects initial hash
const hash = calculateChangeHash(state);

// Process the received activity
await processActivity(context, state);

// Save state if changed
if (calculateChangeHash(state) !== hash) {
   await storage.write({ 'botState': state });
}

共用方式為