REST.Types.TRESTRequestParameterOption

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

TRESTRequestParameterOption = (
poDoNotEncode,
poTransient,
poAutoCreated,
poFlatArray,
poPHPArray,
poListArray
);

C++

enum DECLSPEC_DENUM TRESTRequestParameterOption : unsigned char { poDoNotEncode, poTransient, poAutoCreated, poFlatArray, poPHPArray, poListArray };

Properties

Type Visibility Source Unit Parent
enum public
REST.Types.pas
REST.Types.hpp
REST.Types REST.Types

Description

Controls the way of the request parameters utilization.

This enumeration defines the following values:

  • poDoNotEncode: Indicates that the value of this parameter should be used as-is, and not encoded by the component.
  • poTransient: Indicates that it is a transient parameter. Typically, the attached components, such as an authenticator, create and manage transient parameters.
  • poAutoCreated: Indicates that this parameter was created by a component while parsing the base URL or a resource.
  • poFlatArray: Indicates that the ';' separated list of values of this parameter should be expanded into name=val1&...&=valN.
  • poPHPArray: Indicates that the ';' separated list of values of this parameter should be expanded into name[]=val1&...&[]=valN.
  • poListArray: Indicates that the ';' separated list of values of this parameter should be expanded into name=val1,...,valN.