diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_invoice.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_invoice.html | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_invoice.html b/docs/class_tg_bot_1_1_invoice.html new file mode 100644 index 0000000..4bd6fed --- /dev/null +++ b/docs/class_tg_bot_1_1_invoice.html @@ -0,0 +1,249 @@ +<!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::Invoice 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_invoice.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_invoice-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Invoice 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 an invoice. + <a href="class_tg_bot_1_1_invoice.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_invoice_8h_source.html">Invoice.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:a34a6d437618ea3be0a40c64400067f67"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_invoice.html">Invoice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#a34a6d437618ea3be0a40c64400067f67">Ptr</a></td></tr> +<tr class="separator:a34a6d437618ea3be0a40c64400067f67"><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:a5b53e4a6a2e3669a960d379a4147abae"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#a5b53e4a6a2e3669a960d379a4147abae">title</a></td></tr> +<tr class="memdesc:a5b53e4a6a2e3669a960d379a4147abae"><td class="mdescLeft"> </td><td class="mdescRight">Product name. <a href="#a5b53e4a6a2e3669a960d379a4147abae">More...</a><br /></td></tr> +<tr class="separator:a5b53e4a6a2e3669a960d379a4147abae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad3c1a7a4fbf8157e3fd72a2352226fbd"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#ad3c1a7a4fbf8157e3fd72a2352226fbd">description</a></td></tr> +<tr class="memdesc:ad3c1a7a4fbf8157e3fd72a2352226fbd"><td class="mdescLeft"> </td><td class="mdescRight">Product description. <a href="#ad3c1a7a4fbf8157e3fd72a2352226fbd">More...</a><br /></td></tr> +<tr class="separator:ad3c1a7a4fbf8157e3fd72a2352226fbd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a659ac0711c1be89009dddc04eea4dfb2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#a659ac0711c1be89009dddc04eea4dfb2">startParameter</a></td></tr> +<tr class="memdesc:a659ac0711c1be89009dddc04eea4dfb2"><td class="mdescLeft"> </td><td class="mdescRight">Unique bot deep-linking parameter that can be used to generate this invoice. <a href="#a659ac0711c1be89009dddc04eea4dfb2">More...</a><br /></td></tr> +<tr class="separator:a659ac0711c1be89009dddc04eea4dfb2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9207fea93e6b3f3aa1081c8ab9039f8a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#a9207fea93e6b3f3aa1081c8ab9039f8a">currency</a></td></tr> +<tr class="memdesc:a9207fea93e6b3f3aa1081c8ab9039f8a"><td class="mdescLeft"> </td><td class="mdescRight">Three-letter ISO 4217 currency code. <a href="#a9207fea93e6b3f3aa1081c8ab9039f8a">More...</a><br /></td></tr> +<tr class="separator:a9207fea93e6b3f3aa1081c8ab9039f8a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8008d2f948d705aa48bc0557d071e62f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_invoice.html#a8008d2f948d705aa48bc0557d071e62f">totalAmount</a></td></tr> +<tr class="memdesc:a8008d2f948d705aa48bc0557d071e62f"><td class="mdescLeft"> </td><td class="mdescRight">Total price in the smallest units of the currency (integer, not float/double). <a href="#a8008d2f948d705aa48bc0557d071e62f">More...</a><br /></td></tr> +<tr class="separator:a8008d2f948d705aa48bc0557d071e62f"><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 an invoice. </p> +<p><a href="https://core.telegram.org/bots/api#invoice">https://core.telegram.org/bots/api#invoice</a> </p> + +<p class="definition">Definition at line <a class="el" href="_invoice_8h_source.html#l00039">39</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a34a6d437618ea3be0a40c64400067f67"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a34a6d437618ea3be0a40c64400067f67">◆ </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_invoice.html">Invoice</a>> <a class="el" href="class_tg_bot_1_1_invoice.html#a34a6d437618ea3be0a40c64400067f67">TgBot::Invoice::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_invoice_8h_source.html#l00041">41</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a9207fea93e6b3f3aa1081c8ab9039f8a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9207fea93e6b3f3aa1081c8ab9039f8a">◆ </a></span>currency</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Invoice::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="_invoice_8h_source.html#l00061">61</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> + +</div> +</div> +<a id="ad3c1a7a4fbf8157e3fd72a2352226fbd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad3c1a7a4fbf8157e3fd72a2352226fbd">◆ </a></span>description</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Invoice::description</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Product description. </p> + +<p class="definition">Definition at line <a class="el" href="_invoice_8h_source.html#l00051">51</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> + +</div> +</div> +<a id="a659ac0711c1be89009dddc04eea4dfb2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a659ac0711c1be89009dddc04eea4dfb2">◆ </a></span>startParameter</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Invoice::startParameter</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Unique bot deep-linking parameter that can be used to generate this invoice. </p> + +<p class="definition">Definition at line <a class="el" href="_invoice_8h_source.html#l00056">56</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> + +</div> +</div> +<a id="a5b53e4a6a2e3669a960d379a4147abae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5b53e4a6a2e3669a960d379a4147abae">◆ </a></span>title</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Invoice::title</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Product name. </p> + +<p class="definition">Definition at line <a class="el" href="_invoice_8h_source.html#l00046">46</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.h</a>.</p> + +</div> +</div> +<a id="a8008d2f948d705aa48bc0557d071e62f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8008d2f948d705aa48bc0557d071e62f">◆ </a></span>totalAmount</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Invoice::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="_invoice_8h_source.html#l00074">74</a> of file <a class="el" href="_invoice_8h_source.html">Invoice.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="_invoice_8h_source.html">Invoice.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_invoice.html">Invoice</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> |