diff options
author | Oleg Morozenkov <m@oleg.rocks> | 2018-06-05 19:07:27 +0300 |
---|---|---|
committer | Oleg Morozenkov <m@oleg.rocks> | 2018-06-05 19:07:27 +0300 |
commit | c8d40dccabaaa406faed6c0797a92bac811c9d0f (patch) | |
tree | bacf9287fbac322e8ecf9c8ae2c505ce6ba8b8b6 /docs/class_tg_bot_1_1_chat.html | |
parent | 1a90b5022d47bc0059214381b74db6fae9767cef (diff) |
Update docs
Diffstat (limited to 'docs/class_tg_bot_1_1_chat.html')
-rw-r--r-- | docs/class_tg_bot_1_1_chat.html | 51 |
1 files changed, 41 insertions, 10 deletions
diff --git a/docs/class_tg_bot_1_1_chat.html b/docs/class_tg_bot_1_1_chat.html index 20dfa65..d68e3ce 100644 --- a/docs/class_tg_bot_1_1_chat.html +++ b/docs/class_tg_bot_1_1_chat.html @@ -88,6 +88,9 @@ $(document).ready(function(){initNavTree('class_tg_bot_1_1_chat.html','');}); </div><!--header--> <div class="contents"> +<p>This object represents a Telegram <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a>. + <a href="class_tg_bot_1_1_chat.html#details">More...</a></p> + <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> @@ -96,7 +99,8 @@ Public Types</h2></td></tr> <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="memdesc:a939946fe3181210f9e3f3d9610edb52e"><td class="mdescLeft"> </td><td class="mdescRight">Enum of possible types of a chat. <a href="class_tg_bot_1_1_chat.html#a939946fe3181210f9e3f3d9610edb52e">More...</a><br /></td></tr> +</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> @@ -104,34 +108,47 @@ Public Types</h2></td></tr> <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="memdesc:a0cb746cc149d10ada1af86753f25f93c"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier for this chat, not exceeding 1e13 by absolute value. <a href="#a0cb746cc149d10ada1af86753f25f93c">More...</a><br /></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="memdesc:a86d47a69eb66a74d7f5b294700d884cd"><td class="mdescLeft"> </td><td class="mdescRight">Type of chat: can be either "private", "group", "supergroup, or "channel". <a href="#a86d47a69eb66a74d7f5b294700d884cd">More...</a><br /></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="memdesc:a15a1f1328125b45ba80ea8ee5a99aed0"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Title for channels and group chat. <a href="#a15a1f1328125b45ba80ea8ee5a99aed0">More...</a><br /></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="memdesc:afce7dfa93a025025eef940447ed17990"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Username for private chats and channels. <a href="#afce7dfa93a025025eef940447ed17990">More...</a><br /></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="memdesc:a884c0c1c6d6f0a5453231f7b9049da29"><td class="mdescLeft"> </td><td class="mdescRight">Optional. First name of the other party in private chat. <a href="#a884c0c1c6d6f0a5453231f7b9049da29">More...</a><br /></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="memdesc:aea14be3f3c081d6aea387cd3613fc82e"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Last name of the other party in private chat. <a href="#aea14be3f3c081d6aea387cd3613fc82e">More...</a><br /></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="memdesc:a46092ec51dcc2ab4f54716eb21c4fb68"><td class="mdescLeft"> </td><td class="mdescRight">Optional. True if a group has ‘All Members Are Admins’ enabled. <a href="#a46092ec51dcc2ab4f54716eb21c4fb68">More...</a><br /></td></tr> <tr class="separator:a46092ec51dcc2ab4f54716eb21c4fb68"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acbc96ba84a02da42e5fa3c936458b735"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_chat_photo.html#a732024e5287eef199f40dfef151d5265">ChatPhoto::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#acbc96ba84a02da42e5fa3c936458b735">photo</a></td></tr> +<tr class="memdesc:acbc96ba84a02da42e5fa3c936458b735"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a> photo. Returned only in getChat. <a href="#acbc96ba84a02da42e5fa3c936458b735">More...</a><br /></td></tr> <tr class="separator:acbc96ba84a02da42e5fa3c936458b735"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8f87f388215d07bb2745cdf2600ff299"><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#a8f87f388215d07bb2745cdf2600ff299">description</a></td></tr> +<tr class="memdesc:a8f87f388215d07bb2745cdf2600ff299"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Description, for supergroups and channel chats. Returned only in getChat. <a href="#a8f87f388215d07bb2745cdf2600ff299">More...</a><br /></td></tr> <tr class="separator:a8f87f388215d07bb2745cdf2600ff299"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5653ec719aa43764670c2c88055107e2"><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#a5653ec719aa43764670c2c88055107e2">inviteLink</a></td></tr> +<tr class="memdesc:a5653ec719aa43764670c2c88055107e2"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a> invite link, for supergroups and channel chats. Returned only in getChat. <a href="#a5653ec719aa43764670c2c88055107e2">More...</a><br /></td></tr> <tr class="separator:a5653ec719aa43764670c2c88055107e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6904afd95332cd46ce65d3c82139875"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="class_tg_bot_1_1_message.html">Message</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_chat.html#af6904afd95332cd46ce65d3c82139875">pinnedMessage</a></td></tr> +<tr class="memdesc:af6904afd95332cd46ce65d3c82139875"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. <a href="#af6904afd95332cd46ce65d3c82139875">More...</a><br /></td></tr> <tr class="separator:af6904afd95332cd46ce65d3c82139875"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a056b7b53d5d81e5ab395dd555fa35c14"><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#a056b7b53d5d81e5ab395dd555fa35c14">stickerSetName</a></td></tr> +<tr class="memdesc:a056b7b53d5d81e5ab395dd555fa35c14"><td class="mdescLeft"> </td><td class="mdescRight">Optional. For supergroups, name of group sticker set. Returned only in getChat. <a href="#a056b7b53d5d81e5ab395dd555fa35c14">More...</a><br /></td></tr> <tr class="separator:a056b7b53d5d81e5ab395dd555fa35c14"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a634c679550d78b602254cf3044f6169a"><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#a634c679550d78b602254cf3044f6169a">canSetStickerSet</a></td></tr> +<tr class="memdesc:a634c679550d78b602254cf3044f6169a"><td class="mdescLeft"> </td><td class="mdescRight">Optional. True, if the bot can change the group sticker set. Returned only in getChat. <a href="#a634c679550d78b602254cf3044f6169a">More...</a><br /></td></tr> <tr class="separator:a634c679550d78b602254cf3044f6169a"><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> +<div class="textblock"><p>This object represents a Telegram <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a>. </p> <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><h2 class="groupheader">Member Typedef Documentation</h2> @@ -171,6 +188,7 @@ Public Attributes</h2></td></tr> </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> @@ -195,6 +213,7 @@ Public Attributes</h2></td></tr> </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#l00087">87</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -212,6 +231,7 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> + <p>Optional. True, if the bot can change the group sticker set. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00123">123</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -229,6 +249,7 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> + <p>Optional. Description, for supergroups and channel chats. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00099">99</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -246,7 +267,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. First name of the other party in private chat </p> + +<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#l00075">75</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -263,7 +285,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Unique identifier for this chat, not exceeding 1e13 by absolute value </p> + +<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#l00053">53</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -280,7 +303,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. <a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> invite link, for supergroups and channel chats. Returned only in getChat. </p> + +<p>Optional. <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a> invite link, for supergroups and channel chats. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00105">105</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -297,7 +321,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. Last name of the other party in private chat </p> + +<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#l00081">81</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -314,7 +339,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. <a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> photo. Returned only in getChat. </p> + +<p>Optional. <a class="el" href="class_tg_bot_1_1_chat.html" title="This object represents a Telegram Chat. ">Chat</a> photo. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00093">93</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -331,6 +357,7 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> + <p>Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00111">111</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -348,6 +375,7 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> + <p>Optional. For supergroups, name of group sticker set. Returned only in getChat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00117">117</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -365,7 +393,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. Title for channels and group chat </p> + +<p>Optional. Title for channels and group chat. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00063">63</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -382,6 +411,7 @@ Public Attributes</h2></td></tr> </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#l00058">58</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -399,7 +429,8 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. Username for private chats and channels </p> + +<p>Optional. Username for private chats and channels. </p> <p class="definition">Definition at line <a class="el" href="_chat_8h_source.html#l00069">69</a> of file <a class="el" href="_chat_8h_source.html">Chat.h</a>.</p> @@ -414,7 +445,7 @@ Public Attributes</h2></td></tr> <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 Mon May 28 2018 13:57:33 for tgbot-cpp by + <li class="footer">Generated on Tue Jun 5 2018 19:07:15 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> |