BotFrameworkHttpClient クラス

  • リファレンス
パッケージ:
com.microsoft.bot.integration
Maven 成果物:
com.microsoft.bot:bot-integration-core:4.14.3

public class BotFrameworkHttpClient
extends BotFrameworkClient

BotFramework HTTP プロトコルを使用してボットにアクティビティを安全に投稿するためのクラス。 このクラスを使用すると、Bot Framework HTTP プロトコルを使用してボットにアクティビティを安全にポストできます。 使用パターンは 2 つあります。* PostActivity (fromBotId、toBotId、endpoint、serviceUrl、activity)、* PostActivity (botId、endpoint、activity) を介して行われるスキル (Bot -> Bot as a Skill) への転送アクティビティ。* PostActivity (botId、エンドポイント、アクティビティ) を介して行われるアクティビティ (外部サービス -> Bot) は、ボット独自の資格情報を使用してボットにアクティビティを投稿する必要がある Web ジョブなどの外部サービスによって使用されます。

コンストラクターの概要

コンストラクター 説明
BotFrameworkHttpClient(CredentialProvider credentialProvider, ChannelProvider channelProvider)

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

メソッドの概要

修飾子と型 メソッドと説明
java.util.concurrent.CompletableFuture<TypedInvokeResponse<T>> <T>postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class<T> type)

アクティビティをスキル (ボット) に転送します。
java.util.concurrent.CompletableFuture<TypedInvokeResponse<T>> <T>postActivity(String botId, URI botEndpoint, Activity activity, Class<T> type)

ボットの資格情報を使用してボットにアクティビティを投稿します。
protected java.util.concurrent.CompletableFuture<AppCredentials> buildCredentials(String appId, String oAuthScope)

この getHttpClient() のトークンを取得するために使用する AppCredentials オブジェクトを構築するロジック。
protected static java.util.Map<java.lang.String,AppCredentials> getAppCredentialMapCache()

トークンの取得を高速化するためのアプリ資格情報のキャッシュを取得します (期限切れでない限り、トークンは要求されません)。
protected ChannelProvider getChannelProvider()

このアダプターのチャネル プロバイダーを取得します。
protected CredentialProvider getCredentialProvider()

このアダプターの資格情報プロバイダーを取得します。
okhttp3.OkHttpClient getHttpClient()

このアダプターの Httpクライアントを取得します。

メソッドの継承元: BotFrameworkClient

<T>postActivity

メソッドの継承元: 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

コンストラクターの詳細

BotFrameworkHttpClient

public BotFrameworkHttpClient(CredentialProvider credentialProvider, ChannelProvider channelProvider)

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

パラメーター:

credentialProvider - CredentialProvider のインスタンス。
channelProvider - ChannelProvider のインスタンス。

メソッドの詳細

<T>postActivity

public CompletableFuture> postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class type)

アクティビティをスキル (ボット) に転送します。 注: スキルにアクティビティを転送すると、スキルが正確な状態になるように UserState と ConversationState の変更がフラッシュされます。

上書き:

BotFrameworkHttpClient.<T>postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class<T> type)

パラメーター:

fromBotId - アクティビティを送信するボットの MicrosoftAppId。
toBotId - アクティビティを受け取るボットの MicrosoftAppId。
toUrl - アクティビティを受け取るボットの URL。
serviceUrl - スキル ホストのコールバック URL。
conversationId - スキルとの会話に使用する会話 D。
activity - 転送するアクティビティ。
type

戻り値:

オプションの invokeResponse を含むタスク。

<T>postActivity

public CompletableFuture> postActivity(String botId, URI botEndpoint, Activity activity, Class type)

ボットの資格情報を使用してボットにアクティビティを投稿します。

パラメーター:

botId - ボットの MicrosoftAppId。
botEndpoint - ボットの URL。
activity - 投稿するアクティビティ。
type - の種類。

戻り値:

InvokeResponse。

buildCredentials

protected CompletableFuture buildCredentials(String appId, String oAuthScope)

この getHttpClient() のトークンを取得するために使用する AppCredentials オブジェクトを構築するロジック。

パラメーター:

appId - アプリケーション ID。
oAuthScope - オプションの OAuth スコープ。

戻り値:

トークンの取得に使用するアプリの資格情報。

getAppCredentialMapCache

protected static Map getAppCredentialMapCache()

トークンの取得を高速化するための appCredentials のキャッシュを取得します (期限切れでない限り、トークンは要求されません)。 AppCredentials は appId + スコープを使用してキャッシュされます (この最後のパラメーターは、アプリの資格情報がスキルの呼び出しに使用される場合にのみ使用されます)。

戻り値:

静的な ConcurrentDictionary<String、AppCredentials>としての AppCredentialMapCache 値。

getChannelProvider

protected ChannelProvider getChannelProvider()

このアダプターのチャネル プロバイダーを取得します。

戻り値:

ChannelProvider 値を getChannelProvider() として指定します。

getCredentialProvider

protected CredentialProvider getCredentialProvider()

このアダプターの資格情報プロバイダーを取得します。

戻り値:

CredentialProvider 値を getCredentialProvider() として指定します。

getHttpClient

public OkHttpClient getHttpClient()

このアダプターの HttpClient を取得します。

戻り値:

OkhttpClient 値を getHttpClient() として指定します。

適用対象