Files
wownero-cpp/docs/structmonero_1_1monero__send__request.html
T
2019-12-15 08:42:10 -05:00

209 lines
14 KiB
HTML

<!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">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_send_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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Monero C++ Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<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="namespacemonero.html">monero</a></li><li class="navelem"><a class="el" href="structmonero_1_1monero__send__request.html">monero_send_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-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmonero_1_1monero__send__request-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">monero::monero_send_request Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for monero::monero_send_request:</div>
<div class="dyncontent">
<div class="center">
<img src="structmonero_1_1monero__send__request.png" usemap="#monero::monero_5Fsend_5Frequest_map" alt=""/>
<map id="monero::monero_5Fsend_5Frequest_map" name="monero::monero_5Fsend_5Frequest_map">
<area href="structmonero_1_1serializable__struct.html" alt="monero::serializable_struct" shape="rect" coords="0,0,184,24"/>
</map>
</div></div>
<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:a3f728a0be84a9b6c81f3fded26aeb77a"><td class="memItemLeft" align="right" valign="top"><a id="a3f728a0be84a9b6c81f3fded26aeb77a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>monero_send_request</b> (const <a class="el" href="structmonero_1_1monero__send__request.html">monero_send_request</a> &amp;request)</td></tr>
<tr class="separator:a3f728a0be84a9b6c81f3fded26aeb77a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad89fb92ab7f2226a33807f2e842c9655"><td class="memItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1monero__send__request.html#ad89fb92ab7f2226a33807f2e842c9655">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const</td></tr>
<tr class="separator:ad89fb92ab7f2226a33807f2e842c9655"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95e42e149aa92a01ac5b7df5a3441d65"><td class="memItemLeft" align="right" valign="top"><a id="a95e42e149aa92a01ac5b7df5a3441d65"></a>
<a class="el" href="structmonero_1_1monero__send__request.html">monero_send_request</a>&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> () const</td></tr>
<tr class="separator:a95e42e149aa92a01ac5b7df5a3441d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmonero_1_1serializable__struct"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structmonero_1_1serializable__struct')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structmonero_1_1serializable__struct.html">monero::serializable_struct</a></td></tr>
<tr class="memitem:aff4103707ee262cc4bd15d8e789adddc inherit pub_methods_structmonero_1_1serializable__struct"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1serializable__struct.html#aff4103707ee262cc4bd15d8e789adddc">serialize</a> () const</td></tr>
<tr class="separator:aff4103707ee262cc4bd15d8e789adddc inherit pub_methods_structmonero_1_1serializable__struct"><td class="memSeparator" colspan="2">&#160;</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:a007945ef0596986c3a458dbffdccd8c3"><td class="memItemLeft" align="right" valign="top"><a id="a007945ef0596986c3a458dbffdccd8c3"></a>
static shared_ptr&lt; <a class="el" href="structmonero_1_1monero__send__request.html">monero_send_request</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const string &amp;send_request_json)</td></tr>
<tr class="separator:a007945ef0596986c3a458dbffdccd8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a346cf4e1fb584225bf830508f7b0a1b9"><td class="memItemLeft" align="right" valign="top"><a id="a346cf4e1fb584225bf830508f7b0a1b9"></a>
vector&lt; shared_ptr&lt; <a class="el" href="structmonero_1_1monero__destination.html">monero_destination</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_destinations</b></td></tr>
<tr class="separator:a346cf4e1fb584225bf830508f7b0a1b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31a295871c1a81a2b58d3a5e716f7438"><td class="memItemLeft" align="right" valign="top"><a id="a31a295871c1a81a2b58d3a5e716f7438"></a>
boost::optional&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_payment_id</b></td></tr>
<tr class="separator:a31a295871c1a81a2b58d3a5e716f7438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3441f5f743bac480c65563e015ae8994"><td class="memItemLeft" align="right" valign="top"><a id="a3441f5f743bac480c65563e015ae8994"></a>
boost::optional&lt; <a class="el" href="namespacemonero.html#ad102bb6207c4abe9d875f8b0edc1a45e">monero_send_priority</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_priority</b></td></tr>
<tr class="separator:a3441f5f743bac480c65563e015ae8994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addbd2a1fc298ed70150e0d26bd65e70b"><td class="memItemLeft" align="right" valign="top"><a id="addbd2a1fc298ed70150e0d26bd65e70b"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_ring_size</b></td></tr>
<tr class="separator:addbd2a1fc298ed70150e0d26bd65e70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2495a2c94b399acb229cef651a72e9a"><td class="memItemLeft" align="right" valign="top"><a id="ac2495a2c94b399acb229cef651a72e9a"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_fee</b></td></tr>
<tr class="separator:ac2495a2c94b399acb229cef651a72e9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b5c588375396dd8a4e58ee5300877f"><td class="memItemLeft" align="right" valign="top"><a id="a25b5c588375396dd8a4e58ee5300877f"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_account_index</b></td></tr>
<tr class="separator:a25b5c588375396dd8a4e58ee5300877f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4f59abd890d1be8e4176507922368be"><td class="memItemLeft" align="right" valign="top"><a id="ad4f59abd890d1be8e4176507922368be"></a>
vector&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_subaddress_indices</b></td></tr>
<tr class="separator:ad4f59abd890d1be8e4176507922368be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e38334951d6feb42294ea7f08f9637b"><td class="memItemLeft" align="right" valign="top"><a id="a3e38334951d6feb42294ea7f08f9637b"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_unlock_time</b></td></tr>
<tr class="separator:a3e38334951d6feb42294ea7f08f9637b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a164a49b826599531c09072784004ccb6"><td class="memItemLeft" align="right" valign="top"><a id="a164a49b826599531c09072784004ccb6"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_can_split</b></td></tr>
<tr class="separator:a164a49b826599531c09072784004ccb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdf76a67be747189fd2681dd49c0a511"><td class="memItemLeft" align="right" valign="top"><a id="afdf76a67be747189fd2681dd49c0a511"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_do_not_relay</b></td></tr>
<tr class="separator:afdf76a67be747189fd2681dd49c0a511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a799759c81ad7afa5081f0e80ff3bbef9"><td class="memItemLeft" align="right" valign="top"><a id="a799759c81ad7afa5081f0e80ff3bbef9"></a>
boost::optional&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_note</b></td></tr>
<tr class="separator:a799759c81ad7afa5081f0e80ff3bbef9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a848c5adb6bdaa3200b15b84d9410af9b"><td class="memItemLeft" align="right" valign="top"><a id="a848c5adb6bdaa3200b15b84d9410af9b"></a>
boost::optional&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_recipient_name</b></td></tr>
<tr class="separator:a848c5adb6bdaa3200b15b84d9410af9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0a8515e28ea1481691924f75f664ca"><td class="memItemLeft" align="right" valign="top"><a id="a2c0a8515e28ea1481691924f75f664ca"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_below_amount</b></td></tr>
<tr class="separator:a2c0a8515e28ea1481691924f75f664ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeb2bbe054b85c2b42194440d0de2b69"><td class="memItemLeft" align="right" valign="top"><a id="abeb2bbe054b85c2b42194440d0de2b69"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_sweep_each_subaddress</b></td></tr>
<tr class="separator:abeb2bbe054b85c2b42194440d0de2b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ba9d9826d26287153933ae68fee600e"><td class="memItemLeft" align="right" valign="top"><a id="a1ba9d9826d26287153933ae68fee600e"></a>
boost::optional&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_key_image</b></td></tr>
<tr class="separator:a1ba9d9826d26287153933ae68fee600e"><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>Configures a request to send/sweep funds or create a payment URI. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad89fb92ab7f2226a33807f2e842c9655"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad89fb92ab7f2226a33807f2e842c9655">&#9670;&nbsp;</a></span>to_rapidjson_val()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rapidjson::Value monero::monero_send_request::to_rapidjson_val </td>
<td>(</td>
<td class="paramtype">rapidjson::Document::AllocatorType &amp;&#160;</td>
<td class="paramname"><em>allocator</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the struct to a rapidjson Value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td>is the rapidjson document allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the struct as a rapidjson Value </dd></dl>
<p>Implements <a class="el" href="structmonero_1_1serializable__struct.html#a3c53ab95b12f02db20cf20cd6d69ad4b">monero::serializable_struct</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>wallet/<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a></li>
<li>wallet/monero_wallet_model.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>