ResponseBuilder<T,E> インターフェイス

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

型パラメーター

T

状態コードが成功と見なされた場合の本文の種類

E

状態コードがエラーと見なされる場合の例外の種類

public interface ResponseBuilder<T,E>

登録されている状態コードに応じて、逆シリアル化された本文または例外に対して、Retrofit 2 応答を処理できるインターフェイスを定義します。

メソッドの概要

修飾子と型 メソッドと説明
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および応答本文がない可能性のあるエラーから、ServiceResponseWithHeaders インスタンスを構築します。
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および考えられるエラーから、サービス応答WithHeaders インスタンスを構築します。
abstract ServiceResponse<T> build(Response<ResponseBody> response)

REST 呼び出し応答と考えられるエラーから ServiceResponse インスタンスを構築します。
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

REST 呼び出し応答と、応答本文がない可能性のあるエラーから、ServiceResponse インスタンスを構築します。
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

応答状態コードから応答の宛先の種類へのマッピングを登録します。
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

モデルでエラーの宛先の種類を登録します。

メソッドの詳細

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および応答本文がない可能性のあるエラーから ServiceResponseWithHeaders インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされます。 状態コードが登録されていない場合、応答は無効と見なされます。 AutoRestException もスローされます。

パラメーター:

response - REST 呼び出しからの Response インスタンス
headerType - ヘッダーの型

戻り値:

ジェネリック型の ServiceResponseWithHeaders インスタンス T

スロー:

java.io.IOException - REST 呼び出しからの例外

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および考えられるエラーから ServiceResponseWithHeaders インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされ、指定された宛先の型に逆シリアル化されます。 状態コードが登録されていない場合、応答は無効と見なされ、存在する場合は指定したエラーの種類に逆シリアル化されます。 AutoRestException もスローされます。

パラメーター:

response - REST 呼び出しからの Response インスタンス
headerType - ヘッダーの型

戻り値:

ジェネリック型の ServiceResponseWithHeaders インスタンス T

スロー:

java.io.IOException - REST 呼び出しからの例外

build

public abstract ServiceResponse build(Response response)

REST 呼び出し応答と考えられるエラーから ServiceResponse インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされ、指定された宛先の型に逆シリアル化されます。 状態コードが登録されていない場合、応答は無効と見なされ、存在する場合は指定したエラーの種類に逆シリアル化されます。 AutoRestException もスローされます。

パラメーター:

response - REST 呼び出しからの Response インスタンス

戻り値:

ジェネリック型の ServiceResponse インスタンス T

スロー:

java.io.IOException - REST 呼び出しからの例外

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

REST 呼び出し応答と、応答本文がない可能性のあるエラーから ServiceResponse インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされます。 状態コードが登録されていない場合、応答は無効と見なされます。 AutoRestException もスローされます。

パラメーター:

response - REST 呼び出しからの Response インスタンス

戻り値:

ジェネリック型の ServiceResponse インスタンス T

スロー:

java.io.IOException - REST 呼び出しからの例外

register

public abstract ResponseBuilder register(int statusCode, Type type)

応答状態コードから応答の宛先の種類へのマッピングを登録します。

パラメーター:

statusCode - 状態コード。
type - 逆シリアル化する型。

戻り値:

同じビルダー インスタンス。

registerError

public abstract ResponseBuilder registerError(Class type)

モデルでエラーの宛先の種類を登録します。

パラメーター:

type - 逆シリアル化する型。

戻り値:

同じビルダー インスタンス。

適用対象