REST.Types.TRESTRequestParameterKind
Delphi
TRESTRequestParameterKind = (
pkCOOKIE,
pkGETorPOST,
pkURLSEGMENT,
pkHTTPHEADER,
pkREQUESTBODY,
pkFILE,
pkQUERY
);
C++
enum DECLSPEC_DENUM TRESTRequestParameterKind : unsigned char { pkCOOKIE, pkGETorPOST, pkURLSEGMENT, pkHTTPHEADER, pkREQUESTBODY, pkFILE, pkQUERY };
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
enum | public | REST.Types.pas REST.Types.hpp |
REST.Types | REST.Types |
Description
Spécifie les types de paramètres qui peuvent être ajoutés aux requêtes.
Cette énumération définit les valeurs suivantes :
pkCOOKIE
: place le paramètre dans un cookie.pkGETorPOST
: envoie le paramètre sous forme de paramètre d'URL (pour les requêtes GET) ou comme paramètre du corps (pour les requêtes POST/PUT).
- Envoie le paramètre en tant que paramètre de requête URL pour d'autres méthodes, si ContentType n'est pas ctAPPLICATION_X_WWW_FORM_URLENCODED ou ctMULTIPART_FORM_DATA.
pkURLSEGMENT
: utilise le paramètre en tant que valeur d'un segment URL. Le segment URL peut être défini dans un chemin de ressource d'une requête : customer/{ID}. Si le segment URL a un paramètre dont le nom est "ID", sa valeur est remplacée par {ID} dans l'exemple ci-dessus.pkHTTPHEADER
: place le paramètre dans l'en-tête HTTP de la requête.pkREQUESTBODY
: utilise la valeur du paramètre en tant que corps de la requête. Si plusieurs paramètres de cette sorte existent, la requête utilise un corps à parties multiples.pkFILE
: la valeur de ce paramètre est utilisée pour attacher le contenu du fichier à la requête. Si ce paramètre existe déjà, la requête utilise un corps à parties multiples.pkQUERY
: envoie le paramètre explicitement en tant que paramètre URL (pour toutes les requêtes), par contraste avecpkGETorPOST
, lorsque l'emplacement du paramètre dépend du type de requête et du type de contenu.