REST.Client.TRESTRequestParameterList.AddItem

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi 

function AddItem: TRESTRequestParameter; overload;
function AddItem(const AName, AValue: string; AKind: TRESTRequestParameterKind;  AOptions: TRESTRequestParameterOptions = []): TRESTRequestParameter;  overload;
function AddItem(const AName, AValue: string): TRESTRequestParameter; overload;
function AddItem(const AName, AValue: string; const AKind: TRESTRequestParameterKind;  const AOptions: TRESTRequestParameterOptions; AContentType: TRESTContentType): TRESTRequestParameter;
function AddItem(const AName: string; const AValue: TBytes; const AKind: TRESTRequestParameterKind;  const AOptions: TRESTRequestParameterOptions; AContentType: TRESTContentType): TRESTRequestParameter;
function AddItem(const AName: string; const AValue: TStream; const AKind: TRESTRequestParameterKind;  const AOptions: TRESTRequestParameterOptions; AContentType: TRESTContentType; AOwnsStream: TRESTObjectOwnership = ooCopy): TRESTRequestParameter;

C++ 

TRESTRequestParameter* __fastcall AddItem()/* overload */;
TRESTRequestParameter* __fastcall AddItem(const System::UnicodeString AName, const System::UnicodeString AValue, Rest::Types::TRESTRequestParameterKind AKind, Rest::Types::TRESTRequestParameterOptions AOptions = Rest::Types::TRESTRequestParameterOptions() )/* overload */;
TRESTRequestParameter* __fastcall AddItem(const System::UnicodeString AName, const System::UnicodeString AValue)/* overload */;
TRESTRequestParameter* __fastcall AddItem(const System::UnicodeString AName, const System::UnicodeString AValue, const Rest::Types::TRESTRequestParameterKind AKind, const Rest::Types::TRESTRequestParameterOptions AOptions, Rest::Types::TRESTContentType AContentType)/* overload */;
TRESTRequestParameter* __fastcall AddItem(const System::UnicodeString AName, const System::DynamicArray<System::Byte> AValue, const Rest::Types::TRESTRequestParameterKind AKind, const Rest::Types::TRESTRequestParameterOptions AOptions, Rest::Types::TRESTContentType AContentType)/* overload */;
TRESTRequestParameter* __fastcall AddItem(const System::UnicodeString AName, System::Classes::TStream* const AValue, const Rest::Types::TRESTRequestParameterKind AKind, const Rest::Types::TRESTRequestParameterOptions AOptions, Rest::Types::TRESTContentType AContentType, Rest::Types::TRESTObjectOwnership AOwnsStream = (Rest::Types::TRESTObjectOwnership)(0x0))/* overload */;

Propriétés

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


Description

Ajoute un paramètre de requête REST à la liste de paramètres et renvoie le paramètre ajouté.

Si un paramètre portant le même nom existe déjà, il est retiré et libéré.

Il y a cinq types de paramètres :

  • GetoPost peut être une valeur QueryString ou encodée basée sur une méthode.
  • HttpHeader ajoute une paire nom/valeur à la collection Header de la requête HTTP.
  • UrlSegment est inséré dans l'URL si un token d'URL correspondant existe, par exemple Account Id.
  • Cookie ajoute une paire nom/valeur à la collection cookies de la requête HTTP.
  • RequestBody est utilisé par AddBody. (Il n'est pas recommandé de l'utiliser directement.)

AddItem accepte certaines combinaisons des paramètres suivants :

  • AName est le nom qui identifie le paramètre.
  • AValue est la valeur du paramètre. Vous pouvez le spécifier en tant que chaîne, tableau d'octets ou flux.
  • AKind est le genre du paramètre ; il est défini sur pkGETorPOST par défaut.
  • AOptions est un ensemble d'options pour le paramètre ; il est vide par défaut.
  • AContentType est le type de contenu du paramètre ; il est défini sur DefaultRESTContentType par défaut.
  • AOwnsStream : :TRESTObjectOwnership est un paramètre AValue:TStream qui contrôle le propriétaire de la valeur de flux.

Voir aussi

Récupérée de « http://docwiki.embarcadero.com/Libraries/Sydney/f/index.php?title=REST.Client.TRESTRequestParameterList.AddItem&oldid=780942 »