ResponseBuilder<T,E> Interface

  • Référence
Paquet:
com.microsoft.bot.restclient.protocol
Artefact Maven:
com.microsoft.bot:bot-connector:4.14.3

Paramètres de type

T

type de corps si le code d’état est considéré comme réussi

E

type d’exception si le code d’état est considéré comme un échec

public interface ResponseBuilder<T,E>

Définit une interface qui peut traiter une réponseFit 2 dans un corps désérialisé ou une exception, en fonction du code d’état inscrit.

Résumé de la méthode

Modificateur et type Méthode et description
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Créez un serviceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, qui n’a pas de corps de réponse.
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Créez un serviceResponseWithHeaders instance à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible.
abstract ServiceResponse<T> build(Response<ResponseBody> response)

Générez une instance de serviceResponse à partir d’une réponse d’appel REST et d’une erreur possible.
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

Créez une instance de serviceResponse à partir d’une réponse d’appel REST et d’une erreur possible, qui n’a pas de corps de réponse.
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

Inscrivez un mappage à partir d’un code d’état de réponse à un type de destination de réponse.
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Inscrivez un type de destination pour les erreurs avec les modèles.

Détails de la méthode

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Générez une instance ServiceResponseWithHeaders à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible, qui n’a pas de corps de réponse.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide. Une exception AutoRestException est également levée.

Paramètres:

response - l’instance Response à partir de l’appel REST
headerType - type de l’en-tête

Retours:

une instance ServiceResponseWithHeaders de type générique T

Exception:

java.io.IOException - exceptions de l’appel REST

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Générez une instance ServiceResponseWithHeaders à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide et désérialisée dans le type de destination spécifié. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide et désérialisée dans le type d’erreur spécifié s’il en existe un. Une exception AutoRestException est également levée.

Paramètres:

response - l’instance Response à partir de l’appel REST
headerType - type de l’en-tête

Retours:

une instance ServiceResponseWithHeaders de type générique T

Exception:

java.io.IOException - exceptions de l’appel REST

build

public abstract ServiceResponse build(Response response)

Générez une instance ServiceResponse à partir d’une réponse d’appel REST et d’une erreur possible.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide et désérialisée dans le type de destination spécifié. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide et désérialisée dans le type d’erreur spécifié s’il en existe un. Une exception AutoRestException est également levée.

Paramètres:

response - l’instance Response à partir de l’appel REST

Retours:

instance ServiceResponse de type générique T

Exception:

java.io.IOException - exceptions de l’appel REST

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

Générez une instance ServiceResponse à partir d’une réponse d’appel REST et d’une erreur possible, qui n’a pas de corps de réponse.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide. Une exception AutoRestException est également levée.

Paramètres:

response - l’instance Response à partir de l’appel REST

Retours:

instance ServiceResponse de type générique T

Exception:

java.io.IOException - exceptions de l’appel REST

register

public abstract ResponseBuilder register(int statusCode, Type type)

Inscrivez un mappage à partir d’un code d’état de réponse à un type de destination de réponse.

Paramètres:

statusCode - le code d’état.
type - type à désérialiser.

Retours:

la même instance de générateur.

registerError

public abstract ResponseBuilder registerError(Class type)

Inscrivez un type de destination pour les erreurs avec les modèles.

Paramètres:

type - type à désérialiser.

Retours:

la même instance de générateur.

S’applique à