RestConnectorClient クラス

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

実装

ConnectorClient

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

Bot Connector REST API を使用すると、ボットは [Bot Framework Developer Portal](https://dev.botframework.com) で構成されたチャネルにメッセージを送受信できます。 コネクタ サービスでは、HTTPS 経由で業界標準の REST と JSON が使用されます。 この REST API のクライアント ライブラリを使用できます。 一覧については、以下を参照してください。 多くのボットでは、Bot Connector REST API と関連する [Bot State REST API](/en-us/restapi/state) の両方が使用されます。 Bot State REST API を使用すると、ボットはユーザーと会話に関連付けられている状態を格納および取得できます。 Bot Connector と Bot State REST API の両方の認証は JWT ベアラー トークンを使用して実現され、詳細については「コネクタ認証(/en-us/restapi/authentication)」ドキュメントで説明されています。

コンストラクターの概要

コンストラクター 説明
RestConnectorClient(RestClient restClient)

コネクタクライアント クライアントのインスタンスを初期化します。
RestConnectorClient(ServiceClientCredentials credentials)

コネクタクライアント クライアントのインスタンスを初期化します。
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

コネクタクライアント クライアントのインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
java.lang.String baseUrl()

このコネクタクライアントのベース URL を返します。
void close()

自動使い捨て閉じます。
ServiceClientCredentials credentials()

使用中の資格情報を返します。
java.lang.String getAcceptLanguage()

応答の優先言語を取得します。.
Attachments getAttachments()

操作にアクセスするための Attachments オブジェクトを取得します。
Conversations getConversations()

操作にアクセスするための Conversations オブジェクトを取得します。
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

これは、Azure クライアントが RestClient を作成するために行う処理のコピーです。
boolean getGenerateClientRequestId()

true に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含まれます。
int getLongRunningOperationRetryTimeout()

実行時間の長い操作の再試行タイムアウトを秒単位で取得します。
RestClient getRestClient()

REST クライアントを取得します。
RetryStrategy getRestRetryStrategy()

Rest 再試行戦略を取得します。
java.lang.String getUserAgent()

クライアントの User-Agent ヘッダーを取得します。
protected void initialize()

構築後にオブジェクトを初期化します。
void setAcceptLanguage(String withAcceptLanguage)

応答の優先言語を設定します。.
void setGenerateClientRequestId(boolean requestId)

true に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含まれます。
void setLongRunningOperationRetryTimeout(int timeout)

実行時間の長い操作の再試行タイムアウトを秒単位で設定します。
void setRestRetryStrategy(RetryStrategy strategy)

Rest 再試行戦略を設定します。
java.lang.String userAgent()

これは、AzureServiceクライアントのバージョンをオーバーライドするためです。

メソッドの継承元: ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

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

コンストラクターの詳細

RestConnectorClient

public RestConnectorClient(RestClient restClient)

ConnectorClient クライアントのインスタンスを初期化します。

パラメーター:

restClient - Azure に接続する REST クライアント。

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

ConnectorClient クライアントのインスタンスを初期化します。

パラメーター:

credentials - Azure の管理資格情報

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

ConnectorClient クライアントのインスタンスを初期化します。

パラメーター:

baseUrl - ホストのベース URL
credentials - Azure の管理資格情報

メソッドの詳細

baseUrl

public String baseUrl()

この ConnectorClient のベース URL を返します。

戻り値:

ベース URL。

close

public void close()

AutoDisposable close。

credentials

public ServiceClientCredentials credentials()

使用中の資格情報を返します。

戻り値:

使用中の ServiceClientCredentials。

getAcceptLanguage

public String getAcceptLanguage()

応答の優先言語を取得します。.

戻り値:

acceptLanguage 値。

getAttachments

public Attachments getAttachments()

操作にアクセスするための Attachments オブジェクトを取得します。

戻り値:

Attachments オブジェクト。

getConversations

public Conversations getConversations()

操作にアクセスするための Conversations オブジェクトを取得します。

戻り値:

Conversations オブジェクト。

getDefaultRestClientBuilder

public static RestClient.Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

これは、Azure クライアントが RestClient を作成するために行う処理のコピーです。 これにより RestClient.Builder が返され、アプリでカスタム RestClient を作成し、構築中に ConnectorClient に提供できるようになります。 この 1 つのユース ケースは、RestClient にプロキシを提供することです。 ただし、Java システム プロパティを使用してプロキシ情報を設定することをお勧めします。

パラメーター:

baseUrl - サービス エンドポイント
credentials - 認証資格情報。

戻り値:

RestClient.Builder。

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

true に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含まれます。

戻り値:

generateClientRequestId 値。

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

実行時間の長い操作の再試行タイムアウトを秒単位で取得します。 既定値は 30 です。

戻り値:

タイムアウト値。

getRestClient

public RestClient getRestClient()

REST クライアントを取得します。

戻り値:

RestClient オブジェクト。

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Rest 再試行戦略を取得します。

戻り値:

使用されている RetryStrategy。

getUserAgent

public String getUserAgent()

クライアントの User-Agent ヘッダーを取得します。

戻り値:

ユーザー エージェント文字列。

initialize

protected void initialize()

構築後にオブジェクトを初期化します。

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

応答の優先言語を設定します。.

パラメーター:

withAcceptLanguage - acceptLanguage 値。

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

true に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含まれます。

パラメーター:

requestId - generateClientRequestId 値。

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

実行時間の長い操作の再試行タイムアウトを秒単位で設定します。 既定値は 30 です。

パラメーター:

timeout - longRunningOperationRetryTimeout 値。

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Rest 再試行戦略を設定します。

パラメーター:

strategy - 使用する RetryStrategy。

userAgent

public String userAgent()

これは、AzureServiceClient のバージョンをオーバーライドするためです。

上書き:

RestConnectorClient.userAgent()

戻り値:

ユーザー エージェント。 getUserAgent() と同じ

適用対象