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:
34 const ProviderInfo = <DataProviderInfo>{
35 "name": "create",
36 "desc": "EmpathicBuilding measurements create API data provider",
37 "type": "EmpathicBuildingMeasurementsCreateDataProvider",
39 "supports_request": True,
40 };
41
43 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
44 AbstractDataProvider::DataProviderSummaryInfoKeys
45 });
46
48 const RequestType = new SoftListDataType("EmpathicBuildingMeasurementEventType", new EmpathicBuildingMeasurementsCreateRequestDataType());
49
51 const ResponseType = AbstractDataProviderTypeMap."string";
52
54 constructor(*hash<auto> options);
55
56
59
60
62 string getName();
63
64
66 *string getDesc();
67
68
70
75protected:
76 auto doRequestImpl(auto req, *hash<auto> request_options);
77public:
78
79
81
83protected:
85public:
86
87
89
91protected:
93public:
94
95
97 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
98
99};
100
103
104public:
105protected:
107 const Fields = {
108 // query parameters
109 "start": {
110 "type": DateType,
111 "desc": "The start time of reservation (resolution of milliseconds)",
112 },
113 "end": {
114 "type": DateType,
115 "desc": "The end time of reservation (resolution of milliseconds)",
116 },
117 "subject": {
118 "type": StringOrNothingType,
119 "desc": "The optional subject of the meeting",
120 },
121 };
122
123public:
124
127
128};
129
132
133public:
134protected:
136 const Fields = {
137 // query parameters
138 "type": {
139 "type": StringType,
140 "desc": "The name of measurements to create",
141 },
142 "time": {
143 "type": DateOrNothingType,
144 "desc": "The current date/time of the request; if omitted, it will be added automatically to the "
145 "request (resultion of milliseconds)",
146 },
147 "vendor_id": {
148 "type": StringType,
149 "desc": "An ID value from the remote / vendor system",
150 },
151 /*
152 "vendor": {
153 "type": StringOrNothingType,
154 "desc": "The source of the data (or the 'integrator')",
155 },
156 */
157 "name": {
158 "type": StringType,
159 "desc": "Human readable name for this specific data provider",
160 },
161 "events": {
162 "type": new SoftListDataType("EmpathicBuildingMeasurementEventType", new EmpathicBuildingMeasurementEventType()),
163 "desc": "List of measurement events to create",
164 },
165 };
166
167public:
168
171
172};
173};
The EmpathicBuilding data provider class.
Definition: EmpathicBuildingDataProviderBase.qc.dox.h:28
RestClient::RestClient rest
The REST client object for API calls.
Definition: EmpathicBuildingDataProviderBase.qc.dox.h:33
const ConstructorOptions
Constructor options.
Definition: EmpathicBuildingDataProvider.qc.dox.h:46
Measurement event data type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:102
const Fields
Field descriptions.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:107
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:34
const ResponseType
Response type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:51
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:43
const RequestType
Request type.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:48
*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:131
const Fields
Field descriptions.
Definition: EmpathicBuildingMeasurementsCreateDataProvider.qc.dox.h:136
Qore EmpathicBuildingDataProvider module definition.
Definition: EmpathicBuildingDataProvider.qc.dox.h:26