BotFrameworkAdapter クラス

リファレンス

定義

名前空間:: Microsoft.Bot.Builder

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

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

重要

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

ボットをサービスエンドポイントに接続できるボットアダプター。

public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

type BotFrameworkAdapter = class
    inherit BotAdapter
    interface IAdapterIntegration
    interface IExtendedUserTokenProvider
    interface IUserTokenProvider
    interface IConnectorClientBuilder

Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider

継承: Object

BotAdapter
BotFrameworkAdapter

派生: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

実装: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

注釈

BotFrameworkAdapter は引き続きサポートされていますが、推奨されるアダプターは "CloudAdapter" です。ボットアダプターは認証プロセスをカプセル化し、Bot Connector Service との間でアクティビティを送受信します。ボットがアクティビティを受信すると、アダプターはコンテキストオブジェクトを作成し、それをボットのアプリケーションロジックに渡し、応答をユーザーのチャネルに返します。

Use(IMiddleware) を使用して、アダプターのミドルウェアコレクション IMiddleware オブジェクトを追加します。アダプターは、ボットミドルウェアパイプラインを介して受信アクティビティを処理し、ボットのロジックに誘導してから、もう一度戻します。各アクティビティがボットの内外を流れるにつれて、ミドルウェアの各部分は、ボットロジックが実行される前と後の両方で、アクティビティを検査または操作できます。

コンストラクター

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。

フィールド

BotIdentityKey	ボット ID キーの文字列値。 (継承元 BotAdapter)
InvokeResponseKey	TurnState 上にある InvokeResponseActivity のキー値。 (継承元 BotAdapter)
OAuthScopeKey	OAuth スコープキーの文字列値。 (継承元 BotAdapter)

プロパティ

AppCredentialMap	このアダプターの AppCredentials するアプリケーションのマップを取得します。
ChannelProvider	このアダプターのチャネルプロバイダーを取得します。
CredentialProvider	このアダプターの資格情報プロバイダーを取得します。
HttpClient	指定した場合、このアダプターのカスタム HttpClient を取得します。
Logger	このアダプターのロガーを取得します。
MiddlewareSet	アダプターのパイプライン内のミドルウェアのコレクションを取得します。 (継承元 BotAdapter)
OnTurnError	ミドルウェアまたはアプリケーションで例外をキャッチできるエラーハンドラーを取得または設定します。 (継承元 BotAdapter)

メソッド

BuildCredentialsAsync(String, String)	この HttpClient のトークンの取得に使用する AppCredentials オブジェクトを構築するロジック。
CanProcessOutgoingActivity(Activity)	サブクラスが送信アクティビティを処理することをオプトインする機会。
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	プロアクティブメッセージを会話に送信します。 (継承元 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	プロアクティブメッセージを会話に送信します。 (継承元 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	ボットから会話にプロアクティブメッセージを送信します。
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	ボットから会話にプロアクティブメッセージを送信します。
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	プロアクティブメッセージを会話に送信します。 (継承元 BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	ボットから会話にプロアクティブメッセージを送信します。
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	指定したチャネルに会話を作成します。
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	古い. 指定したチャネルに会話を作成します。オーバーロードは、テナントを含む ConversationReference を受け取ります。
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	指定したチャネルに会話を作成します。
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	古い. 指定したチャネルに会話を作成します。オーバーロードは、テナントを含む ConversationReference を受け取ります。
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	指定したチャネルに会話を作成します。 (継承元 BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	ボットの OAuth クライアントを作成します。
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	資格情報を使用してボットの OAuth クライアントを作成します。
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	会話内の既存のアクティビティを削除します。
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	現在の会話からメンバーを削除します。
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	シングルサインオンなどのトークン交換操作を実行します。
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	シングルサインオンなどのトークン交換操作を実行します。
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	カスタマイズされた AppCredentials を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	ボットの AppCredentials を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	特定のアクティビティのメンバーを一覧表示します。
GetConversationMembersAsync(ITurnContext, CancellationToken)	現在の会話のメンバーを一覧表示します。
GetConversationsAsync(ITurnContext, String, CancellationToken)	このボットが特定のチャネルサーバーに参加した会話を一覧表示します。チャネルサーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる `continuationToken` が含まれます。
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	このボットが特定のチャネルサーバーに参加した会話を一覧表示します。チャネルサーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる `continuationToken` が含まれます。
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	カスタマイズされた AppCredentials を使用して、接続名のサインインのためにユーザーに送信される未加工のサインインリンクを取得します。
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	カスタマイズされた AppCredentials を使用して、接続名のサインインのためにユーザーに送信される未加工のサインインリンクを取得します。
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	ボットの AppCredentials を使用して、接続名のサインインのためにユーザーに送信される生のサインインリンクを取得します。
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	ボットの AppCredentials を使用して、接続名のサインインのためにユーザーに送信される生のサインインリンクを取得します。
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	接続名のサインインのためにユーザーに送信される未加工のサインインリンクを取得します。
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	接続名のサインインのためにユーザーに送信される未加工のサインインリンクを取得します。
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	接続名のサインインのためにユーザーに送信される未加工のサインインリンクを取得します。
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	カスタマイズされた AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	ボットの AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	カスタマイズされた AppCredentials を使用して、ログインフロー内のユーザーのトークンの取得を試みます。
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	ボットの AppCredentials を使用して、ログインフロー内のユーザーのトークンの取得を試みます。
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	ターンコンテキストを作成し、受信アクティビティのミドルウェアパイプラインを実行します。
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	ターンコンテキストを作成し、受信アクティビティのミドルウェアパイプラインを実行します。
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	送信アクティビティを送信するカスタムロジック。サブクラスは、このメソッドを CanProcessOutgoingActivity と共にオーバーライドして、送信アクティビティを処理するカスタムロジックを持つことができます。
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	現在のボットターンのアクティビティ処理を開始します。 (継承元 BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	アクティビティを会話に送信します。
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	カスタマイズされた AppCredentials を使用して、トークンサーバーを使用してユーザーをサインアウトします。
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	ボットの AppCredentials を使用して、トークンサーバーでユーザーをサインアウトします。
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	会話内の既存のアクティビティを置き換えます。
Use(IMiddleware)	アダプターのパイプラインにミドルウェアを追加します。

明示的なインターフェイスの実装

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

ボットをサービスエンドポイントに接続できるボットアダプター。

拡張メソッド

UseBotState(BotAdapter, BotState[])	ターンコンテキストで 1 つ以上の BotState オブジェクトを登録するミドルウェアをアダプターに追加します。ミドルウェアは、各ターンの開始時にターンコンテキストに状態オブジェクトを登録します。
UseState(BotAdapter, UserState, ConversationState, Boolean)	古い. ユーザーと会話の状態オブジェクトをアダプターに登録します。これらのオブジェクトは、ターンコンテキストの TurnStateを介して使用できます。Get<T>() メソッド。
UseStorage(BotAdapter, IStorage)	ターンコンテキストで IStorage オブジェクトを登録するミドルウェアをアダプターに追加します。ミドルウェアは、各ターンの開始時にターンコンテキストに状態オブジェクトを登録します。

適用対象

次の方法で共有