ResponseBuilder<T,E> 介面

  • 參考
套件:
com.microsoft.bot.restclient.protocol
Maven 成品:
com.microsoft.bot:bot-connector:4.14.3

類型參數

T

如果狀態代碼視為成功，則為主體類型

E

如果狀態代碼被視為失敗，則為例外狀況類型

public interface ResponseBuilder<T,E>

定義介面，根據註冊的狀態代碼，將改造 2 回應處理到還原串行化的主體或例外狀況。

方法摘要

修飾詞與類型 方法與描述
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

建置服務回應使用 REST 呼叫回應的標頭實例、JSON 格式的標頭，以及可能的錯誤，其中沒有回應本文。
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

建置 ServiceResponseWithHeaders 實例從 REST 呼叫回應、JSON 格式的標頭，以及可能的錯誤。
abstract ServiceResponse<T> build(Response<ResponseBody> response)

從 REST 呼叫回應建置服務回應實例和可能的錯誤。
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

從 REST 呼叫回應建置服務回應實例，以及沒有回應本文的可能錯誤。
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 - 要還原串行化的型別。

傳回:

相同的產生器實例。

適用於