ServiceResponseBuilder<T,E> 類別

  • 參考
套件:
com.microsoft.bot.restclient
Maven 成品:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

類型參數

T

呼叫端預期來自 REST 回應的傳回類型。

E

發生錯誤時要擲回的例外狀況。

實作

ResponseBuilder<TE>

public final class ServiceResponseBuilder<T,E>
implements ResponseBuilder<T,E>

建置 ServiceResponse<T>的建置器。

方法摘要

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

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

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

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

從 REST 呼叫回應建置服務回應實例，以及沒有回應本文的可能錯誤。
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

檢查傳回的狀態代碼是否被視為此產生器的成功狀態代碼。
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

註冊從回應狀態代碼到回應目的地類型的對應。
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

註冊從回應狀態代碼到儲存在 Map中的回應目的地類型的所有對應。
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

向模型註冊錯誤的目的地類型。
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

指定是否要從 GET 呼叫擲回 404 回應。

方法繼承來源 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

方法詳細資料

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

從 REST 呼叫回應、JSON 格式的標頭，以及沒有回應本文的可能錯誤，建置 ServiceResponseWithHeaders 實例。

如果註冊回應中的狀態代碼，回應會被視為有效。 如果未註冊狀態代碼，回應會被視為無效。 也會擲回 AutoRestException。

參數:

response
headerType

擲回:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

從 REST 呼叫回應、JSON 格式的標頭和可能的錯誤建置 ServiceResponseWithHeaders 實例。

如果註冊回應中的狀態代碼，回應會被視為有效且還原串行化為指定的目的地類型。 如果未註冊狀態代碼，回應將會被視為無效，並在有錯誤類型時還原串行化為指定的錯誤類型。 也會擲回 AutoRestException。

參數:

response
headerType

擲回:

java.io.IOException

build

public ServiceResponse build(Response response)

從 REST 呼叫回應和可能的錯誤建置 ServiceResponse 實例。

如果註冊回應中的狀態代碼，回應會被視為有效且還原串行化為指定的目的地類型。 如果未註冊狀態代碼，回應將會被視為無效，並在有錯誤類型時還原串行化為指定的錯誤類型。 也會擲回 AutoRestException。

參數:

response

擲回:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

從 REST 呼叫回應建置 ServiceResponse 實例，以及可能的錯誤，其沒有回應本文。

如果註冊回應中的狀態代碼，回應會被視為有效。 如果未註冊狀態代碼，回應會被視為無效。 也會擲回 AutoRestException。

參數:

response

擲回:

java.io.IOException

exceptionType

public Class exceptionType()

傳回:

發生錯誤時所擲回的例外狀況類型。

isSuccessful

public boolean isSuccessful(int statusCode)

檢查傳回的狀態代碼是否被視為此產生器的成功狀態代碼。

參數:

statusCode - 要檢查的狀態代碼

傳回:

如果成功，則為 true，否則為 false。

register

public ServiceResponseBuilder register(int statusCode, Type type)

註冊從回應狀態代碼到回應目的地類型的對應。

參數:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

註冊從回應狀態代碼到儲存在 Map中的回應目的地類型的所有對應。

參數:

responseTypes - 從回應狀態代碼對應至回應類型。

傳回:

相同的產生器實例。

registerError

public ServiceResponseBuilder registerError(Class type)

向模型註冊錯誤的目的地類型。

參數:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

指定是否要從 GET 呼叫擲回 404 回應。

參數:

throwOnGet404 - 如果擲回則為 true;false 表示只傳回 null。 默認值為 false。

傳回:

響應產生器本身

適用於