ResponseBuilder<T,E> Interface

  • Referência
Pacote:
com.microsoft.bot.restclient.protocol
Artefato Maven:
com.microsoft.bot:bot-connector:4.14.3

Parâmetros de tipo

T

o tipo de corpo se o código de status for considerado bem-sucedido

E

o tipo de exceção se o código de status for considerado uma falha

public interface ResponseBuilder<T,E>

Define uma interface que pode processar uma resposta Retrofit 2 em um corpo desserializado ou em uma exceção, dependendo do código de status registrado.

Resumo do método

Modificador e tipo Método e descrição
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Crie umde resposta dede serviço cominstância de cabeçalhos de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro, que não tem um corpo de resposta.
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Crie umde resposta dede serviço cominstância de cabeçalhos de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro.
abstract ServiceResponse<T> build(Response<ResponseBody> response)

Crie uma instância do ServiceResponse a partir de uma resposta de chamada REST e um possível erro.
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro, que não tem um corpo de resposta.
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

Registre um mapeamento de um código de status de resposta para um tipo de destino de resposta.
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registre um tipo de destino para erros com modelos.

Detalhes do método

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Crie uma instância ServiceResponseWithHeaders a partir de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro, que não tem um corpo de resposta.

Se o código de status na resposta for registrado, a resposta será considerada válida. Se o código de status não estiver registrado, a resposta será considerada inválida. Uma AutoRestException também é gerada.

Parâmetros:

response - a instância Response da chamada REST
headerType - o tipo do cabeçalho

Retornos:

uma instância ServiceResponseWithHeaders do tipo genérico T

Gera:

java.io.IOException - exceções da chamada REST

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Crie uma instância ServiceResponseWithHeaders a partir de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro.

Se o código de status na resposta for registrado, a resposta será considerada válida e desserializada no tipo de destino especificado. Se o código de status não estiver registrado, a resposta será considerada inválida e desserializada no tipo de erro especificado se houver um. Uma AutoRestException também é gerada.

Parâmetros:

response - a instância Response da chamada REST
headerType - o tipo do cabeçalho

Retornos:

uma instância ServiceResponseWithHeaders do tipo genérico T

Gera:

java.io.IOException - exceções da chamada REST

build

public abstract ServiceResponse build(Response response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro.

Se o código de status na resposta for registrado, a resposta será considerada válida e desserializada no tipo de destino especificado. Se o código de status não estiver registrado, a resposta será considerada inválida e desserializada no tipo de erro especificado se houver um. Uma AutoRestException também é gerada.

Parâmetros:

response - a instância Response da chamada REST

Retornos:

uma instância serviceResponse do tipo genérico T

Gera:

java.io.IOException - exceções da chamada REST

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro, que não tem um corpo de resposta.

Se o código de status na resposta for registrado, a resposta será considerada válida. Se o código de status não estiver registrado, a resposta será considerada inválida. Uma AutoRestException também é gerada.

Parâmetros:

response - a instância Response da chamada REST

Retornos:

uma instância serviceResponse do tipo genérico T

Gera:

java.io.IOException - exceções da chamada REST

register

public abstract ResponseBuilder register(int statusCode, Type type)

Registre um mapeamento de um código de status de resposta para um tipo de destino de resposta.

Parâmetros:

statusCode - o código de status.
type - o tipo a ser desserializado.

Retornos:

a mesma instância do construtor.

registerError

public abstract ResponseBuilder registerError(Class type)

Registre um tipo de destino para erros com modelos.

Parâmetros:

type - o tipo a ser desserializado.

Retornos:

a mesma instância do construtor.

Aplica-se a