BotFrameworkAdapter クラス

パッケージ:

com.microsoft.bot.builder

Maven 成果物:

com.microsoft.bot:bot-builder:4.14.3

• java.lang.Object
• • com.microsoft.bot.builder.BotAdapter
  • • com.microsoft.bot.builder.BotFrameworkAdapter

実装

ConnectorClientBuilder UserTokenProvider AdapterIntegration

public class BotFrameworkAdapter
extends BotAdapter
implements AdapterIntegration, UserTokenProvider, ConnectorClientBuilder

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

adapter\u2019s ミドルウェア コレクションにオブジェクトを追加Middlewareするには、 を使用use(Middleware middleware)します。 アダプターは、ボット ミドルウェア パイプラインを介して受信アクティビティを処理し、bot\u2019s ロジックに転送してから、もう一度戻します。 各アクティビティがボットを出入りして流れる際、ボット ロジックの実行前と実行後のどちらでも、各ミドルウェアがアクティビティを検査または操作できます。

TurnContext Activity Bot Middleware

フィールドの概要

修飾子と型	フィールドと説明
static final java.lang.String	CONNECTOR_CLIENT_KEY コネクタクライアントを格納するキー。
static final java.lang.String	INVOKE_RESPONSE_KEY 呼び出し応答を格納するキー。
static final java.lang.String	TEAMSCONNECTOR_CLIENT_KEY Teamsコネクタクライアントを格納するためのキー。

コンストラクターの概要

コンストラクター	説明
BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	資格情報プロバイダーを使用して、 クラスの BotFrameworkAdapter 新しいインスタンスを初期化します。
BotFrameworkAdapter(CredentialProvider withCredentialProvider)	資格情報プロバイダーを使用して、 クラスの BotFrameworkAdapter 新しいインスタンスを初期化します。
BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	資格情報プロバイダーを使用して、 クラスの BotFrameworkAdapter 新しいインスタンスを初期化します。
BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	資格情報プロバイダーを使用して、 クラスの BotFrameworkAdapter 新しいインスタンスを初期化します。

メソッドの概要

修飾子と型	メソッドと説明
protected void	addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client) コネクタクライアントをキャッシュに挿入します。
protected java.util.concurrent.CompletableFuture<AppCredentials>	buildAppCredentials(String appId, String scope) 指定したアプリID とスコープの AppCredentials オブジェクトを作成します。
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback) プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback) プロアクティブ メッセージを会話に送信します。
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) ボットから会話にプロアクティブ メッセージを送信します。
java.util.concurrent.CompletableFuture<ConnectorClient>	createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience) コネクタ クライアントを非同期に作成します。
java.util.concurrent.CompletableFuture<java.lang.Void>	createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback) 指定したチャネルに会話を作成します。
java.util.concurrent.CompletableFuture<java.lang.Void>	createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference) 指定したチャネルに会話を作成します。
protected java.util.concurrent.CompletableFuture<OAuthClient>	createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials) ボットの OAuth クライアントを作成します。
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(TurnContext context, ConversationReference reference) 会話内の既存のアクティビティを削除します。
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteConversationMember(TurnContextImpl context, String memberId) 現在の会話からメンバーを削除します。
java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest) シングル サインオンなどのトークン交換操作を実行します。
java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest) シングル サインオンなどのトークン交換操作を実行します。
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId) カスタマイズされたアプリ資格情報を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId) 構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getActivityMembers(TurnContextImpl context) 特定のアクティビティのメンバーを一覧表示します。
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getActivityMembers(TurnContextImpl context, String activityId) 特定のアクティビティのメンバーを一覧表示します。
protected java.util.Map<java.lang.String,ConnectorClient>	getConnectorClientCache() コネクタクライアント キャッシュを取得します。
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getConversationMembers(TurnContextImpl context) 現在の会話のメンバーを一覧表示します。
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(TurnContextImpl context) このボットが特定のチャネル サーバーに参加した会話を一覧表示します。
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(TurnContextImpl context, String continuationToken) このボットが特定のチャネル サーバーに参加した会話を一覧表示します。
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(String serviceUrl, MicrosoftAppCredentials credentials) このボットが特定のチャネル サーバーに参加した会話を一覧表示します。
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken) このボットが特定のチャネル サーバーに参加した会話を一覧表示します。
protected java.util.Map<java.lang.String,AppCredentials>	getCredentialsCache() アプリ資格情報キャッシュを取得します。
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName) カスタマイズされたアプリ資格情報を使用して、接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) ボットのアプリ資格情報を使用して、接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, String connectionName) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
protected java.util.concurrent.CompletableFuture<ConnectorClient>	getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials) キャッシュまたは新しく作成されたコネクタクライアントを返します。
java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter) カスタマイズされたアプリ資格情報を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。
java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, String userId, String includeFilter) 特定のユーザーに対して構成された各接続のトークンの状態を取得します。
java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode) カスタマイズされたアプリ資格情報を使用して、ログイン フロー内のユーザーのトークンの取得を試みます。
java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext context, String connectionName, String magicCode) ログイン フロー内のユーザーのトークンの取得を試みます。
protected static java.lang.String	keyForAppCredentials(String appId, String scope) アプリ資格情報キャッシュにアクセスするためのキーを生成します。
protected static java.lang.String	keyForConnectorClient(String serviceUrl, String appId, String scope) コネクタ クライアント キャッシュにアクセスするためのキーを生成します。
java.util.concurrent.CompletableFuture<InvokeResponse>	processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback) ターン コンテキストを作成し、受信アクティビティのミドルウェア パイプラインを実行します。
java.util.concurrent.CompletableFuture<InvokeResponse>	processActivity(String authHeader, Activity activity, BotCallbackHandler callback) ターン コンテキストを作成し、受信アクティビティのミドルウェア パイプラインを実行します。
java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(TurnContext context, List<Activity> activities) 会話にアクティビティを送信します。
java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId) カスタマイズされたアプリ資格情報を使用して、トークン サーバーを使用してユーザーをサインアウトします。
java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext context, String connectionName, String userId) トークン サーバーを使用してユーザーをサインアウトします。
java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(TurnContext context, Activity activity) 会話内の既存のアクティビティを置き換えます。
BotFrameworkAdapter	use(Middleware middleware) アダプターのパイプラインにミドルウェアを追加します。

