REST.Client.TBodyParams.Add

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

class procedure Add(const AParams: TRESTRequestParameterList; const ABodyContent: string; AContentType: TRESTContentType = ctNone); overload; static;
class procedure Add<T: class, constructor>(const AParams: TRESTRequestParameterList; const AObject: T); overload; static;
class procedure Add(const AParams: TRESTRequestParameterList; const AObject: TJsonObject); overload; static;
class procedure Add(const AParams: TRESTRequestParameterList; const ABodyContent: TStream; AContentType: TRESTContentType = ctNone); overload; static;

C++

static void __fastcall Add(TRESTRequestParameterList* const AParams, const System::UnicodeString ABodyContent, Rest::Types::TRESTContentType AContentType = (Rest::Types::TRESTContentType)(0x0))/* overload */;
template<typename T> static void __fastcall Add(TRESTRequestParameterList* const AParams, const T AObject)/* overload */;
static void __fastcall Add(TRESTRequestParameterList* const AParams, System::Json::TJSONObject* const AObject)/* overload */;
static void __fastcall Add(TRESTRequestParameterList* const AParams, System::Classes::TStream* const ABodyContent, Rest::Types::TRESTContentType AContentType = (Rest::Types::TRESTContentType)(0x0))/* overload */;

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
REST.Client.pas
REST.Client.hpp
REST.Client TBodyParams


Description

Ajoute le contenu spécifié en tant que paramètre de corps à la liste de paramètres d'une requête REST.

Il y a quatre manières différentes de spécifier la valeur du paramètre de corps à ajouter à AParams :

  • Si ABodyContent est une chaîne ou un flux, Add utilise le contenu spécifié avec le type spécifié comme paramètre de corps de la requête.
  • Si AObject est une instance de TJSONObject ou un objet d'un type spécifié, Add sérialise l'objet spécifié au format JSON et utilise les données sérialisées en tant que valeur du paramètre du corps de la requête.

Généralement, un appel à Add remplace toute valeur précédente du paramètre du corps. Toutefois, si vous transmettez ABodyContent sous forme de chaîne, la valeur spécifiée est ajoutée et la requête résultante contient plusieurs paramètres de corps ; le nom de chaque paramètre de corps est "body" suivi d'un GUID aléatoire.

Voir aussi