botbuilder-core package

クラス

ActivityFactory	ActivityFactory はテキストを生成し、チャットダウンなどの単純なマークダウン セマンティクスを使用してアクティビティを作成します。
ActivityHandler	ボットのイベント生成アクティビティ ハンドラー。 ActivityHandlerBase拡張します。
ActivityHandlerBase	ボットのイベント生成アクティビティ ハンドラーのコア動作を定義します。
AutoSaveStateMiddleware	ターンの終了時に状態の変更を自動的に保存するミドルウェア。
BotAdapter	ボットをサービス エンドポイントに接続できるボット アダプターのコア動作を定義します。
BotComponent	サービス、カスタム アクション、メモリ スコープ、アダプターの登録を許可する BotComponent の定義。 コンポーネントをシステムで使用できるようにするには、BotComponent から派生し、サービスを登録して機能を追加します。 これらのコンポーネントは、必要なシステムによって適切な場所で使用されます。 Composer を使用する場合、コンポーネントが構成に登録されている限り、configureServices はボット ランタイムによってコンポーネントに対して自動的に呼び出されます。
BotState	フレームワークの状態の永続化スコープの基本クラス。
BotStatePropertyAccessor	StatePropertyAccessor インターフェイスの BotState 固有の実装。
BotStateSet	1 つのユニットとして並列に読み込むか、並列に保存する必要がある BotState プラグインのコレクション。 このクラスの実装については、AutoSaveStateMiddleware を参照してください。
NullTelemetryClient	BotTelemetryClient実装する null ボット テレメトリ クライアント。
BrowserLocalStorage	ブラウザーのローカル ストレージを使用するストレージ プロバイダー。
BrowserSessionStorage	ブラウザー セッション ストレージを使用するストレージ プロバイダー。
CardFactory	ボットが返すことができるさまざまなカードの種類を書式設定するためのメソッドを提供します。
CloudAdapterBase	Bot Framework プロトコルを実装し、パブリックとプライベートの両方の異なるクラウド環境でホストできるアダプター。
ComponentRegistration	ComponentRegistration は、コンポーネントから資産を検出するためのシグネチャ クラスです。
ConfigurationBotFrameworkAuthentication	認証値を持つオブジェクトまたは Configuration インスタンスから、BotFrameworkAuthentication インスタンスを作成します。
ConfigurationServiceClientCredentialFactory	ConfigurationServiceClientCredentialFactoryOptions または Configuration インスタンスを使用して、AppId とアプリ パスワードを使用して ServiceClientCredentials をビルドする ServiceClientCredentialsFactory。
ConversationState	ボットの会話状態を読み取り、ストレージに書き込みます。
InvokeException	呼び出し応答エラーのカスタム例外。
MemoryStorage	ボットのメモリ ベースのストレージ プロバイダー。
MemoryTranscriptStore	メモリ トランスクリプト ストアは、マップ内の揮発性メモリにトランスクリプトを格納します。
MessageFactory	ボットが返すことができるさまざまなメッセージの種類の書式設定を支援するユーティリティ関数のセット。
MiddlewareSet	Middleware プラグインのセット。
PrivateConversationState	ボットの PrivateConversation 状態を読み取り、ストレージに書き込みます。
QueueStorage	後で処理するためにアクティビティをエンキューするための基本クラス。
RegisterClassMiddleware	現在のターン コンテキストにオブジェクトを追加したり、サービスを登録したりするためのミドルウェア。
ShowTypingMiddleware	メッセージごとに入力インジケーターを自動的に送信するミドルウェア。
SkillConversationIdFactory	ConversationReference インスタンス 格納および取得する SkillConversationIdFactory。
SkillConversationIdFactoryBase	スキル会話用の一意の会話 ID を作成するために使用されるファクトリのメソッドを定義します。
SkypeMentionNormalizeMiddleware	想定される値に準拠していないため、Skype のメンション エンティティにパッチを適用するミドルウェア。 Skype と対話するボットでは、メンションが使用されている場合は、このミドルウェアを使用する必要があります。
StringUtils	文字列ユーティリティ メソッドを含むヘルパー クラス。
TelemetryConstants	BotTelemetryClient オブジェクトで使用する共通プロパティの名前を定義します。
TelemetryLoggerMiddleware	受信、送信、更新、または削除されたアクティビティ メッセージをログに記録するためのミドルウェア。 botTelemetryClient インターフェイスを使用します。
TestAdapter	単体テストに使用されるテスト アダプター。 このアダプターは、ユーザーからボットへのメッセージ送信をシミュレートするために使用できます。
TestFlow	一連のテストの単純な構築を可能にする TestAdapter のサポート クラス。
ConsoleTranscriptLogger	ConsoleTranscriptLogger は、アクティビティをコンソール出力に書き込みます。
TranscriptLoggerMiddleware	受信アクティビティと送信アクティビティを TranscriptStore にログに記録します。
TurnContext	ボットのターンのコンテキストを提供します。
TurnContextStateCollection	TurnContextの一部としてターンの有効期間中保持される値。
UserState	ボットのユーザー状態を読み取り、ストレージに書き込みます。