メソッドの継承元: BotAdapter

continueConversation continueConversation continueConversation continueConversation continueConversation continueConversation deleteActivity getMiddlewareSet getOnTurnError runPipeline sendActivities setOnTurnError updateActivity use

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

フィールドの詳細

CONNECTOR_CLIENT_KEY

public static final String CONNECTOR_CLIENT_KEY

ConnectorClient を格納するキー。

INVOKE_RESPONSE_KEY

public static final String INVOKE_RESPONSE_KEY

InvokeResponse を格納するキー。

TEAMSCONNECTOR_CLIENT_KEY

public static final String TEAMSCONNECTOR_CLIENT_KEY

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

コンストラクターの詳細

BotFrameworkAdapter

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

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

Parameters:

withCredentials - 使用する資格情報。

withAuthConfig - 認証の構成。

withChannelProvider - チャネル プロバイダー。

withRetryStrategy - HTTP 操作を再試行するための再試行ポリシー。

withMiddleware - アダプターに最初に追加するミドルウェア。

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

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

Parameters:

withCredentialProvider - 資格情報プロバイダー。

BotFrameworkAdapter

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

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

Parameters:

withCredentialProvider - 資格情報プロバイダー。

withAuthConfig - 認証の構成。

withChannelProvider - チャネル プロバイダー。

withRetryStrategy - HTTP 操作を再試行するための再試行ポリシー。

withMiddleware - アダプターに最初に追加するミドルウェア。

BotFrameworkAdapter

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

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

Parameters:

withCredentialProvider - 資格情報プロバイダー。

withChannelProvider - チャネル プロバイダー。

withRetryStrategy - HTTP 操作を再試行するための再試行ポリシー。

withMiddleware - アダプターに最初に追加するミドルウェア。

メソッドの詳細

addConnectorClientToCache

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

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

Parameters:

serviceUrl - サービス URL

appId - アプリが行った

scope - スコープ

client - 挿入する ConnectorClient。

buildAppCredentials

protected CompletableFuture buildAppCredentials(String appId, String scope)

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

Parameters:

appId - appId。

scope - スコープ。

Returns:

AppCredentials オブジェクト。

continueConversation

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

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

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

Overrides:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Parameters:

claimsIdentity - 会話の ClaimsIdentity 参照。

reference - 続行する会話への参照。

callback - 結果ボットターンを呼び出すメソッド。

Returns:

実行するキューに登録された作業を表すタスク。

continueConversation

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

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

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

Overrides:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Parameters:

claimsIdentity - 会話の ClaimsIdentity 参照。

reference - 続行する会話への参照。

audience - プロアクティブ メッセージの受信者を示す値。

callback - 結果ボットターンを呼び出すメソッド。

Returns:

実行するキューに登録された作業を表すタスク。

continueConversation

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)

Overrides:

BotFrameworkAdapter.continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Parameters:

botAppId - ボットのアプリケーション ID。 これはポータル登録によって返される appId であり、通常は appSettings.json の "MicrosoftAppId" パラメーターにあります。

