|
111 | 111 |
|
112 | 112 | <div class="header"> |
113 | 113 | <div class="summary"> |
| 114 | +<a href="#pub-types">Public Types</a> | |
114 | 115 | <a href="#pub-methods">Public Member Functions</a> | |
115 | 116 | <a href="class_sinric_pro_class-members.html">List of all members</a> </div> |
116 | 117 | <div class="headertitle"> |
|
123 | 124 |
|
124 | 125 | <p>Inherits SinricProInterface.</p> |
125 | 126 | <table class="memberdecls"> |
| 127 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| 128 | +Public Types</h2></td></tr> |
| 129 | +<tr class="memitem:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="memItemLeft" align="right" valign="top">typedef std::function< void(void)> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a></td></tr> |
| 130 | +<tr class="memdesc:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="mdescLeft"> </td><td class="mdescRight">Callback definition for onConnected function. <a href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">More...</a><br /></td></tr> |
| 131 | +<tr class="separator:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="memSeparator" colspan="2"> </td></tr> |
| 132 | +<tr class="memitem:ad84930f3c26ac3692cc885be197d39c7"><td class="memItemLeft" align="right" valign="top">typedef std::function< void(void)> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a></td></tr> |
| 133 | +<tr class="memdesc:ad84930f3c26ac3692cc885be197d39c7"><td class="mdescLeft"> </td><td class="mdescRight">Callback definition for onDisconnected function. <a href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">More...</a><br /></td></tr> |
| 134 | +<tr class="separator:ad84930f3c26ac3692cc885be197d39c7"><td class="memSeparator" colspan="2"> </td></tr> |
| 135 | +</table><table class="memberdecls"> |
126 | 136 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
127 | 137 | Public Member Functions</h2></td></tr> |
128 | 138 | <tr class="memitem:a57722dec8f1f987f57c8fff9eed66765"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a57722dec8f1f987f57c8fff9eed66765">begin</a> (String socketAuthToken, String signingKey, String serverURL=SINRICPRO_SERVER_URL)</td></tr> |
|
131 | 141 | <tr class="memitem:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">handle</a> ()</td></tr> |
132 | 142 | <tr class="memdesc:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="mdescLeft"> </td><td class="mdescRight">Handles communication between device and <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> Server. <a href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">More...</a><br /></td></tr> |
133 | 143 | <tr class="separator:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="memSeparator" colspan="2"> </td></tr> |
| 144 | +<tr class="memitem:ac33a355adfc413d4ff36974d735115bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">onConnected</a> (<a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a> cb)</td></tr> |
| 145 | +<tr class="memdesc:ac33a355adfc413d4ff36974d735115bd"><td class="mdescLeft"> </td><td class="mdescRight">Set callback function for websocket connected event. <a href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">More...</a><br /></td></tr> |
| 146 | +<tr class="separator:ac33a355adfc413d4ff36974d735115bd"><td class="memSeparator" colspan="2"> </td></tr> |
| 147 | +<tr class="memitem:a654bb017ca55b448d55bb36e0346f38a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">onDisconnected</a> (<a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a> cb)</td></tr> |
| 148 | +<tr class="memdesc:a654bb017ca55b448d55bb36e0346f38a"><td class="mdescLeft"> </td><td class="mdescRight">Set callback function for websocket disconnected event. <a href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">More...</a><br /></td></tr> |
| 149 | +<tr class="separator:a654bb017ca55b448d55bb36e0346f38a"><td class="memSeparator" colspan="2"> </td></tr> |
134 | 150 | <tr class="memitem:a27a9bb7f1e8bde0f39398649493b6f93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">restoreDeviceStates</a> (bool flag)</td></tr> |
135 | 151 | <tr class="memdesc:a27a9bb7f1e8bde0f39398649493b6f93"><td class="mdescLeft"> </td><td class="mdescRight">Enable / disable restore device states function. <a href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">More...</a><br /></td></tr> |
136 | 152 | <tr class="separator:a27a9bb7f1e8bde0f39398649493b6f93"><td class="memSeparator" colspan="2"> </td></tr> |
|
140 | 156 | </table> |
141 | 157 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
142 | 158 | <div class="textblock"><p>The main class of this library, handling communication between <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> Server and your devices. </p> |
143 | | -</div><h2 class="groupheader">Member Function Documentation</h2> |
| 159 | +</div><h2 class="groupheader">Member Typedef Documentation</h2> |
| 160 | +<a id="a4d7d8547a83d53c20cbd9aa7768e99f5"></a> |
| 161 | +<h2 class="memtitle"><span class="permalink"><a href="#a4d7d8547a83d53c20cbd9aa7768e99f5">◆ </a></span>ConnectedCallbackHandler</h2> |
| 162 | + |
| 163 | +<div class="memitem"> |
| 164 | +<div class="memproto"> |
| 165 | + <table class="memname"> |
| 166 | + <tr> |
| 167 | + <td class="memname">typedef std::function<void(void)> <a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a></td> |
| 168 | + </tr> |
| 169 | + </table> |
| 170 | +</div><div class="memdoc"> |
| 171 | + |
| 172 | +<p>Callback definition for onConnected function. </p> |
| 173 | +<p>Gets called when device is connected to <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> server </p><dl class="params"><dt>Parameters</dt><dd> |
| 174 | + <table class="params"> |
| 175 | + <tr><td class="paramname">void</td><td></td></tr> |
| 176 | + </table> |
| 177 | + </dd> |
| 178 | +</dl> |
| 179 | +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> |
| 180 | + |
| 181 | +</div> |
| 182 | +</div> |
| 183 | +<a id="ad84930f3c26ac3692cc885be197d39c7"></a> |
| 184 | +<h2 class="memtitle"><span class="permalink"><a href="#ad84930f3c26ac3692cc885be197d39c7">◆ </a></span>DisconnectedCallbackHandler</h2> |
| 185 | + |
| 186 | +<div class="memitem"> |
| 187 | +<div class="memproto"> |
| 188 | + <table class="memname"> |
| 189 | + <tr> |
| 190 | + <td class="memname">typedef std::function<void(void)> <a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a></td> |
| 191 | + </tr> |
| 192 | + </table> |
| 193 | +</div><div class="memdoc"> |
| 194 | + |
| 195 | +<p>Callback definition for onDisconnected function. </p> |
| 196 | +<p>Gets called when device is disconnected from <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> server </p><dl class="params"><dt>Parameters</dt><dd> |
| 197 | + <table class="params"> |
| 198 | + <tr><td class="paramname">void</td><td></td></tr> |
| 199 | + </table> |
| 200 | + </dd> |
| 201 | +</dl> |
| 202 | +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> |
| 203 | + |
| 204 | +</div> |
| 205 | +</div> |
| 206 | +<h2 class="groupheader">Member Function Documentation</h2> |
144 | 207 | <a id="a57722dec8f1f987f57c8fff9eed66765"></a> |
145 | 208 | <h2 class="memtitle"><span class="permalink"><a href="#a57722dec8f1f987f57c8fff9eed66765">◆ </a></span>begin()</h2> |
146 | 209 |
|
@@ -222,6 +285,68 @@ <h1><a class="anchor" id="handle"></a> |
222 | 285 | </div><!-- fragment --> |
223 | 286 | </div> |
224 | 287 | </div> |
| 288 | +<a id="ac33a355adfc413d4ff36974d735115bd"></a> |
| 289 | +<h2 class="memtitle"><span class="permalink"><a href="#ac33a355adfc413d4ff36974d735115bd">◆ </a></span>onConnected()</h2> |
| 290 | + |
| 291 | +<div class="memitem"> |
| 292 | +<div class="memproto"> |
| 293 | + <table class="memname"> |
| 294 | + <tr> |
| 295 | + <td class="memname">void onConnected </td> |
| 296 | + <td>(</td> |
| 297 | + <td class="paramtype"><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a> </td> |
| 298 | + <td class="paramname"><em>cb</em></td><td>)</td> |
| 299 | + <td></td> |
| 300 | + </tr> |
| 301 | + </table> |
| 302 | +</div><div class="memdoc"> |
| 303 | + |
| 304 | +<p>Set callback function for websocket connected event. </p> |
| 305 | +<dl class="params"><dt>Parameters</dt><dd> |
| 306 | + <table class="params"> |
| 307 | + <tr><td class="paramname">cb</td><td>Function pointer to a <code>ConnectedCallbackHandler</code> function </td></tr> |
| 308 | + </table> |
| 309 | + </dd> |
| 310 | +</dl> |
| 311 | +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> |
| 312 | +<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5" title="Callback definition for onConnected function.">ConnectedCallbackHandler</a> </dd></dl> |
| 313 | +<h1><a class="anchor" id="onConnected"></a> |
| 314 | +Example-Code</h1> |
| 315 | +<div class="fragment"><div class="line"> <a class="code" href="class_sinric_pro.html">SinricPro</a>.onConnected([](){ Serial.printf(<span class="stringliteral">"Connected to SinricPro\r\n"</span>); }); </div> |
| 316 | +</div><!-- fragment --> |
| 317 | +</div> |
| 318 | +</div> |
| 319 | +<a id="a654bb017ca55b448d55bb36e0346f38a"></a> |
| 320 | +<h2 class="memtitle"><span class="permalink"><a href="#a654bb017ca55b448d55bb36e0346f38a">◆ </a></span>onDisconnected()</h2> |
| 321 | + |
| 322 | +<div class="memitem"> |
| 323 | +<div class="memproto"> |
| 324 | + <table class="memname"> |
| 325 | + <tr> |
| 326 | + <td class="memname">void onDisconnected </td> |
| 327 | + <td>(</td> |
| 328 | + <td class="paramtype"><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a> </td> |
| 329 | + <td class="paramname"><em>cb</em></td><td>)</td> |
| 330 | + <td></td> |
| 331 | + </tr> |
| 332 | + </table> |
| 333 | +</div><div class="memdoc"> |
| 334 | + |
| 335 | +<p>Set callback function for websocket disconnected event. </p> |
| 336 | +<dl class="params"><dt>Parameters</dt><dd> |
| 337 | + <table class="params"> |
| 338 | + <tr><td class="paramname">cb</td><td>Function pointer to a <code>DisconnectedCallbackHandler</code> function </td></tr> |
| 339 | + </table> |
| 340 | + </dd> |
| 341 | +</dl> |
| 342 | +<dl class="section return"><dt>Returns</dt><dd>void </dd></dl> |
| 343 | +<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7" title="Callback definition for onDisconnected function.">DisconnectedCallbackHandler</a> </dd></dl> |
| 344 | +<h1><a class="anchor" id="onDisconnected"></a> |
| 345 | +Example-Code</h1> |
| 346 | +<div class="fragment"><div class="line"> <a class="code" href="class_sinric_pro.html">SinricPro</a>.onDisconnected([](){ Serial.printf(<span class="stringliteral">"Disconnected from SinricPro\r\n"</span>); });</div> |
| 347 | +</div><!-- fragment --> |
| 348 | +</div> |
| 349 | +</div> |
225 | 350 | <a id="a5df2137b8d06e894c917fd28c35c31a4"></a> |
226 | 351 | <h2 class="memtitle"><span class="permalink"><a href="#a5df2137b8d06e894c917fd28c35c31a4">◆ </a></span>operator[]()</h2> |
227 | 352 |
|
|
0 commit comments