Qore EmpathicBuildingDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
31
32public:
35
37 const ProviderInfo = <DataProviderInfo>{
38 "name": "create",
39 "desc": "EmpathicBuilding measurements create API data provider",
40 "type": "EmpathicBuildingMeasurementsCreateDataProvider",
42 "supports_request": True,
43 };
44
46 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
47 AbstractDataProvider::DataProviderSummaryInfoKeys
48 });
49
51 const RequestType = new SoftListDataType("EmpathicBuildingMeasurementEventType",
53
55 const ResponseType = AbstractDataProviderTypeMap."string";
56
58 constructor(*hash<auto> options);
59
60
63
64
66 string getName();
67
68
70 *string getDesc();
71
72
74
79protected:
80 auto doRequestImpl(auto req, *hash<auto> request_options);
81public:
82
83
85
87protected:
89public:
90
91
93
95protected:
97public:
98
99
101 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
102
103};
104
107
108public:
109protected:
111 const Fields = {
112 // query parameters
113 "start": {
114 "type": DateType,
115 "desc": "The start time of reservation (resolution of milliseconds)",
116 },
117 "end": {
118 "type": DateType,
119 "desc": "The end time of reservation (resolution of milliseconds)",
120 },
121 "subject": {
122 "type": StringOrNothingType,
123 "desc": "The optional subject of the meeting",
124 },
125 };
126
127public:
128
131
132};
133
136
137public:
138protected:
140 const Fields = {
141 // query parameters
142 "type": {
143 "type": StringType,
144 "desc": "The name of measurements to create",
145 },
146 "time": {
147 "type": DateOrNothingType,
148 "desc": "The current date/time of the request; if omitted, it will be added automatically to the "
149 "request (resultion of milliseconds)",
150 },
151 "vendor_id": {
152 "type": StringType,
153 "desc": "An ID value from the remote / vendor system",
154 },
155 /*
156 "vendor": {
157 "type": StringOrNothingType,
158 "desc": "The source of the data (or the 'integrator')",
159 },
160 */
161 "name": {
162 "type": StringType,
163 "desc": "Human readable name for this specific data provider",
164 },
165 "events": {
166 "type": new SoftListDataType("EmpathicBuildingMeasurementEventType", new EmpathicBuildingMeasurementEventType()),
167 "desc": "List of measurement events to create",
168 },
169 };
170
171public:
172
175
176};
177};
const ConstructorOptions
Constructor options.
Definition: EmpathicBuildingDataProvider.qc.dox.h:49
Measurement event data type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:106
const Fields
Field descriptions.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:111
The Empathic Building measurements create API data provider.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:30
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
const ProviderInfo
Provider info.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:37
const ResponseType
Response type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:55
RestClient::RestClient rest
REST client connection.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:34
constructor(*hash< auto > options)
Creates the object from constructor options.
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ProviderSummaryInfo
Provider summary info.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:46
const RequestType
Request type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:51
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
Create measurements request data type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:135
const Fields
Field descriptions.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:140
Qore EmpathicBuildingDataProvider module definition.
Definition: EmpathicBuildingDataProvider.qc.dox.h:26