From c8d40dccabaaa406faed6c0797a92bac811c9d0f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Tue, 5 Jun 2018 19:07:27 +0300 Subject: Update docs --- docs/class_tg_bot_1_1_chat.html | 51 +++++++++++++++++++++++++++++++++-------- 1 file changed, 41 insertions(+), 10 deletions(-) (limited to 'docs/class_tg_bot_1_1_chat.html') 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','');});
+

This object represents a Telegram Chat. + More...

+

#include <Chat.h>

Type::Group, Type::Supergroup, Type::Channel - } + } + @@ -104,34 +108,47 @@ Public Types + + + + + + + + + + + + +

@@ -96,7 +99,8 @@ Public Types

 Enum of possible types of a chat. More...
 
typedef std::shared_ptr< ChatPtr
 

Public Attributes

int64_t id
 Unique identifier for this chat, not exceeding 1e13 by absolute value. More...
 
Type type
 Type of chat: can be either "private", "group", "supergroup, or "channel". More...
 
std::string title
 Optional. Title for channels and group chat. More...
 
std::string username
 Optional. Username for private chats and channels. More...
 
std::string firstName
 Optional. First name of the other party in private chat. More...
 
std::string lastName
 Optional. Last name of the other party in private chat. More...
 
bool allMembersAreAdministrators
 Optional. True if a group has ‘All Members Are Admins’ enabled. More...
 
ChatPhoto::Ptr photo
 Optional. Chat photo. Returned only in getChat. More...
 
std::string description
 Optional. Description, for supergroups and channel chats. Returned only in getChat. More...
 
std::string inviteLink
 Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat. More...
 
std::shared_ptr< MessagepinnedMessage
 Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. More...
 
std::string stickerSetName
 Optional. For supergroups, name of group sticker set. Returned only in getChat. More...
 
bool canSetStickerSet
 Optional. True, if the bot can change the group sticker set. Returned only in getChat. More...
 

Detailed Description

-

This object represents a Telegram Chat

+

This object represents a Telegram Chat.

Definition at line 38 of file Chat.h.

Member Typedef Documentation

@@ -171,6 +188,7 @@ Public Attributes
+

Enum of possible types of a chat.

@@ -195,6 +213,7 @@ Public Attributes
Enumerator
Private 
+

Optional. True if a group has ‘All Members Are Admins’ enabled.

Definition at line 87 of file Chat.h.

@@ -212,6 +231,7 @@ Public Attributes
+

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

Definition at line 123 of file Chat.h.

@@ -229,6 +249,7 @@ Public Attributes
+

Optional. Description, for supergroups and channel chats. Returned only in getChat.

Definition at line 99 of file Chat.h.

@@ -246,7 +267,8 @@ Public Attributes
-

Optional. First name of the other party in private chat

+ +

Optional. First name of the other party in private chat.

Definition at line 75 of file Chat.h.

@@ -263,7 +285,8 @@ Public Attributes
-

Unique identifier for this chat, not exceeding 1e13 by absolute value

+ +

Unique identifier for this chat, not exceeding 1e13 by absolute value.

Definition at line 53 of file Chat.h.

@@ -280,7 +303,8 @@ Public Attributes
-

Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.

+ +

Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.

Definition at line 105 of file Chat.h.

@@ -297,7 +321,8 @@ Public Attributes
-

Optional. Last name of the other party in private chat

+ +

Optional. Last name of the other party in private chat.

Definition at line 81 of file Chat.h.

@@ -314,7 +339,8 @@ Public Attributes
-

Optional. Chat photo. Returned only in getChat.

+ +

Optional. Chat photo. Returned only in getChat.

Definition at line 93 of file Chat.h.

@@ -331,6 +357,7 @@ Public Attributes
+

Optional. Pinned message, for supergroups and channel chats. Returned only in getChat.

Definition at line 111 of file Chat.h.

@@ -348,6 +375,7 @@ Public Attributes
+

Optional. For supergroups, name of group sticker set. Returned only in getChat.

Definition at line 117 of file Chat.h.

@@ -365,7 +393,8 @@ Public Attributes
-

Optional. Title for channels and group chat

+ +

Optional. Title for channels and group chat.

Definition at line 63 of file Chat.h.

@@ -382,6 +411,7 @@ Public Attributes
+

Type of chat: can be either "private", "group", "supergroup, or "channel".

Definition at line 58 of file Chat.h.

@@ -399,7 +429,8 @@ Public Attributes
-

Optional. Username for private chats and channels

+ +

Optional. Username for private chats and channels.

Definition at line 69 of file Chat.h.

@@ -414,7 +445,7 @@ Public Attributes