diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_successful_payment.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_successful_payment.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_successful_payment.html b/docs/class_tg_bot_1_1_successful_payment.html new file mode 100644 index 0000000..412ce3d --- /dev/null +++ b/docs/class_tg_bot_1_1_successful_payment.html @@ -0,0 +1,291 @@ +<!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: TgBot::SuccessfulPayment 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="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('class_tg_bot_1_1_successful_payment.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="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_successful_payment-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::SuccessfulPayment Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>This object contains basic information about a successful payment. + <a href="class_tg_bot_1_1_successful_payment.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a753e2643432af6f0b2561436f2b1da0d"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_successful_payment.html">SuccessfulPayment</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a753e2643432af6f0b2561436f2b1da0d">Ptr</a></td></tr> +<tr class="separator:a753e2643432af6f0b2561436f2b1da0d"><td class="memSeparator" colspan="2"> </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:a7cabedcd7e557d607baf968c2fc454f3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a7cabedcd7e557d607baf968c2fc454f3">currency</a></td></tr> +<tr class="memdesc:a7cabedcd7e557d607baf968c2fc454f3"><td class="mdescLeft"> </td><td class="mdescRight">Three-letter ISO 4217 currency code. <a href="#a7cabedcd7e557d607baf968c2fc454f3">More...</a><br /></td></tr> +<tr class="separator:a7cabedcd7e557d607baf968c2fc454f3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5e2d3de9df8e9ee28b9e9c5e037cadc7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a5e2d3de9df8e9ee28b9e9c5e037cadc7">totalAmount</a></td></tr> +<tr class="memdesc:a5e2d3de9df8e9ee28b9e9c5e037cadc7"><td class="mdescLeft"> </td><td class="mdescRight">Total price in the smallest units of the currency (integer, not float/double). <a href="#a5e2d3de9df8e9ee28b9e9c5e037cadc7">More...</a><br /></td></tr> +<tr class="separator:a5e2d3de9df8e9ee28b9e9c5e037cadc7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a260f6306836c863523054f076c9350c6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a260f6306836c863523054f076c9350c6">invoicePayload</a></td></tr> +<tr class="memdesc:a260f6306836c863523054f076c9350c6"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_tg_bot_1_1_bot.html">Bot</a> specified invoice payload. <a href="#a260f6306836c863523054f076c9350c6">More...</a><br /></td></tr> +<tr class="separator:a260f6306836c863523054f076c9350c6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a29413281af3ef0ff5c60d3e4dac2435e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a29413281af3ef0ff5c60d3e4dac2435e">shippingOptionId</a></td></tr> +<tr class="memdesc:a29413281af3ef0ff5c60d3e4dac2435e"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Identifier of the shipping option chosen by the user. <a href="#a29413281af3ef0ff5c60d3e4dac2435e">More...</a><br /></td></tr> +<tr class="separator:a29413281af3ef0ff5c60d3e4dac2435e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7fd2215c7e0a0975477d8e5fff0ae829"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_order_info.html#a546d93329dceb7bbd542a82d34e3b76a">OrderInfo::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a7fd2215c7e0a0975477d8e5fff0ae829">orderInfo</a></td></tr> +<tr class="memdesc:a7fd2215c7e0a0975477d8e5fff0ae829"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Order info provided by the user. <a href="#a7fd2215c7e0a0975477d8e5fff0ae829">More...</a><br /></td></tr> +<tr class="separator:a7fd2215c7e0a0975477d8e5fff0ae829"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a42ec4a5d0de537eaf1e9d43866ac3c04"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a42ec4a5d0de537eaf1e9d43866ac3c04">telegramPaymentChargeId</a></td></tr> +<tr class="memdesc:a42ec4a5d0de537eaf1e9d43866ac3c04"><td class="mdescLeft"> </td><td class="mdescRight">Telegram payment identifier. <a href="#a42ec4a5d0de537eaf1e9d43866ac3c04">More...</a><br /></td></tr> +<tr class="separator:a42ec4a5d0de537eaf1e9d43866ac3c04"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a06d9cb4285772b1e0aa91df415af4cf6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_successful_payment.html#a06d9cb4285772b1e0aa91df415af4cf6">providerPaymentChargeId</a></td></tr> +<tr class="memdesc:a06d9cb4285772b1e0aa91df415af4cf6"><td class="mdescLeft"> </td><td class="mdescRight">Provider payment identifier. <a href="#a06d9cb4285772b1e0aa91df415af4cf6">More...</a><br /></td></tr> +<tr class="separator:a06d9cb4285772b1e0aa91df415af4cf6"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object contains basic information about a successful payment. </p> +<p><a href="https://core.telegram.org/bots/api#successfulpayment">https://core.telegram.org/bots/api#successfulpayment</a> </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00041">41</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a753e2643432af6f0b2561436f2b1da0d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a753e2643432af6f0b2561436f2b1da0d">◆ </a></span>Ptr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_successful_payment.html">SuccessfulPayment</a>> <a class="el" href="class_tg_bot_1_1_successful_payment.html#a753e2643432af6f0b2561436f2b1da0d">TgBot::SuccessfulPayment::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00043">43</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a7cabedcd7e557d607baf968c2fc454f3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7cabedcd7e557d607baf968c2fc454f3">◆ </a></span>currency</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::SuccessfulPayment::currency</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Three-letter ISO 4217 currency code. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00048">48</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a260f6306836c863523054f076c9350c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a260f6306836c863523054f076c9350c6">◆ </a></span>invoicePayload</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::SuccessfulPayment::invoicePayload</td> + </tr> + </table> +</div><div class="memdoc"> + +<p><a class="el" href="class_tg_bot_1_1_bot.html">Bot</a> specified invoice payload. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00066">66</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a7fd2215c7e0a0975477d8e5fff0ae829"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7fd2215c7e0a0975477d8e5fff0ae829">◆ </a></span>orderInfo</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_order_info.html#a546d93329dceb7bbd542a82d34e3b76a">OrderInfo::Ptr</a> TgBot::SuccessfulPayment::orderInfo</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Order info provided by the user. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00076">76</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a06d9cb4285772b1e0aa91df415af4cf6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a06d9cb4285772b1e0aa91df415af4cf6">◆ </a></span>providerPaymentChargeId</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::SuccessfulPayment::providerPaymentChargeId</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Provider payment identifier. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00086">86</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a29413281af3ef0ff5c60d3e4dac2435e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a29413281af3ef0ff5c60d3e4dac2435e">◆ </a></span>shippingOptionId</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::SuccessfulPayment::shippingOptionId</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Identifier of the shipping option chosen by the user. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00071">71</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a42ec4a5d0de537eaf1e9d43866ac3c04"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a42ec4a5d0de537eaf1e9d43866ac3c04">◆ </a></span>telegramPaymentChargeId</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::SuccessfulPayment::telegramPaymentChargeId</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Telegram payment identifier. </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00081">81</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<a id="a5e2d3de9df8e9ee28b9e9c5e037cadc7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5e2d3de9df8e9ee28b9e9c5e037cadc7">◆ </a></span>totalAmount</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::SuccessfulPayment::totalAmount</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Total price in the smallest units of the currency (integer, not float/double). </p> +<p>For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</p> +<p><a href="https://core.telegram.org/bots/payments/currencies.json">https://core.telegram.org/bots/payments/currencies.json</a> </p> + +<p class="definition">Definition at line <a class="el" href="_successful_payment_8h_source.html#l00061">61</a> of file <a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/types/<a class="el" href="_successful_payment_8h_source.html">SuccessfulPayment.h</a></li> +</ul> +</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="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_successful_payment.html">SuccessfulPayment</a></li> + <li class="footer">Generated on Sun May 27 2018 22:44:48 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> |