diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_user.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_user.html | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_user.html b/docs/class_tg_bot_1_1_user.html new file mode 100644 index 0000000..35baf20 --- /dev/null +++ b/docs/class_tg_bot_1_1_user.html @@ -0,0 +1,280 @@ +<!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.11"/> +<title>tgbot-cpp: TgBot::User 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); + $(window).load(resizeHeight); +</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> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</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.11 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </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_user.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_user-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::User 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 represents a Telegram user or bot. + <a href="class_tg_bot_1_1_user.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_user_8h_source.html">User.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:ae6ea24aef677abaaf0fd7d60adf5be79"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_user.html">User</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">Ptr</a></td></tr> +<tr class="separator:ae6ea24aef677abaaf0fd7d60adf5be79"><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:a52ed387bdcad23b2883ef86a4c1f600f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#a52ed387bdcad23b2883ef86a4c1f600f">id</a></td></tr> +<tr class="memdesc:a52ed387bdcad23b2883ef86a4c1f600f"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier for this user or bot. <a href="#a52ed387bdcad23b2883ef86a4c1f600f">More...</a><br /></td></tr> +<tr class="separator:a52ed387bdcad23b2883ef86a4c1f600f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9adb4af3ddf68a3a518c32a13f9415bf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#a9adb4af3ddf68a3a518c32a13f9415bf">isBot</a> = false</td></tr> +<tr class="memdesc:a9adb4af3ddf68a3a518c32a13f9415bf"><td class="mdescLeft"> </td><td class="mdescRight">True, if this user is a bot. <a href="#a9adb4af3ddf68a3a518c32a13f9415bf">More...</a><br /></td></tr> +<tr class="separator:a9adb4af3ddf68a3a518c32a13f9415bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7f7a9c98a98fdd7199d2c22c63dd75b0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#a7f7a9c98a98fdd7199d2c22c63dd75b0">firstName</a></td></tr> +<tr class="memdesc:a7f7a9c98a98fdd7199d2c22c63dd75b0"><td class="mdescLeft"> </td><td class="mdescRight">User‘s or bot’s first name. <a href="#a7f7a9c98a98fdd7199d2c22c63dd75b0">More...</a><br /></td></tr> +<tr class="separator:a7f7a9c98a98fdd7199d2c22c63dd75b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52e3efc4237df7992eb8a698fafad9b0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#a52e3efc4237df7992eb8a698fafad9b0">lastName</a></td></tr> +<tr class="memdesc:a52e3efc4237df7992eb8a698fafad9b0"><td class="mdescLeft"> </td><td class="mdescRight">Optional. User‘s or bot’s last name. <a href="#a52e3efc4237df7992eb8a698fafad9b0">More...</a><br /></td></tr> +<tr class="separator:a52e3efc4237df7992eb8a698fafad9b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3b32a26af904966eb8f961309f49eeba"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#a3b32a26af904966eb8f961309f49eeba">username</a></td></tr> +<tr class="memdesc:a3b32a26af904966eb8f961309f49eeba"><td class="mdescLeft"> </td><td class="mdescRight">Optional. User‘s or bot’s username. <a href="#a3b32a26af904966eb8f961309f49eeba">More...</a><br /></td></tr> +<tr class="separator:a3b32a26af904966eb8f961309f49eeba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af5318547408383fd9c491522ca2cfbc9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_user.html#af5318547408383fd9c491522ca2cfbc9">languageCode</a></td></tr> +<tr class="memdesc:af5318547408383fd9c491522ca2cfbc9"><td class="mdescLeft"> </td><td class="mdescRight">Optional. IETF language tag of the user's language. <a href="#af5318547408383fd9c491522ca2cfbc9">More...</a><br /></td></tr> +<tr class="separator:af5318547408383fd9c491522ca2cfbc9"><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 represents a Telegram user or bot. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00036">36</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a class="anchor" id="ae6ea24aef677abaaf0fd7d60adf5be79"></a> +<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_user.html">User</a>> <a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">TgBot::User::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00039">39</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a7f7a9c98a98fdd7199d2c22c63dd75b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::User::firstName</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>User‘s or bot’s first name. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00054">54</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a52ed387bdcad23b2883ef86a4c1f600f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::User::id</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Unique identifier for this user or bot. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00044">44</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9adb4af3ddf68a3a518c32a13f9415bf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::User::isBot = false</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>True, if this user is a bot. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00049">49</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af5318547408383fd9c491522ca2cfbc9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::User::languageCode</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. IETF language tag of the user's language. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00069">69</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a52e3efc4237df7992eb8a698fafad9b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::User::lastName</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. User‘s or bot’s last name. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00059">59</a> of file <a class="el" href="_user_8h_source.html">User.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a3b32a26af904966eb8f961309f49eeba"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::User::username</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. User‘s or bot’s username. </p> + +<p>Definition at line <a class="el" href="_user_8h_source.html#l00064">64</a> of file <a class="el" href="_user_8h_source.html">User.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="_user_8h_source.html">User.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_user.html">User</a></li> + <li class="footer">Generated on Fri Jun 22 2018 22:14:17 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> + </ul> +</div> +</body> +</html> |