- Generated on Tue Jun 11 2024 00:46:35 for tgbot-cpp by
1.11.0
|
tgbot-cpp
|
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< Chat > | Ptr |
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. | |
| Birthdate::Ptr | birthdate |
| Optional. For private chats, the date of birth of the user. | |
| BusinessIntro::Ptr | businessIntro |
| Optional. For private chats with business accounts, the intro of the business. | |
| BusinessLocation::Ptr | businessLocation |
| Optional. For private chats with business accounts, the location of the business. | |
| BusinessOpeningHours::Ptr | businessOpeningHours |
| Optional. For private chats with business accounts, the opening hours of the business. | |
| Chat::Ptr | personalChat |
| Optional. For private chats, the personal channel of the user. | |
| std::vector< ReactionType::Ptr > | availableReactions |
| Optional. List of available reactions allowed in the chat. | |
| std::int32_t | accentColorId |
| Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. | |
| std::string | backgroundCustomEmojiId |
| Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. | |
| std::int32_t | profileAccentColorId |
| Optional. Identifier of the accent color for the chat's profile background. | |
| std::string | profileBackgroundCustomEmojiId |
| Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. | |
| std::string | emojiStatusCustomEmojiId |
| Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. | |
| std::uint32_t | emojiStatusExpirationDate |
| Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. | |
| 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< Message > | pinnedMessage |
| 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 unprivileged user; in seconds. | |
| std::int32_t | unrestrictBoostCount |
| Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. | |
| 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. | |
| bool | hasVisibleHistory |
| Optional. True, if new chat members will have access to old messages; available only to chat administrators. | |
| 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::string | customEmojiStickerSetName |
| Optional. For supergroups, the name of the group's custom emoji 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. | |
| typedef std::shared_ptr<Chat> TgBot::Chat::Ptr |
|
strong |
| std::int32_t TgBot::Chat::accentColorId |
Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview.
See accent colors for more details. Returned only in Api::getChat. Always returned in Api::getChat.
| 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.
| std::vector<ReactionType::Ptr> TgBot::Chat::availableReactions |
Optional. List of available reactions allowed in the chat.
If omitted, then all emoji reactions are allowed. Returned only in Api::getChat.
| std::string TgBot::Chat::backgroundCustomEmojiId |
Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background.
Returned only in Api::getChat.
| std::string TgBot::Chat::bio |
Optional. Bio of the other party in a private chat.
Returned only in Api::getChat.
| Birthdate::Ptr TgBot::Chat::birthdate |
Optional. For private chats, the date of birth of the user.
Returned only in Api::getChat.
| BusinessIntro::Ptr TgBot::Chat::businessIntro |
Optional. For private chats with business accounts, the intro of the business.
Returned only in Api::getChat.
| BusinessLocation::Ptr TgBot::Chat::businessLocation |
Optional. For private chats with business accounts, the location of the business.
Returned only in Api::getChat.
| BusinessOpeningHours::Ptr TgBot::Chat::businessOpeningHours |
Optional. For private chats with business accounts, the opening hours of the business.
Returned only in Api::getChat.
| bool TgBot::Chat::canSetStickerSet |
Optional. True, if the bot can change the group sticker set.
Returned only in Api::getChat.
| std::string TgBot::Chat::customEmojiStickerSetName |
Optional. For supergroups, the name of the group's custom emoji sticker set.
Custom emoji from this set can be used by all users and bots in the group. Returned only in Api::getChat.
| std::string TgBot::Chat::description |
Optional. Description, for groups, supergroups and channel chats.
Returned only in Api::getChat.
| std::string TgBot::Chat::emojiStatusCustomEmojiId |
Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat.
Returned only in Api::getChat.
| std::uint32_t TgBot::Chat::emojiStatusExpirationDate |
Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any.
Returned only in Api::getChat.
| std::string TgBot::Chat::firstName |
| 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.
| 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.
| 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.
| bool TgBot::Chat::hasProtectedContent |
Optional. True, if messages from the chat can't be forwarded to other chats.
Returned only in Api::getChat.
| 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.
| bool TgBot::Chat::hasVisibleHistory |
Optional. True, if new chat members will have access to old messages; available only to chat administrators.
Returned only in Api::getChat.
| 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.
| std::string TgBot::Chat::inviteLink |
Optional. Primary invite link, for groups, supergroups and channel chats.
Returned only in Api::getChat.
| bool TgBot::Chat::isForum |
| 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.
| bool TgBot::Chat::joinToSendMessages |
Optional. True, if users need to join the supergroup before they can send messages.
Returned only in Api::getChat.
| std::string TgBot::Chat::lastName |
| 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.
| ChatLocation::Ptr TgBot::Chat::location |
Optional. For supergroups, the location to which the supergroup is connected.
Returned only in Api::getChat.
| 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.
| ChatPermissions::Ptr TgBot::Chat::permissions |
Optional. Default chat member permissions, for groups and supergroups.
Returned only in Api::getChat.
| Chat::Ptr TgBot::Chat::personalChat |
Optional. For private chats, the personal channel of the user.
Returned only in Api::getChat.
| ChatPhoto::Ptr TgBot::Chat::photo |
| std::shared_ptr<Message> TgBot::Chat::pinnedMessage |
Optional. The most recent pinned message (by sending date).
Returned only in Api::getChat.
| std::int32_t TgBot::Chat::profileAccentColorId |
Optional. Identifier of the accent color for the chat's profile background.
See profile accent colors for more details. Returned only in Api::getChat.
| std::string TgBot::Chat::profileBackgroundCustomEmojiId |
Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background.
Returned only in Api::getChat.
| std::int32_t TgBot::Chat::slowModeDelay |
Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds.
Returned only in Api::getChat.
| std::string TgBot::Chat::stickerSetName |
Optional. For supergroups, name of group sticker set.
Returned only in Api::getChat.
| std::string TgBot::Chat::title |
| Type TgBot::Chat::type |
| std::int32_t TgBot::Chat::unrestrictBoostCount |
Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions.
Returned only in Api::getChat.
| std::string TgBot::Chat::username |
1.11.0