REST.Types.TRESTRequestParameterKind

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

TRESTRequestParameterKind = (
pkCOOKIE,
pkGETorPOST,
pkURLSEGMENT,
pkHTTPHEADER,
pkREQUESTBODY,
pkFILE,
pkQUERY
);

C++

enum DECLSPEC_DENUM TRESTRequestParameterKind : unsigned char { pkCOOKIE, pkGETorPOST, pkURLSEGMENT, pkHTTPHEADER, pkREQUESTBODY, pkFILE, pkQUERY };

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
enum public
REST.Types.pas
REST.Types.hpp
REST.Types REST.Types


Beschreibung

Gibt den Typ von Parametern an, die den Anforderungen hinzugefügt werden können.

Diese Aufzählung definiert die folgenden Werte:

  • pkCOOKIE: Setzt den Parameter in ein Cookie.
  • pkGETorPOST: Sendet den Parameter als URL-Parameter (für GET-Anforderungen) oder als Rumpf-Parameter (für POST/PUT-Anforderungen).
Sendet den Parameter als URL-Abfrageparameter für andere Methoden, wenn ContentType nicht ctAPPLICATION_X_WWW_FORM_URLENCODED oder ctMULTIPART_FORM_DATA ist.
  • pkURLSEGMENT: Verwendet den Parameter als Wert für ein URL-Segment. Das URL-Segment kann in einem Ressourcenpfad einer Anforderung definiert sein: customer/{ID}. Wenn das URL-Segment über einen Parameter mit dem Namen "ID" verfügt, wird dessen Wert im obigen Beispiel für {ID} ersetzt.
  • pkHTTPHEADER: Setzt den Parameter in den HTTP-Header der Anforderung.
  • pkREQUESTBODY: Verwendet den Parameterwert als Anforderungsrumpf. Wenn mehr als ein Parameter dieser Art vorhanden ist, wird in der Anforderung ein Rumpf mit mehreren Teilen verwendet.
  • pkFILE: Der Wert dieses Parameters wird verwendet, um den Dateiinhalt der Anforderung beizufügen. Wenn dieser Parameter bereits vorhanden ist, wird in der Anforderung ein Rumpf mit mehreren Teilen verwendet.
  • pkQUERY: Sendet den Parameter explizit als URL-Parameter (für alle Anforderungen), im Gegensatz zu pkGETorPOST, bei dem die Parameterposition vom Anforderungstyp und Inhaltstyp abhängt.