classhueplusplus_1_1_create_rule.html
10.5 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
<!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::CreateRule 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_create_rule.html">CreateRule</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhueplusplus_1_1_create_rule-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::CreateRule Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>.
<a href="classhueplusplus_1_1_create_rule.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_rule_8h_source.html">hueplusplus/Rule.h</a>></code></p>
<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:affe5cdbf3df4b42efb72914a38df3669"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_rule.html#affe5cdbf3df4b42efb72914a38df3669">CreateRule</a> (const std::vector< <a class="el" href="classhueplusplus_1_1_condition.html">Condition</a> > &conditions, const std::vector< <a class="el" href="classhueplusplus_1_1_action.html">Action</a> > &actions)</td></tr>
<tr class="memdesc:affe5cdbf3df4b42efb72914a38df3669"><td class="mdescLeft"> </td><td class="mdescRight">Construct with necessary parameters. <a href="#affe5cdbf3df4b42efb72914a38df3669">More...</a><br /></td></tr>
<tr class="separator:affe5cdbf3df4b42efb72914a38df3669"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1900e340916b8574a25fa783854e2b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_rule.html#ad1900e340916b8574a25fa783854e2b7">setName</a> (const std::string &name)</td></tr>
<tr class="memdesc:ad1900e340916b8574a25fa783854e2b7"><td class="mdescLeft"> </td><td class="mdescRight">Set name. <a href="#ad1900e340916b8574a25fa783854e2b7">More...</a><br /></td></tr>
<tr class="separator:ad1900e340916b8574a25fa783854e2b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42bc4ab272d5574d52360c3c17d519dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_rule.html#a42bc4ab272d5574d52360c3c17d519dc">setStatus</a> (bool enabled)</td></tr>
<tr class="memdesc:a42bc4ab272d5574d52360c3c17d519dc"><td class="mdescLeft"> </td><td class="mdescRight">Set status. <a href="#a42bc4ab272d5574d52360c3c17d519dc">More...</a><br /></td></tr>
<tr class="separator:a42bc4ab272d5574d52360c3c17d519dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad43ddc031438ccf1616bc66a8a00c981"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_rule.html#ad43ddc031438ccf1616bc66a8a00c981">getRequest</a> () const</td></tr>
<tr class="memdesc:ad43ddc031438ccf1616bc66a8a00c981"><td class="mdescLeft"> </td><td class="mdescRight">Get request to create the rule. <a href="#ad43ddc031438ccf1616bc66a8a00c981">More...</a><br /></td></tr>
<tr class="separator:ad43ddc031438ccf1616bc66a8a00c981"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>. </p>
<p>Can be used like a builder object with chained calls. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="affe5cdbf3df4b42efb72914a38df3669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affe5cdbf3df4b42efb72914a38df3669">◆ </a></span>CreateRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::CreateRule::CreateRule </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="classhueplusplus_1_1_condition.html">Condition</a> > & </td>
<td class="paramname"><em>conditions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="classhueplusplus_1_1_action.html">Action</a> > & </td>
<td class="paramname"><em>actions</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct with necessary parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conditions</td><td>Conditions for the rule. Must not be empty </td></tr>
<tr><td class="paramname">actions</td><td>Actions for the rule. Must not be empty </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad43ddc031438ccf1616bc66a8a00c981"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad43ddc031438ccf1616bc66a8a00c981">◆ </a></span>getRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::CreateRule::getRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request to create the rule. </p>
<dl class="section return"><dt>Returns</dt><dd>JSON request for a POST to create the new rule. </dd></dl>
</div>
</div>
<a id="ad1900e340916b8574a25fa783854e2b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1900e340916b8574a25fa783854e2b7">◆ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a> & hueplusplus::CreateRule::setName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set name. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_rule.html#a03d39528e60cc96e24325cbdf9c3acb1" title="Set rule name. ">Rule::setName</a> </dd></dl>
</div>
</div>
<a id="a42bc4ab272d5574d52360c3c17d519dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42bc4ab272d5574d52360c3c17d519dc">◆ </a></span>setStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a> & hueplusplus::CreateRule::setStatus </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set status. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_rule.html#afd8050aa039ba405d009e7d286aa8bd7" title="Enable or disable rule. ">Rule::setEnabled</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_rule_8h_source.html">Rule.h</a></li>
<li>src/<a class="el" href="_rule_8cpp.html">Rule.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>