BotAdapter クラス

リファレンス

定義

名前空間:: Microsoft.Bot.Builder

アセンブリ:: Microsoft.Bot.Builder.dll

パッケージ:: Microsoft.Bot.Builder v4.22.7

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public abstract class BotAdapter

type BotAdapter = class

Public MustInherit Class BotAdapter

継承: Object
BotAdapter

派生: Microsoft.Bot.Builder.Adapters.Facebook.FacebookAdapter

Microsoft.Bot.Builder.Adapters.Slack.SlackAdapter

Microsoft.Bot.Builder.Adapters.TestAdapter

Microsoft.Bot.Builder.Adapters.Twilio.TwilioAdapter

Microsoft.Bot.Builder.Adapters.Webex.WebexAdapter

その他…

注釈

ボットアダプターでは、認証プロセスのカプセル化、および 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 ターンコンテキストにオブジェクトを登録します。ミドルウェアは、各ターンの開始時にターンコンテキストに状態オブジェクトを登録します。

適用対象

次の方法で共有