インターフェイス

CachedBotState	BotState インスタンスによってコンテキスト オブジェクトからキャッシュされた状態情報。
StatePropertyAccessor	BotState オブジェクトで作成された状態プロパティにアクセスするためのメソッドを定義します。
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	@azure/ms-rest-js からの "WebResource" を表す内部インターフェイス
ExtendedUserTokenProvider	BotAdapters のユーザー トークン OAuth シングル サインオンとトークン交換 API のインターフェイス
IntentScore	スコアを付け、意図に関する追加情報を追加します。
Middleware	オブジェクト ベースのミドルウェアによって実装されるインターフェイス。
PropertyManager	プロパティ アクセサーを考慮できるクラスによって実装されるインターフェイス。
RecognizerResult	認識エンジンから返される値。
BotFrameworkSkill	BotFrameworkHttpProtocol ベースのスキル エンドポイントの登録。
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	プレーンな古い JSON オブジェクトを格納および取得するストレージ プロバイダーのインターフェイス。
StoreItem	オプションの eTag を使用して Storage に格納されるオブジェクト。
StoreItems	名前付き StoreItem オブジェクトのマップ。
PagedResult	結果のページ。
TranscriptInfo	保存されているトランスクリプトのメタデータ。
TranscriptLogger	トランスクリプト ロガーは、取り消しのために会話のアクティビティを格納します。
TranscriptStore	トランスクリプト ロガーは、取り消しのために会話のアクティビティを格納します。
IUserTokenProvider	BotAdapters のユーザー トークン OAuth API のインターフェイス
TokenPollingSettings	トークンポーリングの詳細を提供します。

型エイリアス

BotHandler	ActivityHandler オブジェクトで使用するボット アクティビティ イベント ハンドラーについて説明します。
ConfigurationBotFrameworkAuthenticationOptions	ConfigurationBotFrameworkAuthentication インスタンスの構成に使用される設定が含まれています。
ConfigurationServiceClientCredentialFactoryOptions	ConfigurationServiceClientCredentialFactory インスタンスの構成に使用される設定が含まれています。
MiddlewareHandler	関数ベースのミドルウェアによって実装されるシグネチャ。 type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
StorageKeyFactory	ストレージ キーを計算するためのコールバック。 type StorageKeyFactory = (context: TurnContext) => Promise<string>;
TestActivityInspector	TestAdapterを使用してテストされているボットによって返される個々のアクティビティを検査するために使用できる関数のシグネチャ。 type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	現在のターンの削除アクティビティ イベントに参加できるハンドラー。
SendActivitiesHandler	現在のターンの送信アクティビティ イベントに参加できるハンドラー。
UpdateActivityHandler	現在のターンの更新アクティビティ イベントに参加できるハンドラー。

列挙型

Severity

イベントの重大度レベルを定義します。

関数

useBotState(BotAdapter, BotState[])	ターン コンテキストで 1 つ以上の 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[])

ターン コンテキストで 1 つ以上の 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

Configuration インスタンス。

credentialsFactory

ServiceClientCredentialsFactory

ServiceClientCredentialsFactory インスタンス。

authConfiguration

AuthenticationConfiguration

Configuration オブジェクト。

botFrameworkClientFetch

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

BotFrameworkClientで使用するカスタム フェッチ実装。

connectorClientOptions

ConnectorClientOptions

ConnectorClientOptions オブジェクト。

戻り値

BotFrameworkAuthentication

ConfigurationBotFrameworkAuthentication インスタンス。

注釈

コンストラクターに提供される Configuration インスタンスには、ConfigurationBotFrameworkAuthenticationOptions のプロパティをキーとして使用して、必要な認証値をルートで使用できる必要があります。

createServiceClientCredentialFactoryFromConfiguration(Configuration)

ConfigurationServiceClientCredentialFactory クラスの新しいインスタンスを作成します。

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

パラメーター

configuration

Configuration

Configuration インスタンス。

戻り値

ConfigurationServiceClientCredentialFactory

ConfigurationServiceClientCredentialFactory インスタンス。

注釈

コンストラクターに提供される Configuration インスタンスには、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 });
}