REST.Client.TRESTRequestParameterList.AddItem

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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 */;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
REST.Client.pas
REST.Client.hpp
REST.Client TRESTRequestParameterList


Beschreibung

Fügt einen REST-Anforderungsparameter der Liste der Parameter hinzu und gibt den hinzugefügten Parameter zurück.

Wenn bereits ein Parameter mit demselben Namen vorhanden ist, wird er entfernt und freigegeben.

Es gibt fünf Arten von Paramatern:

  • GetorPost kann ein QueryString oder ein codierter Formularwert für eine Methode sein.
  • HttpHeader fügt der Header-Sammlung der HTTP-Anforderung ein Namen-/Wertepaar hinzu.
  • UrlSegment wird in die URL eingefügt, wenn ein übereinstimmendes URL-Token z .B. Account Id vorhanden ist.
  • Cookie fügt der Cookie-Sammlung der HTTP-Anforderung das Namen-/Wertepaar hinzu.
  • RequestBody wird von AddBody verwendet. (Es wird nicht empfohlen, diesen Parameter direkt zu verwenden.)

AddItem akzeptiert verschiedene Kombinationen der folgenden Parameter:

  • AName ist der Name, der den Parameter bezeichnet.
  • AValue ist der Wert des Parameters, den Sie als String, Byte-Array oder Stream angeben können.
  • AKind ist die Art des Parameters, standardmäßig pkGETorPOST.
  • AOptions ist eine Optionsmenge für den Parameter. Die Optionsmenge ist standardmäßig leer.
  • AContentType ist der Inhaltstyp des Parameters. Der Typ ist standardmäßig DefaultRESTContentType.
  • AOwnsStream:TRESTObjectOwnership ist ein AValue:TStream-Parameter, der den Eigentümer des Stream-Werts steuert.

Siehe auch