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
 
ChatPhoto::Ptr photo
 
std::string description
 
std::string inviteLink
 
std::shared_ptr< Message > pinnedMessage
 
std::string stickerSetName
 
bool canSetStickerSet
 

Detailed Description

This object represents a Telegram Chat

Definition at line 38 of file Chat.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 41 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 46 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 87 of file Chat.h.

◆ canSetStickerSet

bool TgBot::Chat::canSetStickerSet

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

Definition at line 123 of file Chat.h.

◆ description

std::string TgBot::Chat::description

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

Definition at line 99 of file Chat.h.

◆ firstName

std::string TgBot::Chat::firstName

Optional. First name of the other party in private chat

Definition at line 75 of file Chat.h.

◆ id

int64_t TgBot::Chat::id

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

Definition at line 53 of file Chat.h.

◆ inviteLink

std::string TgBot::Chat::inviteLink

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

Definition at line 105 of file Chat.h.

◆ lastName

std::string TgBot::Chat::lastName

Optional. Last name of the other party in private chat

Definition at line 81 of file Chat.h.

◆ photo

ChatPhoto::Ptr TgBot::Chat::photo

Optional. Chat photo. Returned only in getChat.

Definition at line 93 of file Chat.h.

◆ pinnedMessage

std::shared_ptr<Message> TgBot::Chat::pinnedMessage

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

Definition at line 111 of file Chat.h.

◆ stickerSetName

std::string TgBot::Chat::stickerSetName

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

Definition at line 117 of file Chat.h.

◆ title

std::string TgBot::Chat::title

Optional. Title for channels and group chat

Definition at line 63 of file Chat.h.

◆ type

Type TgBot::Chat::type

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

Definition at line 58 of file Chat.h.

◆ username

std::string TgBot::Chat::username

Optional. Username for private chats and channels

Definition at line 69 of file Chat.h.

The documentation for this class was generated from the following file: