BotAdapter クラス

定義

ボットをサービス エンドポイントに接続できるボット アダプターを表します。 このクラスは抽象クラスです。

public abstract class BotAdapter
type BotAdapter = class
Public MustInherit Class BotAdapter
継承
BotAdapter
派生

注釈

ボット アダプターでは、認証プロセスのカプセル化、および Bot Connector Service との間でのアクティビティの送受信が行われます。 ボットがアクティビティを受信すると、アダプターによってコンテキスト オブジェクトが作成され、ボットのアプリケーション ロジックに渡され、応答がユーザーのチャネルに返されます。

アダプターのミドルウェア コレクションにオブジェクトを追加IMiddlewareするには、 を使用Use(IMiddleware)します。 アダプターは、ボットのミドルウェア パイプラインを通ってボットのロジックに入ってきた後、また出ていくアクティビティを処理および管理します。 各アクティビティがボットを出入りして流れる際、ボット ロジックの実行前と実行後のどちらでも、各ミドルウェアがアクティビティを検査または操作できます。

コンストラクター

BotAdapter()

BotAdapter クラスの新しいインスタンスを初期化します。

フィールド

BotIdentityKey

ボット ID キーの文字列値。

InvokeResponseKey

TurnState 上にある InvokeResponseActivity のキー値。

OAuthScopeKey

OAuth スコープ キーの文字列値。

プロパティ

MiddlewareSet

アダプターのパイプライン内のミドルウェアのコレクションを取得します。

OnTurnError

ミドルウェアまたはアプリケーションの例外をキャッチできるエラー ハンドラーを取得または設定します。

メソッド

ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)

プロアクティブ メッセージを会話に送信します。

CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)

指定したチャネルに会話を作成します。

DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)

派生クラスでオーバーライドされると、会話内の既存のアクティビティを削除します。

ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)

ターン コンテキストを作成し、受信 TRUSTED アクティビティのミドルウェア パイプラインを実行します。

RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)

現在のボット ターンのアクティビティ処理を開始します。

SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)

派生クラスでオーバーライドされると、アクティビティが会話に送信されます。

UpdateActivityAsync(ITurnContext, Activity, CancellationToken)

派生クラスでオーバーライドされた場合、会話内の既存のアクティビティを置き換えます。

Use(IMiddleware)

アダプターのパイプラインにミドルウェアを追加します。

拡張メソッド

UseBotState(BotAdapter, BotState[])

アダプターにミドルウェアを追加して、ターン コンテキストに 1 つ以上 BotState のオブジェクトを登録します。 ミドルウェアは、各ターンの開始時にターン コンテキストに状態オブジェクトを登録します。

UseState(BotAdapter, UserState, ConversationState, Boolean)
古い.

ユーザーと会話の状態オブジェクトをアダプターに登録します。 これらのオブジェクトは、ターン コンテキストの TurnState.Get<T>() メソッドを使用して使用できます。

UseStorage(BotAdapter, IStorage)

アダプターにミドルウェアを追加して、 IStorage ターン コンテキストにオブジェクトを登録します。 ミドルウェアは、各ターンの開始時にターン コンテキストに状態オブジェクトを登録します。

適用対象

こちらもご覧ください