From 985837f2152383c304d043bd4dc8af23914b112f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 2 Jan 2017 23:05:43 +0300 Subject: Docs --- docs/class_tg_bot_1_1_chat.html | 309 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 309 insertions(+) create mode 100644 docs/class_tg_bot_1_1_chat.html (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 new file mode 100644 index 0000000..64381c7 --- /dev/null +++ b/docs/class_tg_bot_1_1_chat.html @@ -0,0 +1,309 @@ + + + + + + + +tgbot-cpp: TgBot::Chat Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
TgBot::Chat Class Reference
Types
+
+
+ +

#include <Chat.h>

+ + + + + + +

+Public Types

enum  Type { Type::Private, +Type::Group, +Type::Supergroup, +Type::Channel + }
 
typedef std::shared_ptr< Chat > Ptr
 
+ + + + + + + + + + + + + + + +

+Public Attributes

int64_t id
 
Type type
 
std::string title
 
std::string username
 
std::string firstName
 
std::string lastName
 
bool allMembersAreAdministrators
 
+

Detailed Description

+

This object represents a Telegram Chat

+ +

Definition at line 35 of file Chat.h.

+

Member Typedef Documentation

+ +

◆ Ptr

+ +
+
+ + + + +
typedef std::shared_ptr<Chat> TgBot::Chat::Ptr
+
+ +

Definition at line 38 of file Chat.h.

+ +
+
+

Member Enumeration Documentation

+ +

◆ Type

+ +
+
+ + + + + +
+ + + + +
enum TgBot::Chat::Type
+ 		+strong
+
+

Enum of possible types of a chat.

+ + + + + +
Enumerator
Private 
Group 
Supergroup 
Channel 
+ +

Definition at line 43 of file Chat.h.

+ +
+
+

Member Data Documentation

+ +

◆ allMembersAreAdministrators

+ +
+
+ + + + +
bool TgBot::Chat::allMembersAreAdministrators
+
+

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

+ +

Definition at line 84 of file Chat.h.

+ +
+
+ +

◆ firstName

+ +
+
+ + + + +
std::string TgBot::Chat::firstName
+
+

Optional. First name of the other party in private chat

+ +

Definition at line 72 of file Chat.h.

+ +
+
+ +

◆ id

+ +
+
+ + + + +
int64_t TgBot::Chat::id
+
+

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

+ +

Definition at line 50 of file Chat.h.

+ +
+
+ +

◆ lastName

+ +
+
+ + + + +
std::string TgBot::Chat::lastName
+
+

Optional. Last name of the other party in private chat

+ +

Definition at line 78 of file Chat.h.

+ +
+
+ +

◆ title

+ +
+
+ + + + +
std::string TgBot::Chat::title
+
+

Optional. Title for channels and group chat

+ +

Definition at line 60 of file Chat.h.

+ +
+
+ +

◆ type

+ +
+
+ + + + +
Type TgBot::Chat::type
+
+

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

+ +

Definition at line 55 of file Chat.h.

+ +
+
+ +

◆ username

+ +
+
+ + + + +
std::string TgBot::Chat::username
+
+

Optional. Username for private chats and channels

+ +

Definition at line 66 of file Chat.h.

+ +
+
+
The documentation for this class was generated from the following file:
    +
  • include/tgbot/types/Chat.h
    • +
+
+
+ + + + -- cgit v1.2.3