botbuilder package
クラス
| BotFrameworkAdapter | |
| BotFrameworkHttpClient | |
| ChannelServiceHandler | |
| ChannelServiceHandlerBase |
ChannelServiceHandlerBase は、アクティビティをスキルに転送する API を実装し、ボット/アダプターを介してスキルから ChannelAPI 呼び出しをルーティングすることを実装します。 |
| ChannelServiceRoutes |
ChannelServiceHandler メソッドを使用して API 呼び出しをルーティングします。 |
| CloudAdapter |
Bot Framework プロトコルを実装し、パブリックとプライベートの両方の異なるクラウド環境でホストできるアダプター。 |
| CloudChannelServiceHandler |
BotFrameworkAuthenticationを使用した Bot Framework プロトコル |
| EventFactory |
さまざまなイベントの種類を作成するためのユーティリティ メソッドが含まれています。 |
| FileTranscriptStore |
ファイル トランスクリプト ストアは、各アクティビティをファイルとして含むファイル システムにトランスクリプトを格納します。 |
| HandoffEventNames |
ハンドオフ イベント名の値を定義します。 |
| InspectionMiddleware |
実行時アクティビティと BotState のエミュレーター検査用の InspectionMiddleware。 |
| InspectionState |
実行時アクティビティと BotState のエミュレーター検査に InspectionMiddleware で使用する InspectionState。 |
| RouteConstants |
basePath の直後にある API パスを表す定数。 これらは現在内部的ですが、今後、パブリックにすることを再評価します。 例 RouteConstants.Activities = '/v3/conversations/:conversationId/activities'。 |
| SetSpeakMiddleware |
Activity Speak プロパティに適切な SSML タグが設定されるように、DirectLine 音声チャネルとテレフォニー チャネルをサポートします。 |
| CloudSkillHandler |
スキルの Bot Framework ハンドラー。 |
| SkillHandler | |
| SkillHandlerImpl | |
| SkillHttpClient |
会話 ID の生成をカプセル化するスキルに特化した BotFrameworkHttpClient。 |
| StatusCodeError |
エラーを拡張して、特殊なエラー メッセージを提供します。 |
| StreamingHttpClient |
ストリーミング接続との互換性を追加する |
| TokenResolver |
アクティビティの添付ファイルで OAuthCard を検索し、それらに対してアクションを実行します |
| TeamsSSOTokenExchangeMiddleware |
アクティビティ名が signin/tokenExchange の場合、このミドルウェアはトークンの交換を試み、着信呼び出しを重複除去して、1 つの交換要求のみが処理されるようにします。 ユーザーが複数の Teams クライアントにサインインしている場合、ボットは各クライアントから "signin/tokenExchange" を受け取る可能性があります。 特定のユーザー ログインに対する各トークン交換要求には、同じ activity.value.id があります。 これらのトークン交換要求の 1 つだけをボットで処理する必要があります。 その他は StatusCodes.PRECONDITION_FAILEDを返します。 運用環境の分散ボットの場合、これには分散ストレージが必要であり、トークン交換が 1 つだけ処理されます。 このミドルウェアは、botbuilder-azure 内にある CosmosDb ストレージ、またはローカル開発用の MemoryStorage をサポートしています。 |
| TeamsActivityHandler |
特定のイベントと操作Microsoft Teamsサポートを追加します。 |
| TeamsInfo |
Microsoft Teams内で発生するイベントと相互作用のユーティリティ メソッドを提供します。 |
インターフェイス
| BotFrameworkAdapterSettings | |
| BotFrameworkHttpAdapter | |
| WebServer |
Express アプリケーションまたは Restify Server を表すインターフェイス。 |
| ConnectorClientBuilder |
コネクタ クライアントを構築するための抽象化。 |
| Request |
最小限の使用プロパティを含む、Node.js HTTP 要求を表します。 Restify、Express、Node.js コア http と互換性があります。 |
| Response | |
| WebRequest |
Express または Restify 要求オブジェクトを表します。 このインターフェイスはフレームワークをサポートしており、コードに対して直接呼び出されるものではありません。 |
| WebResponse |
Express または Restify 応答オブジェクトを表します。 このインターフェイスはフレームワークをサポートしており、コードに対して直接呼び出されるものではありません。 |
型エイリアス
| RouteHandler |
関数
| validate |
アクティビティの を検証し、タイムスタンプ フィールドを書式設定します。 |
| teams |
Teams のアクティビティ ヘルパー メソッド。 |
| teams |
現在のアクティビティからチームの選択したチャネル ID を取得します。 |
| teams |
現在の アクティビティからチーム ID を取得します。 |
| 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
現在の アクティビティチームのチャネル ID (null)。
teamsGetSelectedChannelId(Activity)
現在のアクティビティからチームの選択したチャネル ID を取得します。
function teamsGetSelectedChannelId(activity: Activity): stringパラメーター
- activity
-
Activity
現在の アクティビティ。
戻り値
string
現在のアクティビティのチームが選択したチャネル、または空の文字列。
teamsGetTeamId(Activity)
現在の アクティビティからチーム ID を取得します。
function teamsGetTeamId(activity: Activity): string | nullパラメーター
- activity
-
Activity
現在の アクティビティ。
戻り値
string | null
現在の アクティビティ's team's ID(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。 マニフェストの有効なドメインに含める必要があります。