ResponseBuilder<T,E> Interfaz

  • Referencia
Paquete:
com.microsoft.bot.restclient.protocol
Artefacto Maven:
com.microsoft.bot:bot-connector:4.14.3

Parámetros de tipo

T

tipo de cuerpo si el código de estado se considera correcto

E

el tipo de excepción si el código de estado se considera un error

public interface ResponseBuilder<T,E>

Define una interfaz que puede procesar una respuesta Retrofit 2 en un cuerpo deserializado o una excepción, según el código de estado registrado.

Resumen del método

Modificador y tipo Método y descripción
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Compile un servicioresponseWithHeaders instance from a REST call response, a header in JSON format y un posible error, que no tiene un cuerpo de respuesta.
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Compile un servicioresponseWithHeaders instance from a REST call response( Respuesta de servicio, un encabezado en formato JSON y un posible error.
abstract ServiceResponse<T> build(Response<ResponseBody> response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error.
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error, que no tiene un cuerpo de respuesta.
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

Registre una asignación desde un código de estado de respuesta a un tipo de destino de respuesta.
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registre un tipo de destino para los errores con los modelos.

Detalles del método

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Compile una instancia de ServiceResponseWithHeaders a partir de una respuesta de llamada REST, un encabezado en formato JSON y un posible error, que no tiene un cuerpo de respuesta.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida. Si el código de estado no está registrado, la respuesta se considerará no válida. También se produce una excepción AutoRestException.

Parámetros:

response - la instancia de Response desde la llamada REST
headerType - el tipo del encabezado

Devoluciones:

una instancia de ServiceResponseWithHeaders de tipo genérico T

Produce:

java.io.IOException - excepciones de la llamada REST

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Compile una instancia de ServiceResponseWithHeaders a partir de una respuesta de llamada REST, un encabezado en formato JSON y un posible error.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida y deserializada en el tipo de destino especificado. Si el código de estado no está registrado, la respuesta se considerará no válida y se deserializará en el tipo de error especificado si hay uno. También se produce una excepción AutoRestException.

Parámetros:

response - la instancia de Response desde la llamada REST
headerType - el tipo del encabezado

Devoluciones:

una instancia de ServiceResponseWithHeaders de tipo genérico T

Produce:

java.io.IOException - excepciones de la llamada REST

build

public abstract ServiceResponse build(Response response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida y deserializada en el tipo de destino especificado. Si el código de estado no está registrado, la respuesta se considerará no válida y se deserializará en el tipo de error especificado si hay uno. También se produce una excepción AutoRestException.

Parámetros:

response - la instancia de Response desde la llamada REST

Devoluciones:

una instancia de ServiceResponse de tipo genérico T

Produce:

java.io.IOException - excepciones de la llamada REST

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error, que no tiene un cuerpo de respuesta.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida. Si el código de estado no está registrado, la respuesta se considerará no válida. También se produce una excepción AutoRestException.

Parámetros:

response - la instancia de Response desde la llamada REST

Devoluciones:

una instancia de ServiceResponse de tipo genérico T

Produce:

java.io.IOException - excepciones de la llamada REST

register

public abstract ResponseBuilder register(int statusCode, Type type)

Registre una asignación desde un código de estado de respuesta a un tipo de destino de respuesta.

Parámetros:

statusCode - el código de estado.
type - el tipo que se va a deserializar.

Devoluciones:

la misma instancia del generador.

registerError

public abstract ResponseBuilder registerError(Class type)

Registre un tipo de destino para los errores con los modelos.

Parámetros:

type - el tipo que se va a deserializar.

Devoluciones:

la misma instancia del generador.

Se aplica a