diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_chat.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_chat.html | 309 |
1 files changed, 309 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_chat.html b/docs/class_tg_bot_1_1_chat.html new file mode 100644 index 0000000..d5c155c --- /dev/null +++ b/docs/class_tg_bot_1_1_chat.html @@ -0,0 +1,309 @@ +<!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::Chat 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_chat.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_chat-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Chat Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_chat_8h_source.html">Chat.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:a939946fe3181210f9e3f3d9610edb52e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52e">Type</a> { <a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52ea47f9082fc380ca62d531096aa1d110f1">Type::Private</a>, +<a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52ea03937134cedab9078be39a77ee3a48a0">Type::Group</a>, +<a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52ea9c306d98196730ac00fc621998b4a8f5">Type::Supergroup</a>, +<a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52ea781dc97dc62331eec3ea9ec4373a3ca8">Type::Channel</a> + }</td></tr> +<tr class="separator:a939946fe3181210f9e3f3d9610edb52e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9818e295b599a08b77abefb38de75e48"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a9818e295b599a08b77abefb38de75e48">Ptr</a></td></tr> +<tr class="separator:a9818e295b599a08b77abefb38de75e48"><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:a0cb746cc149d10ada1af86753f25f93c"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a0cb746cc149d10ada1af86753f25f93c">id</a></td></tr> +<tr class="separator:a0cb746cc149d10ada1af86753f25f93c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a86d47a69eb66a74d7f5b294700d884cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52e">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a86d47a69eb66a74d7f5b294700d884cd">type</a></td></tr> +<tr class="separator:a86d47a69eb66a74d7f5b294700d884cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15a1f1328125b45ba80ea8ee5a99aed0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a15a1f1328125b45ba80ea8ee5a99aed0">title</a></td></tr> +<tr class="separator:a15a1f1328125b45ba80ea8ee5a99aed0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afce7dfa93a025025eef940447ed17990"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#afce7dfa93a025025eef940447ed17990">username</a></td></tr> +<tr class="separator:afce7dfa93a025025eef940447ed17990"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a884c0c1c6d6f0a5453231f7b9049da29"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a884c0c1c6d6f0a5453231f7b9049da29">firstName</a></td></tr> +<tr class="separator:a884c0c1c6d6f0a5453231f7b9049da29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aea14be3f3c081d6aea387cd3613fc82e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#aea14be3f3c081d6aea387cd3613fc82e">lastName</a></td></tr> +<tr class="separator:aea14be3f3c081d6aea387cd3613fc82e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a46092ec51dcc2ab4f54716eb21c4fb68"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#a46092ec51dcc2ab4f54716eb21c4fb68">allMembersAreAdministrators</a></td></tr> +<tr class="separator:a46092ec51dcc2ab4f54716eb21c4fb68"><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 <a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00035">35</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a9818e295b599a08b77abefb38de75e48"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9818e295b599a08b77abefb38de75e48">◆ </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_chat.html">Chat</a>> <a class="el" href="class_tg_bot_1_1_chat.html#a9818e295b599a08b77abefb38de75e48">TgBot::Chat::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00038">38</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Enumeration Documentation</h2> +<a id="a939946fe3181210f9e3f3d9610edb52e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a939946fe3181210f9e3f3d9610edb52e">◆ </a></span>Type</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52e">TgBot::Chat::Type</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">strong</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Enum of possible types of a chat. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a939946fe3181210f9e3f3d9610edb52ea47f9082fc380ca62d531096aa1d110f1"></a>Private </td><td class="fielddoc"></td></tr> +<tr><td class="fieldname"><a id="a939946fe3181210f9e3f3d9610edb52ea03937134cedab9078be39a77ee3a48a0"></a>Group </td><td class="fielddoc"></td></tr> +<tr><td class="fieldname"><a id="a939946fe3181210f9e3f3d9610edb52ea9c306d98196730ac00fc621998b4a8f5"></a>Supergroup </td><td class="fielddoc"></td></tr> +<tr><td class="fieldname"><a id="a939946fe3181210f9e3f3d9610edb52ea781dc97dc62331eec3ea9ec4373a3ca8"></a>Channel </td><td class="fielddoc"></td></tr> +</table> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00043">43</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a46092ec51dcc2ab4f54716eb21c4fb68"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a46092ec51dcc2ab4f54716eb21c4fb68">◆ </a></span>allMembersAreAdministrators</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Chat::allMembersAreAdministrators</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. True if a group has �All Members Are Admins� enabled. </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00084">84</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="a884c0c1c6d6f0a5453231f7b9049da29"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a884c0c1c6d6f0a5453231f7b9049da29">◆ </a></span>firstName</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Chat::firstName</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. First name of the other party in private chat </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00072">72</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="a0cb746cc149d10ada1af86753f25f93c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0cb746cc149d10ada1af86753f25f93c">◆ </a></span>id</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int64_t TgBot::Chat::id</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Unique identifier for this chat, not exceeding 1e13 by absolute value </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00050">50</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="aea14be3f3c081d6aea387cd3613fc82e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aea14be3f3c081d6aea387cd3613fc82e">◆ </a></span>lastName</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Chat::lastName</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Last name of the other party in private chat </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00078">78</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="a15a1f1328125b45ba80ea8ee5a99aed0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a15a1f1328125b45ba80ea8ee5a99aed0">◆ </a></span>title</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Chat::title</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Title for channels and group chat </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00060">60</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="a86d47a69eb66a74d7f5b294700d884cd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a86d47a69eb66a74d7f5b294700d884cd">◆ </a></span>type</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52e">Type</a> TgBot::Chat::type</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Type of chat: can be either "private", "group", "supergroup, or "channel". </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00055">55</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> + +</div> +</div> +<a id="afce7dfa93a025025eef940447ed17990"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afce7dfa93a025025eef940447ed17990">◆ </a></span>username</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Chat::username</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Username for private chats and channels </p> + +<p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00066">66</a> of file <a class="el" href="_chat_8h_source.html">Chat.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="_chat_8h_source.html">Chat.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_chat.html">Chat</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:16 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> |