tgbot-cpp
Loading...
Searching...
No Matches
TgBot::Chat Class Reference

This object represents a chat. More...

#include <Chat.h>

Public Types

enum class  Type { Private , Group , Supergroup , Channel }
 Enum of possible types of a chat. More...
 
typedef std::shared_ptr< ChatPtr
 

Public Attributes

std::int64_t id
 Unique identifier for this chat.
 
Type type
 Type of chat, can be either “private”, “group”, “supergroup” or “channel”
 
std::string title
 Optional. Title, for supergroups, channels and group chats.
 
std::string username
 Optional. Username, for private chats, supergroups and channels if available.
 
std::string firstName
 Optional. First name of the other party in a private chat.
 
std::string lastName
 Optional. Last name of the other party in a private chat.
 
bool isForum
 Optional. True, if the supergroup chat is a forum (has topics enabled)
 
ChatPhoto::Ptr photo
 Optional. Chat photo.
 
std::vector< std::string > activeUsernames
 Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels.
 
std::string emojiStatusCustomEmojiId
 Optional. Custom emoji identifier of emoji status of the other party in a private chat.
 
std::string bio
 Optional. Bio of the other party in a private chat.
 
bool hasPrivateForwards
 Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user.
 
bool hasRestrictedVoiceAndVideoMessages
 Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat.
 
bool joinToSendMessages
 Optional. True, if users need to join the supergroup before they can send messages.
 
bool joinByRequest
 Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators.
 
std::string description
 Optional. Description, for groups, supergroups and channel chats.
 
std::string inviteLink
 Optional. Primary invite link, for groups, supergroups and channel chats.
 
std::shared_ptr< MessagepinnedMessage
 Optional. The most recent pinned message (by sending date).
 
ChatPermissions::Ptr permissions
 Optional. Default chat member permissions, for groups and supergroups.
 
std::int32_t slowModeDelay
 Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds.
 
std::int32_t messageAutoDeleteTime
 Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds.
 
bool hasAggressiveAntiSpamEnabled
 Optional. True, if aggressive anti-spam checks are enabled in the supergroup.
 
bool hasHiddenMembers
 Optional. True, if non-administrators can only get the list of bots and administrators in the chat.
 
bool hasProtectedContent
 Optional. True, if messages from the chat can't be forwarded to other chats.
 
std::string stickerSetName
 Optional. For supergroups, name of group sticker set.
 
bool canSetStickerSet
 Optional. True, if the bot can change the group sticker set.
 
std::int64_t linkedChatId
 Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats.
 
ChatLocation::Ptr location
 Optional. For supergroups, the location to which the supergroup is connected.
 

Detailed Description

This object represents a chat.

Definition at line 22 of file Chat.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 25 of file Chat.h.

Member Enumeration Documentation

◆ Type

enum class TgBot::Chat::Type
strong

Enum of possible types of a chat.

Enumerator
Private 
Group 
Supergroup 
Channel 

Definition at line 30 of file Chat.h.

Member Data Documentation

◆ activeUsernames

std::vector<std::string> TgBot::Chat::activeUsernames

Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels.

Returned only in Api::getChat.

Definition at line 84 of file Chat.h.

◆ bio

std::string TgBot::Chat::bio

Optional. Bio of the other party in a private chat.

Returned only in Api::getChat.

Definition at line 98 of file Chat.h.

◆ canSetStickerSet

bool TgBot::Chat::canSetStickerSet

Optional. True, if the bot can change the group sticker set.

Returned only in Api::getChat.

Definition at line 204 of file Chat.h.

◆ description

std::string TgBot::Chat::description

Optional. Description, for groups, supergroups and channel chats.

Returned only in Api::getChat.

Definition at line 133 of file Chat.h.

◆ emojiStatusCustomEmojiId

std::string TgBot::Chat::emojiStatusCustomEmojiId

Optional. Custom emoji identifier of emoji status of the other party in a private chat.

Returned only in Api::getChat.

Definition at line 91 of file Chat.h.

◆ firstName

std::string TgBot::Chat::firstName

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

Definition at line 60 of file Chat.h.

