tRacket-sensor

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tRacket Sensor: API::Request Struct 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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">tRacket Sensor<span id="projectnumber">&#160;0.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="classAPI.html">API</a></li><li class="navelem"><a class="el" href="structAPI_1_1Request.html">Request</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structAPI_1_1Request-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">API::Request Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>String builder to create URLs for <a class="el" href="classAPI.html" title="Provides interface for API calls.">API</a> endpoints and requests.  
 <a href="structAPI_1_1Request.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:add312b1776b4e110e1916c73fb430c86" id="r_add312b1776b4e110e1916c73fb430c86"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAPI_1_1Request.html#add312b1776b4e110e1916c73fb430c86">Request</a> (const char endpoint[])</td></tr>
<tr class="memdesc:add312b1776b4e110e1916c73fb430c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new request with zero parameters.  <br /></td></tr>
<tr class="separator:add312b1776b4e110e1916c73fb430c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ade33dc9bf0717c1bbfcd24a6b17698" id="r_a1ade33dc9bf0717c1bbfcd24a6b17698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAPI_1_1Request.html">Request</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAPI_1_1Request.html#a1ade33dc9bf0717c1bbfcd24a6b17698">addParam</a> (const char param[], String value)</td></tr>
<tr class="memdesc:a1ade33dc9bf0717c1bbfcd24a6b17698"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a parameter to the given request.  <br /></td></tr>
<tr class="separator:a1ade33dc9bf0717c1bbfcd24a6b17698"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac1ed273e77b895150fa098ff2d4e88a1" id="r_ac1ed273e77b895150fa098ff2d4e88a1"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAPI_1_1Request.html#ac1ed273e77b895150fa098ff2d4e88a1">url</a></td></tr>
<tr class="memdesc:ac1ed273e77b895150fa098ff2d4e88a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the resulting request URL.  <br /></td></tr>
<tr class="separator:ac1ed273e77b895150fa098ff2d4e88a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b659baa844d7055a19bee5d207b2f9e" id="r_a5b659baa844d7055a19bee5d207b2f9e"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAPI_1_1Request.html#a5b659baa844d7055a19bee5d207b2f9e">params</a></td></tr>
<tr class="separator:a5b659baa844d7055a19bee5d207b2f9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>String builder to create URLs for <a class="el" href="classAPI.html" title="Provides interface for API calls.">API</a> endpoints and requests. </p>

<p class="definition">Definition at line <a class="el" href="api_8h_source.html#l00042">42</a> of file <a class="el" href="api_8h_source.html">api.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="add312b1776b4e110e1916c73fb430c86" name="add312b1776b4e110e1916c73fb430c86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add312b1776b4e110e1916c73fb430c86">&#9670;&#160;</a></span>Request()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">API::Request::Request </td>
          <td>(</td>
          <td class="paramtype">const char&#160;</td>
          <td class="paramname"><em>endpoint</em>[]</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes a new request with zero parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">endpoint</td><td>Endpoint for the <a class="el" href="classAPI.html" title="Provides interface for API calls.">API</a> request. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1ade33dc9bf0717c1bbfcd24a6b17698" name="a1ade33dc9bf0717c1bbfcd24a6b17698"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ade33dc9bf0717c1bbfcd24a6b17698">&#9670;&#160;</a></span>addParam()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structAPI_1_1Request.html">Request</a> &amp; API::Request::addParam </td>
          <td>(</td>
          <td class="paramtype">const char&#160;</td>
          <td class="paramname"><em>param</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds a parameter to the given request. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">param</td><td>Name of parameter to add. </td></tr>
    <tr><td class="paramname">value</td><td>Value of the added parameter. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5b659baa844d7055a19bee5d207b2f9e" name="a5b659baa844d7055a19bee5d207b2f9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b659baa844d7055a19bee5d207b2f9e">&#9670;&#160;</a></span>params</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String API::Request::params</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="api_8h_source.html#l00059">59</a> of file <a class="el" href="api_8h_source.html">api.h</a>.</p>

</div>
</div>
<a id="ac1ed273e77b895150fa098ff2d4e88a1" name="ac1ed273e77b895150fa098ff2d4e88a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ed273e77b895150fa098ff2d4e88a1">&#9670;&#160;</a></span>url</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String API::Request::url</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stores the resulting request URL. </p>

<p class="definition">Definition at line <a class="el" href="api_8h_source.html#l00058">58</a> of file <a class="el" href="api_8h_source.html">api.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>noisemeter-device/<a class="el" href="api_8h_source.html">api.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>