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)

Созданиеответа службыс помощью экземпляра заголовковиз ответа на вызов 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)

Создание экземпляра ServiceResponseWithHeaders из ответа на вызов REST, заголовка в формате JSON и возможной ошибки, которая не содержит текст отклика.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым. Если код состояния не зарегистрирован, ответ будет считаться недопустимым. Исключение AutoRestException также возникает.

Параметры:

response - экземпляр Response из вызова REST
headerType - Тип заголовка

Возвращаемое значение:

экземпляр ServiceResponseWithHeaders универсального типа T

Активизирует исключение:

java.io.IOException - исключения из вызова REST

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Создание экземпляра ServiceResponseWithHeaders из ответа на вызов REST, заголовка в формате JSON и возможной ошибки.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым и десериализированным в указанный тип назначения. Если код состояния не зарегистрирован, ответ будет считаться недопустимым и десериализирован в указанный тип ошибки, если есть один. Исключение AutoRestException также возникает.

Параметры:

response - экземпляр Response из вызова REST
headerType - Тип заголовка

Возвращаемое значение:

экземпляр ServiceResponseWithHeaders универсального типа T

Активизирует исключение:

java.io.IOException - исключения из вызова REST

build

public abstract ServiceResponse build(Response response)

Создайте экземпляр ServiceResponse из ответа на вызов REST и возможную ошибку.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым и десериализированным в указанный тип назначения. Если код состояния не зарегистрирован, ответ будет считаться недопустимым и десериализирован в указанный тип ошибки, если есть один. Исключение AutoRestException также возникает.

Параметры:

response - экземпляр Response из вызова REST

Возвращаемое значение:

Экземпляр ServiceResponse универсального типа T

Активизирует исключение:

java.io.IOException - исключения из вызова REST

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

Создайте экземпляр ServiceResponse из ответа на вызов REST и возможную ошибку, которая не имеет текста ответа.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым. Если код состояния не зарегистрирован, ответ будет считаться недопустимым. Исключение AutoRestException также возникает.

Параметры:

response - экземпляр Response из вызова REST

Возвращаемое значение:

Экземпляр 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 - тип для десериализации.

Возвращаемое значение:

тот же экземпляр построителя.

Применяется к