reference - 続行する会話への参照。

callback - 結果のボット ターンを呼び出すメソッド。

Returns:

実行するキューに登録された作業を表すタスク。

createConnectorClient

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

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

Parameters:

serviceUrl - サービス URL。

claimsIdentity - 要求 ID。

audience - コネクタの対象ユーザー。

Returns:

ConnectorClient インスタンス。

createConversation

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

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

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

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

Parameters:

channelId - チャネルの ID。

serviceUrl - チャネルのサービス URL エンドポイント。

credentials - ボットのアプリケーション資格情報。

conversationParameters - 会話の作成に使用する会話情報。

callback - 結果のボット ターンを呼び出すメソッド。

Returns:

実行するキューに登録された作業を表すタスク。

createConversation

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

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

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

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

Parameters:

channelId - チャネルの ID。

serviceUrl - チャネルのサービス URL エンドポイント。

credentials - ボットのアプリケーション資格情報。

conversationParameters - 会話の作成に使用する会話情報。

callback - 結果のボット ターンを呼び出すメソッド。

reference - テナントを含む会話参照。

Returns:

実行するキューに登録された作業を表すタスク。

createOAuthAPIClient

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

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

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

Parameters:

turnContext - 現在のターンのコンテキスト オブジェクト。

oAuthAppCredentials - クライアントの作成時に使用する資格情報。 null の場合は、既定の資格情報が使用されます。

Returns:

ボットの OAuth クライアント。

deleteActivity

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

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

Overrides:

BotFrameworkAdapter.deleteActivity(TurnContext context, ConversationReference reference)

Parameters:

context - ターンのコンテキスト オブジェクト。

reference - 削除するアクティビティの会話参照。

Returns:

実行するキューに登録された作業を表すタスク。 onDeleteActivity(DeleteActivityHandler handler)

deleteConversationMember

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

memberId - 会話から削除するメンバーの ID

Returns:

実行するキューに登録された作業を表すタスク。

exchangeToken

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

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられているユーザー ID。.

exchangeRequest - 交換要求の詳細。交換するトークンまたは交換する URI。

Returns:

タスクが完了すると、交換されたトークンが返されます。

exchangeToken

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

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられているユーザー ID。.

exchangeRequest - 交換要求の詳細。交換するトークンまたは交換する URI。

Returns:

タスクが完了すると、交換されたトークンが返されます。

getAadTokens

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - このボットで構成された Azure Active Directory 接続の名前。

resourceUrls - トークンを取得するリソース URL の一覧。

userId - トークンを取得するユーザー ID。 null を渡すと、UserId は TurnContext のアクティビティから取得されます。

Returns:

対応する TokenResponse への resourceUrl の Dictionary。

getAadTokens

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - このボットで構成された Azure Active Directory 接続の名前。

resourceUrls - トークンを取得するリソース URL の一覧。

userId - トークンを取得するユーザー ID。 null を渡すと、UserId は TurnContext のアクティビティから取得されます。

Returns:

resourceUrl を対応する にマップします TokenResponse。

getActivityMembers

public CompletableFuture<>> getActivityMembers(TurnContextImpl context)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

Returns:

アクティビティのメンバーの一覧

getActivityMembers

public CompletableFuture<>> getActivityMembers(TurnContextImpl context, String activityId)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

activityId - (省略可能)列挙するアクティビティ ID。 指定しない場合は、現在のアクティビティ ID が使用されます。

Returns:

アクティビティのメンバーの一覧

getConnectorClientCache

protected Map getConnectorClientCache()

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

Returns:

ConnectorClient キャッシュ。

getConversationMembers

public CompletableFuture<>> getConversationMembers(TurnContextImpl context)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

Returns:

現在の会話のメンバーの一覧

getConversations

public CompletableFuture getConversations(TurnContextImpl context)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

Returns:

現在の会話のメンバーの一覧

getConversations

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

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

Parameters:

context - ターンのコンテキスト オブジェクト。

continuationToken - 結果の前のページからの継続トークン。

Returns:

現在の会話のメンバーの一覧

getConversations

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

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

Parameters:

serviceUrl - クエリを実行するチャネル サーバーの URL。 これは から context.activity.serviceUrl取得できます。

credentials - ボットが .services() に接続するために必要な資格情報。

Returns:

現在の会話のメンバーの一覧

このオーバーロードは、ボットの ServiceUrl と資格情報のみが必要とされるため、会話のコンテキスト外から呼び出される場合があります。

getConversations

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

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

Parameters:

serviceUrl - クエリを実行するチャネル サーバーの URL。 これは から context.activity.serviceUrl取得できます。

credentials - ボットが .services() に接続するために必要な資格情報。

