classhueplusplus_1_1_action.html
17.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::Action Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_action.html">Action</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classhueplusplus_1_1_action-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::Action Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> executed by the bridge, e.g. as a <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a> command.
<a href="classhueplusplus_1_1_action.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_action_8h_source.html">hueplusplus/Action.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a2181208d0b6e26bdb84e594af85b1542"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> { <a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a42b90196b487c54069097a68fe98ab6f">Method::post</a>,
<a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542a8e13ffc9fd9d6a6761231a764bdf106b">Method::put</a>,
<a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542abd269368d92362975c0ab1bb7b461813">Method::deleteMethod</a>
}<tr class="memdesc:a2181208d0b6e26bdb84e594af85b1542"><td class="mdescLeft"> </td><td class="mdescRight">Method used for the command. <a href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a2181208d0b6e26bdb84e594af85b1542"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a581153171ecf44ce583e088c9bd6f048"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a581153171ecf44ce583e088c9bd6f048">Action</a> (const nlohmann::json &json)</td></tr>
<tr class="memdesc:a581153171ecf44ce583e088c9bd6f048"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> from json. <a href="#a581153171ecf44ce583e088c9bd6f048">More...</a><br /></td></tr>
<tr class="separator:a581153171ecf44ce583e088c9bd6f048"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a258c2d4a88d5eed9dc85a2539fbcbd71"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a258c2d4a88d5eed9dc85a2539fbcbd71">getAddress</a> () const</td></tr>
<tr class="memdesc:a258c2d4a88d5eed9dc85a2539fbcbd71"><td class="mdescLeft"> </td><td class="mdescRight">Get address the request is made to. <a href="#a258c2d4a88d5eed9dc85a2539fbcbd71">More...</a><br /></td></tr>
<tr class="separator:a258c2d4a88d5eed9dc85a2539fbcbd71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65f0cf2fb01397e023b1098aae2e8184"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a65f0cf2fb01397e023b1098aae2e8184">getMethod</a> () const</td></tr>
<tr class="memdesc:a65f0cf2fb01397e023b1098aae2e8184"><td class="mdescLeft"> </td><td class="mdescRight">Get request method. <a href="#a65f0cf2fb01397e023b1098aae2e8184">More...</a><br /></td></tr>
<tr class="separator:a65f0cf2fb01397e023b1098aae2e8184"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25e3761540d73055114b68c931353b72"><td class="memItemLeft" align="right" valign="top">const nlohmann::json & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a25e3761540d73055114b68c931353b72">getBody</a> () const</td></tr>
<tr class="memdesc:a25e3761540d73055114b68c931353b72"><td class="mdescLeft"> </td><td class="mdescRight">Get request body. <a href="#a25e3761540d73055114b68c931353b72">More...</a><br /></td></tr>
<tr class="separator:a25e3761540d73055114b68c931353b72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6de75285262d49b6ffb7edd4051cf6f3"><td class="memItemLeft" align="right" valign="top">const nlohmann::json & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a6de75285262d49b6ffb7edd4051cf6f3">toJson</a> () const</td></tr>
<tr class="memdesc:a6de75285262d49b6ffb7edd4051cf6f3"><td class="mdescLeft"> </td><td class="mdescRight">Get json object of command. <a href="#a6de75285262d49b6ffb7edd4051cf6f3">More...</a><br /></td></tr>
<tr class="separator:a6de75285262d49b6ffb7edd4051cf6f3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a51b50bd1b0b8dd3641a42218abb9f24e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a51b50bd1b0b8dd3641a42218abb9f24e">parseMethod</a> (const std::string &s)</td></tr>
<tr class="memdesc:a51b50bd1b0b8dd3641a42218abb9f24e"><td class="mdescLeft"> </td><td class="mdescRight">Parse Method from string. <a href="#a51b50bd1b0b8dd3641a42218abb9f24e">More...</a><br /></td></tr>
<tr class="separator:a51b50bd1b0b8dd3641a42218abb9f24e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a758c2ebb8875022fffca68c5b6a3c2d5"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_action.html#a758c2ebb8875022fffca68c5b6a3c2d5">methodToString</a> (<a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> m)</td></tr>
<tr class="memdesc:a758c2ebb8875022fffca68c5b6a3c2d5"><td class="mdescLeft"> </td><td class="mdescRight">Get string from Method. <a href="#a758c2ebb8875022fffca68c5b6a3c2d5">More...</a><br /></td></tr>
<tr class="separator:a758c2ebb8875022fffca68c5b6a3c2d5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> executed by the bridge, e.g. as a <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a> command. </p>
<p>The action makes either a POST, PUT or DELETE request with a given body to an address on the bridge.</p>
<p>The <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> can also be created by <a class="el" href="classhueplusplus_1_1_state_transaction.html#a44db927471c11bab402e9a295014adff" title="Create an Action from the transaction. ">StateTransaction::toAction()</a>. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a2181208d0b6e26bdb84e594af85b1542"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2181208d0b6e26bdb84e594af85b1542">◆ </a></span>Method</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">hueplusplus::Action::Method</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Method used for the command. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2181208d0b6e26bdb84e594af85b1542a42b90196b487c54069097a68fe98ab6f"></a>post </td><td class="fielddoc"><p>POST request. </p>
</td></tr>
<tr><td class="fieldname"><a id="a2181208d0b6e26bdb84e594af85b1542a8e13ffc9fd9d6a6761231a764bdf106b"></a>put </td><td class="fielddoc"><p>PUT request. </p>
</td></tr>
<tr><td class="fieldname"><a id="a2181208d0b6e26bdb84e594af85b1542abd269368d92362975c0ab1bb7b461813"></a>deleteMethod </td><td class="fielddoc"><p>DELETE request. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a581153171ecf44ce583e088c9bd6f048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a581153171ecf44ce583e088c9bd6f048">◆ </a></span>Action()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::Action::Action </td>
<td>(</td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>json</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create <a class="el" href="classhueplusplus_1_1_action.html" title="Action executed by the bridge, e.g. as a Schedule command. ">Action</a> from json. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">json</td><td>JSON object with address, method and body </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a258c2d4a88d5eed9dc85a2539fbcbd71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a258c2d4a88d5eed9dc85a2539fbcbd71">◆ </a></span>getAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Action::getAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get address the request is made to. </p>
</div>
</div>
<a id="a25e3761540d73055114b68c931353b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25e3761540d73055114b68c931353b72">◆ </a></span>getBody()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const nlohmann::json & hueplusplus::Action::getBody </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request body. </p>
</div>
</div>
<a id="a65f0cf2fb01397e023b1098aae2e8184"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65f0cf2fb01397e023b1098aae2e8184">◆ </a></span>getMethod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Action::Method</a> hueplusplus::Action::getMethod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request method. </p>
</div>
</div>
<a id="a758c2ebb8875022fffca68c5b6a3c2d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a758c2ebb8875022fffca68c5b6a3c2d5">◆ </a></span>methodToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Action::methodToString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Method</a> </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get string from Method. </p>
<dl class="section return"><dt>Returns</dt><dd><code>POST</code>, <code>PUT</code> or <code>DELETE</code> </dd></dl>
</div>
</div>
<a id="a51b50bd1b0b8dd3641a42218abb9f24e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51b50bd1b0b8dd3641a42218abb9f24e">◆ </a></span>parseMethod()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_action.html#a2181208d0b6e26bdb84e594af85b1542">Action::Method</a> hueplusplus::Action::parseMethod </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse Method from string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td><code>POST</code>, <code>PUT</code> or <code>DELETE</code> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6de75285262d49b6ffb7edd4051cf6f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6de75285262d49b6ffb7edd4051cf6f3">◆ </a></span>toJson()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const nlohmann::json & hueplusplus::Action::toJson </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get json object of command. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_action_8h_source.html">Action.h</a></li>
<li>src/<a class="el" href="_action_8cpp.html">Action.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>