summaryrefslogtreecommitdiff
path: root/docs/_successful_payment_8h_source.html
blob: 14f5b73eee626d4e15ac66d532f26ef834e94f15 (plain)
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
<!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>tgbot-cpp: include/tgbot/types/SuccessfulPayment.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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">tgbot-cpp
   </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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_successful_payment_8h_source.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="headertitle">
<div class="title">SuccessfulPayment.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_successful_payment_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2015 Oleg Morozenkov</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (c) 2017 Maks Mazurov (fox.cpp)</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef TGBOT_SUCCESSFULPAYMENT_H</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#define TGBOT_SUCCESSFULPAYMENT_H</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_order_info_8h.html">tgbot/types/OrderInfo.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_tg_bot.html">TgBot</a> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html">   41</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_tg_bot_1_1_successful_payment.html">SuccessfulPayment</a> {</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a753e2643432af6f0b2561436f2b1da0d">   43</a></span>&#160;    <span class="keyword">typedef</span> std::shared_ptr&lt;SuccessfulPayment&gt; <a class="code" href="class_tg_bot_1_1_successful_payment.html#a753e2643432af6f0b2561436f2b1da0d">Ptr</a>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a7cabedcd7e557d607baf968c2fc454f3">   48</a></span>&#160;    std::string <a class="code" href="class_tg_bot_1_1_successful_payment.html#a7cabedcd7e557d607baf968c2fc454f3">currency</a>;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a5e2d3de9df8e9ee28b9e9c5e037cadc7">   61</a></span>&#160;    int32_t <a class="code" href="class_tg_bot_1_1_successful_payment.html#a5e2d3de9df8e9ee28b9e9c5e037cadc7">totalAmount</a>;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a260f6306836c863523054f076c9350c6">   66</a></span>&#160;    std::string <a class="code" href="class_tg_bot_1_1_successful_payment.html#a260f6306836c863523054f076c9350c6">invoicePayload</a>;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a29413281af3ef0ff5c60d3e4dac2435e">   71</a></span>&#160;    std::string <a class="code" href="class_tg_bot_1_1_successful_payment.html#a29413281af3ef0ff5c60d3e4dac2435e">shippingOptionId</a>;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a7fd2215c7e0a0975477d8e5fff0ae829">   76</a></span>&#160;    <a class="code" href="class_tg_bot_1_1_order_info.html#a546d93329dceb7bbd542a82d34e3b76a">OrderInfo::Ptr</a> <a class="code" href="class_tg_bot_1_1_successful_payment.html#a7fd2215c7e0a0975477d8e5fff0ae829">orderInfo</a>;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a42ec4a5d0de537eaf1e9d43866ac3c04">   81</a></span>&#160;    std::string <a class="code" href="class_tg_bot_1_1_successful_payment.html#a42ec4a5d0de537eaf1e9d43866ac3c04">telegramPaymentChargeId</a>;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_successful_payment.html#a06d9cb4285772b1e0aa91df415af4cf6">   86</a></span>&#160;    std::string <a class="code" href="class_tg_bot_1_1_successful_payment.html#a06d9cb4285772b1e0aa91df415af4cf6">providerPaymentChargeId</a>;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;};</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;}</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#endif //TGBOT_SUCCESSFULPAYMENT_H</span></div><div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a7fd2215c7e0a0975477d8e5fff0ae829"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a7fd2215c7e0a0975477d8e5fff0ae829">TgBot::SuccessfulPayment::orderInfo</a></div><div class="ttdeci">OrderInfo::Ptr orderInfo</div><div class="ttdoc">Optional. Order info provided by the user. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00076">SuccessfulPayment.h:76</a></div></div>
<div class="ttc" id="namespace_tg_bot_html"><div class="ttname"><a href="namespace_tg_bot.html">TgBot</a></div><div class="ttdef"><b>Definition:</b> <a href="_api_8h_source.html#l00046">Api.h:46</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a5e2d3de9df8e9ee28b9e9c5e037cadc7"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a5e2d3de9df8e9ee28b9e9c5e037cadc7">TgBot::SuccessfulPayment::totalAmount</a></div><div class="ttdeci">int32_t totalAmount</div><div class="ttdoc">Total price in the smallest units of the currency (integer, not float/double). </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00061">SuccessfulPayment.h:61</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a260f6306836c863523054f076c9350c6"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a260f6306836c863523054f076c9350c6">TgBot::SuccessfulPayment::invoicePayload</a></div><div class="ttdeci">std::string invoicePayload</div><div class="ttdoc">Bot specified invoice payload. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00066">SuccessfulPayment.h:66</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a7cabedcd7e557d607baf968c2fc454f3"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a7cabedcd7e557d607baf968c2fc454f3">TgBot::SuccessfulPayment::currency</a></div><div class="ttdeci">std::string currency</div><div class="ttdoc">Three-letter ISO 4217 currency code. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00048">SuccessfulPayment.h:48</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a06d9cb4285772b1e0aa91df415af4cf6"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a06d9cb4285772b1e0aa91df415af4cf6">TgBot::SuccessfulPayment::providerPaymentChargeId</a></div><div class="ttdeci">std::string providerPaymentChargeId</div><div class="ttdoc">Provider payment identifier. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00086">SuccessfulPayment.h:86</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html">TgBot::SuccessfulPayment</a></div><div class="ttdoc">This object contains basic information about a successful payment. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00041">SuccessfulPayment.h:41</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a753e2643432af6f0b2561436f2b1da0d"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a753e2643432af6f0b2561436f2b1da0d">TgBot::SuccessfulPayment::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; SuccessfulPayment &gt; Ptr</div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00043">SuccessfulPayment.h:43</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a42ec4a5d0de537eaf1e9d43866ac3c04"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a42ec4a5d0de537eaf1e9d43866ac3c04">TgBot::SuccessfulPayment::telegramPaymentChargeId</a></div><div class="ttdeci">std::string telegramPaymentChargeId</div><div class="ttdoc">Telegram payment identifier. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00081">SuccessfulPayment.h:81</a></div></div>
<div class="ttc" id="_order_info_8h_html"><div class="ttname"><a href="_order_info_8h.html">OrderInfo.h</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_order_info_html_a546d93329dceb7bbd542a82d34e3b76a"><div class="ttname"><a href="class_tg_bot_1_1_order_info.html#a546d93329dceb7bbd542a82d34e3b76a">TgBot::OrderInfo::Ptr</a></div><div class="ttdeci">std::shared_ptr&lt; OrderInfo &gt; Ptr</div><div class="ttdef"><b>Definition:</b> <a href="_order_info_8h_source.html#l00042">OrderInfo.h:42</a></div></div>
<div class="ttc" id="class_tg_bot_1_1_successful_payment_html_a29413281af3ef0ff5c60d3e4dac2435e"><div class="ttname"><a href="class_tg_bot_1_1_successful_payment.html#a29413281af3ef0ff5c60d3e4dac2435e">TgBot::SuccessfulPayment::shippingOptionId</a></div><div class="ttdeci">std::string shippingOptionId</div><div class="ttdoc">Optional. Identifier of the shipping option chosen by the user. </div><div class="ttdef"><b>Definition:</b> <a href="_successful_payment_8h_source.html#l00071">SuccessfulPayment.h:71</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_25b26b9fa3b0bd1537052b03f43dd617.html">tgbot</a></li><li class="navelem"><a class="el" href="dir_edd914e3fbf8e89da3c33d1968dd487e.html">types</a></li><li class="navelem"><a class="el" href="_successful_payment_8h.html">SuccessfulPayment.h</a></li>
    <li class="footer">Generated on Sun May 27 2018 22:44:47 for tgbot-cpp by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>