continuationToken - 結果の前のページからの継続トークン。

Returns:

現在の会話のメンバーの一覧

getCredentialsCache

protected Map getCredentialsCache()

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

Returns:

AppCredentials キャッシュ。

getOAuthSignInLink

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - 使用する認証接続の名前。

Returns:

実行するキューに登録された作業を表すタスク。

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

getOAuthSignInLink

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられるユーザー ID。

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表すタスク。

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

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

Returns:

実行するキューに登録された作業を表すタスク。

getOAuthSignInLink

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられるユーザー ID。

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表すタスク。

getOrCreateConnectorClient

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

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

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

Parameters:

serviceUrl - クライアントのサービス URL。

usingAppCredentials - (省略可能)使用する AppCredentials。

Returns:

ConnectorClient を返すタスク。

getSignInResource

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられるユーザー ID。

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表すタスク。

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

getSignInResource

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

Returns:

実行するキューに登録された作業を表すタスク。

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

getSignInResource

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

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

userId - トークンに関連付けられるユーザー ID。

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表すタスク。

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

getTokenStatus

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

userId - トークンの状態が取得されるユーザー ID。

includeFilter - 含める接続のコンマ区切りリスト (省略可能)。 空白にすると、構成されているすべての接続のトークンの状態が返されます。

Returns:

TokenStatus の一覧。

getTokenStatus

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

userId - トークンの状態が取得されるユーザー ID。

includeFilter - 含める接続のコンマ区切りリスト (省略可能)。 空白にすると、構成されているすべての接続のトークンの状態が返されます。

Returns:

TokenStatus の配列。

getUserToken

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - 使用する認証接続の名前。

magicCode - (省略可能)省略可能なユーザーが検証するコードを入力しました。

Returns:

トークン応答。

getUserToken

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

magicCode - (省略可能)省略可能なユーザーが検証するコードを入力しました。

Returns:

トークン応答

keyForAppCredentials

protected static String keyForAppCredentials(String appId, String scope)

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

Parameters:

appId - appId

scope - スコープ。

Returns:

キャッシュ キー。

keyForConnectorClient

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

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

Parameters:

serviceUrl - サービス URL

appId - アプリが行った

scope - スコープ

Returns:

キャッシュ キー。

processActivity

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

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

Parameters:

identity - ClaimsIdentity要求の 。

activity - 受信アクティビティ。

callback - アダプターのミドルウェア パイプラインの末尾で実行するコード。

Returns:

実行するキューに登録された作業を表すタスク。 アクティビティの種類が 'Invoke' で、対応するキー (channelId + activityId) が見つかった場合は、InvokeResponse が返され、それ以外の場合は null が返されます。

processActivity

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

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

Parameters:

authHeader - 要求の HTTP 認証ヘッダー。

activity - 受信アクティビティ。

callback - アダプターのミドルウェア パイプラインの末尾で実行するコード。

Returns:

実行するキューに登録された作業を表すタスク。 アクティビティの種類が 'Invoke' で、対応するキー (channelId + activityId) が見つかった場合は、InvokeResponse が返され、それ以外の場合は null が返されます。

sendActivities

public CompletableFuture sendActivities(TurnContext context, List activities)

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

Overrides:

BotFrameworkAdapter.sendActivities(TurnContext context, List<Activity> activities)

Parameters:

context - ターンのコンテキスト オブジェクト。

activities - 送信するアクティビティ。

Returns:

実行するキューに登録された作業を表すタスク。 アクティビティが正常に送信されると、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含むオブジェクトの配列 ResourceResponse が含まれます。

     <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>

signOutUser

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - 使用する認証接続の名前。

userId - サインアウトするユーザーのユーザー ID。

Returns:

実行するキューに登録された作業を表すタスク。

signOutUser

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

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

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - 使用する認証接続の名前。

userId

Returns:

実行するキューに登録された作業を表すタスク。

updateActivity

public CompletableFuture updateActivity(TurnContext context, Activity activity)

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

Overrides:

BotFrameworkAdapter.updateActivity(TurnContext context, Activity activity)

Parameters:

context - ターンのコンテキスト オブジェクト。

activity - 新しい置換アクティビティ。

Returns:

実行するキューに登録された作業を表すタスク。 アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含むオブジェクトが含まれます ResourceResponse 。

これを呼び出す前に、置換アクティビティの ID を置換するアクティビティの ID に設定します。 onUpdateActivity(UpdateActivityHandler handler)

use

public BotFrameworkAdapter use(Middleware middleware)

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

Overrides:

BotFrameworkAdapter.use(Middleware middleware)

Parameters:

middleware - 追加するミドルウェア。

Returns:

更新されたアダプター オブジェクト。