◆ hasAggressiveAntiSpamEnabled

bool TgBot::Chat::hasAggressiveAntiSpamEnabled

Optional. True, if aggressive anti-spam checks are enabled in the supergroup.

The field is only available to chat administrators. Returned only in Api::getChat.

Definition at line 176 of file Chat.h.

◆ hasHiddenMembers

bool TgBot::Chat::hasHiddenMembers

Optional. True, if non-administrators can only get the list of bots and administrators in the chat.

Returned only in Api::getChat.

Definition at line 183 of file Chat.h.

◆ hasPrivateForwards

bool TgBot::Chat::hasPrivateForwards

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user.

Returned only in Api::getChat.

Definition at line 105 of file Chat.h.

◆ hasProtectedContent

bool TgBot::Chat::hasProtectedContent

Optional. True, if messages from the chat can't be forwarded to other chats.

Returned only in Api::getChat.

Definition at line 190 of file Chat.h.

◆ hasRestrictedVoiceAndVideoMessages

bool TgBot::Chat::hasRestrictedVoiceAndVideoMessages

Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat.

Returned only in Api::getChat.

Definition at line 112 of file Chat.h.

◆ id

std::int64_t TgBot::Chat::id

Unique identifier for this chat.

This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

Definition at line 40 of file Chat.h.

◆ inviteLink

std::string TgBot::Chat::inviteLink

Optional. Primary invite link, for groups, supergroups and channel chats.

Returned only in Api::getChat.

Definition at line 140 of file Chat.h.

◆ isForum

bool TgBot::Chat::isForum

Optional. True, if the supergroup chat is a forum (has topics enabled)

Definition at line 70 of file Chat.h.

◆ joinByRequest

bool TgBot::Chat::joinByRequest

Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators.

Returned only in Api::getChat.

Definition at line 126 of file Chat.h.

◆ joinToSendMessages

bool TgBot::Chat::joinToSendMessages

Optional. True, if users need to join the supergroup before they can send messages.

Returned only in Api::getChat.

Definition at line 119 of file Chat.h.

◆ lastName

std::string TgBot::Chat::lastName

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

Definition at line 65 of file Chat.h.

◆ linkedChatId

std::int64_t TgBot::Chat::linkedChatId

Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats.

This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in Api::getChat.

Definition at line 213 of file Chat.h.

◆ location

ChatLocation::Ptr TgBot::Chat::location

Optional. For supergroups, the location to which the supergroup is connected.

Returned only in Api::getChat.

Definition at line 220 of file Chat.h.

◆ messageAutoDeleteTime

std::int32_t TgBot::Chat::messageAutoDeleteTime

Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds.

Returned only in Api::getChat.

Definition at line 168 of file Chat.h.

◆ permissions

ChatPermissions::Ptr TgBot::Chat::permissions

Optional. Default chat member permissions, for groups and supergroups.

Returned only in Api::getChat.

Definition at line 154 of file Chat.h.

◆ photo

ChatPhoto::Ptr TgBot::Chat::photo

Optional. Chat photo.

Returned only in Api::getChat.

Definition at line 77 of file Chat.h.

◆ pinnedMessage

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

Optional. The most recent pinned message (by sending date).

Returned only in Api::getChat.

Definition at line 147 of file Chat.h.

◆ slowModeDelay

std::int32_t TgBot::Chat::slowModeDelay

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds.

Returned only in Api::getChat.

Definition at line 161 of file Chat.h.

◆ stickerSetName

std::string TgBot::Chat::stickerSetName

Optional. For supergroups, name of group sticker set.

Returned only in Api::getChat.

Definition at line 197 of file Chat.h.

◆ title

std::string TgBot::Chat::title

Optional. Title, for supergroups, channels and group chats.

Definition at line 50 of file Chat.h.

◆ type

Type TgBot::Chat::type

Type of chat, can be either “private”, “group”, “supergroup” or “channel”

Definition at line 45 of file Chat.h.

◆ username

std::string TgBot::Chat::username

Optional. Username, for private chats, supergroups and channels if available.

Definition at line 55 of file Chat.h.


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