BotFrameworkAdapter クラス

public static final String CONNECTOR_CLIENT_KEY

ConnectorClient を格納するキー。

public static final String INVOKE_RESPONSE_KEY

InvokeResponse を格納するキー。

public static final String TEAMSCONNECTOR_CLIENT_KEY

TeamsConnectorClient を格納するためのキー。 テスト専用。

public BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。

パラメーター:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。

パラメーター:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。

パラメーター:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

資格情報プロバイダーを使用して、BotFrameworkAdapter クラスの新しいインスタンスを初期化します。

パラメーター:

protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

ConnectorClient をキャッシュに挿入します。 単体テストのみ。

パラメーター:

protected CompletableFuture buildAppCredentials(String appId, String scope)

指定した appId とスコープの AppCredentials オブジェクトを作成します。

パラメーター:

戻り値:

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

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

メッセージを会話に事前に送信するには、このメソッドを呼び出します。 ほとんどのチャネルでは、ボットがユーザーにアクティビティを送信する前に、ユーザーがボットとの会話を開始する必要があります。

上書き:

パラメーター:

戻り値:

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

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

メッセージを会話に事前に送信するには、このメソッドを呼び出します。 ほとんどのチャネルでは、ボットがユーザーにアクティビティを送信する前に、ユーザーがボットとの会話を開始する必要があります。

上書き:

パラメーター:

戻り値:

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

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

メッセージを会話に事前に送信するには、このメソッドを呼び出します。 ほとんどのチャネルでは、ボットがユーザーにアクティビティを送信する前に、ユーザーがボットとの会話を開始する必要があります。

このオーバーロードは、BotId を渡す必要があり、Node の実装とは異なります。 .Net コードを使用すると、Node でサポートされていない複数のボットを 1 つのアダプターでホストできます。

processActivity(String authHeader, Activity activity, BotCallbackHandler callback) runPipeline(TurnContext context, BotCallbackHandler callback)

上書き:

パラメーター:

戻り値:

public CompletableFuture createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

コネクタ クライアントを非同期で作成します。

パラメーター:

戻り値:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

指定したチャネルに会話を作成します。 会話を開始するには、ボットがそのアカウント情報と、そのチャネルのユーザーのアカウント情報を知っている必要があります。 ほとんどのチャネルでは、直接メッセージ (グループ以外) の会話の開始のみがサポートされます。

アダプターはチャネルで新しい会話を作成し、ミドルウェア パイプラインを介して conversationUpdate アクティビティを callback メソッドに送信します。

指定したユーザーとの会話が確立されている場合、アクティビティの Activity#getConversation の ID には新しい会話の ID が含まれます。

パラメーター:

戻り値:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

指定したチャネルに会話を作成します。 会話を開始するには、ボットがそのアカウント情報と、そのチャネルのユーザーのアカウント情報を知っている必要があります。 ほとんどのチャネルでは、直接メッセージ (グループ以外) の会話の開始のみがサポートされます。

アダプターはチャネルで新しい会話を作成し、ミドルウェア パイプラインを介して conversationUpdate アクティビティを callback メソッドに送信します。

指定したユーザーとの会話が確立されている場合、アクティビティの Activity#getConversation の ID には新しい会話の ID が含まれます。

パラメーター:

戻り値:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

ボットの OAuth クライアントを作成します。

注: これは主に保護されているため、単体テストをオーバーライドしてモック OAuthClient を提供できます。

パラメーター:

戻り値:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

会話内の既存のアクティビティを削除します。

上書き:

パラメーター:

戻り値:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

現在の会話からメンバーを削除します。

パラメーター:

戻り値:

public CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

シングル サインオンなどのトークン交換操作を実行します。

パラメーター:

戻り値:

public CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

シングル サインオンなどのトークン交換操作を実行します。

パラメーター:

戻り値:

public CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

カスタマイズされた AppCredentials を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

パラメーター:

戻り値:

public CompletableFuture> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

パラメーター:

戻り値:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

特定のアクティビティのメンバーを一覧表示します。

パラメーター:

戻り値:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

特定のアクティビティのメンバーを一覧表示します。

パラメーター:

戻り値:

protected Map getConnectorClientCache()

ConnectorClient キャッシュを取得します。 単体テスト用。

戻り値:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

現在の会話のメンバーを一覧表示します。

パラメーター:

戻り値:

public CompletableFuture getConversations(TurnContextImpl context)

このボットが特定のチャネル サーバーに参加した会話を一覧表示します。 チャネル サーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる "continuationToken" が含まれます。 このオーバーロードは、標準のアクティビティ処理中に呼び出される場合があります。この時点で、現在のアクティビティ処理パイプラインの一部であるボットのサービス URL と資格情報が使用されます。

パラメーター:

戻り値:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

このボットが特定のチャネル サーバーに参加した会話を一覧表示します。 チャネル サーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる "continuationToken" が含まれます。 このオーバーロードは、標準のアクティビティ処理中に呼び出される場合があります。この時点で、現在のアクティビティ処理パイプラインの一部であるボットのサービス URL と資格情報が使用されます。

パラメーター:

戻り値:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

このボットが特定のチャネル サーバーに参加した会話を一覧表示します。 チャネル サーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる "continuationToken" が含まれます。

パラメーター:

戻り値:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

このボットが特定のチャネル サーバーに参加した会話を一覧表示します。 チャネル サーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる "continuationToken" が含まれます。 このオーバーロードは、ボットの ServiceUrl と資格情報のみが必要であり、会話のコンテキストの外部から呼び出される場合があります。

パラメーター:

戻り値:

protected Map getCredentialsCache()

AppCredentials キャッシュを取得します。 単体テスト用。

戻り値:

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

カスタマイズされた AppCredentials を使用して、接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

ボットの AppCredentials を使用して、接続名のサインインのためにユーザーに送信される生のサインイン リンクを取得します。

パラメーター:

戻り値:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

キャッシュまたは新しく作成された ConnectorClient を返します。

注: これは主に単体テストでこれをオーバーライドしてモック ConnectorClient を提供できるようにするために保護されています

パラメーター:

戻り値:

public CompletableFuture getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

パラメーター:

戻り値:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

カスタマイズされた AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。

パラメーター:

戻り値:

public CompletableFuture> getTokenStatus(TurnContext context, String userId, String includeFilter)

特定のユーザーに対して構成された各接続のトークンの状態を取得します。

パラメーター:

戻り値:

public CompletableFuture getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

カスタマイズされた AppCredentials を使用して、ログイン フロー内のユーザーのトークンの取得を試みます。

パラメーター:

戻り値:

public CompletableFuture getUserToken(TurnContext context, String connectionName, String magicCode)

ログイン フロー内のユーザーのトークンの取得を試みます。

パラメーター:

戻り値:

protected static String keyForAppCredentials(String appId, String scope)

アプリ資格情報キャッシュにアクセスするためのキーを生成します。

パラメーター:

戻り値:

protected static String keyForConnectorClient(String serviceUrl, String appId, String scope)

コネクタ クライアント キャッシュにアクセスするためのキーを生成します。

パラメーター:

戻り値:

public CompletableFuture processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

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

パラメーター:

戻り値:

public CompletableFuture processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

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

パラメーター:

戻り値:

public CompletableFuture sendActivities(TurnContext context, List activities)

アクティビティを会話に送信します。

上書き:

パラメーター:

戻り値:

     <xref uid="com.microsoft.bot.builder.TurnContext.onSendActivities(com.microsoft.bot.builder.SendActivitiesHandler)" data-throw-if-not-resolved="false" data-raw-source="TurnContext#onSendActivities(SendActivitiesHandler)"></xref>

public CompletableFuture signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId)

カスタマイズされた AppCredentials を使用して、トークン サーバーを使用してユーザーをサインアウトします。

パラメーター:

戻り値:

public CompletableFuture signOutUser(TurnContext context, String connectionName, String userId)

トークン サーバーを使用してユーザーをサインアウトします。

パラメーター:

戻り値:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

会話内の既存のアクティビティを置き換えます。

上書き:

パラメーター:

戻り値:

public BotFrameworkAdapter use(Middleware middleware)

アダプターのパイプラインにミドルウェアを追加します。 ミドルウェアは初期化時にアダプターに追加されます。 各ターンについて、アダプターはミドルウェアを追加した順序でミドルウェアを呼び出します。

上書き:

パラメーター:

戻り値: