cmlabs::RESTParam Struct Reference

Definition of one parameter of a REST request, as declared in the API XML. More...

#include <RESTAPI.h>

Collaboration diagram for cmlabs::RESTParam:

Public Types
enum	Type {   INTEGER , FLOAT , TEXT , ARRAY ,   IMAGE , VIDEO , BINARY }

Public Attributes
enum cmlabs::RESTParam::Type	type
	Expected data type of the parameter.
bool	optional
	true if the parameter may be omitted.
bool	allowEmpty
	true if an empty value is acceptable.
std::string	name
	Parameter name.
std::string	objects
	For ARRAY parameters: the nested object/param-set name.

Detailed Description

Definition of one parameter of a REST request, as declared in the API XML.

Definition at line 21 of file RESTAPI.h.

Member Enumeration Documentation

Type

enum cmlabs::RESTParam::Type

Enumerator
INTEGER
FLOAT
TEXT
ARRAY
IMAGE
VIDEO
BINARY

Definition at line 22 of file RESTAPI.h.

Member Data Documentation

allowEmpty

bool cmlabs::RESTParam::allowEmpty

true if an empty value is acceptable.

Definition at line 24 of file RESTAPI.h.

Referenced by cmlabs::RESTParser::parseParamSet().

name

std::string cmlabs::RESTParam::name

Parameter name.

Definition at line 25 of file RESTAPI.h.

Referenced by cmlabs::RESTParser::parseParamSet(), cmlabs::RESTParser::setParameterValue(), and cmlabs::RESTParser::setParameterValue().

objects

std::string cmlabs::RESTParam::objects

For ARRAY parameters: the nested object/param-set name.

Definition at line 26 of file RESTAPI.h.

Referenced by cmlabs::RESTParser::parseParamSet().

optional

bool cmlabs::RESTParam::optional

true if the parameter may be omitted.

Definition at line 23 of file RESTAPI.h.

Referenced by cmlabs::RESTParser::parseParamSet().

type

enum cmlabs::RESTParam::Type cmlabs::RESTParam::type

Expected data type of the parameter.

Referenced by cmlabs::RESTParser::parseParamSet(), cmlabs::RESTParser::setParameterValue(), and cmlabs::RESTParser::setParameterValue().

---

The documentation for this struct was generated from the following file:

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/RESTAPI.h