tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ChatFullInfo Struct Reference

This object contains full information about a chat. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<ChatFullInfo>

Public Attributes

std::int64_t 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 type { }
 Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
std::optional< std::string > title { }
 Optional. Title, for supergroups, channels and group chats.
std::optional< std::string > username { }
 Optional. Username, for private chats, supergroups and channels if available.
std::optional< std::string > firstName { }
 Optional. First name of the other party in a private chat.
std::optional< std::string > lastName { }
 Optional. Last name of the other party in a private chat.
std::optional< bool > isForum { }
 Optional. True, if the supergroup chat is a forum (has topics enabled).
std::optional< bool > isDirectMessages { }
 Optional. True, if the chat is the direct messages chat of a channel.
std::int32_t accentColorId { }
 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.
std::int32_t maxReactionCount { }
 The maximum number of reactions that can be set on a message in the chat.
std::shared_ptr< ChatPhoto > photo { }
 Optional. Chat photo.
std::optional< std::vector< std::string > > activeUsernames { }
 Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels.
std::shared_ptr< Birthdate > birthdate { }
 Optional. For private chats, the date of birth of the user.
std::shared_ptr< BusinessIntro > businessIntro { }
 Optional. For private chats with business accounts, the intro of the business.
std::shared_ptr< BusinessLocation > businessLocation { }
 Optional. For private chats with business accounts, the location of the business.
std::shared_ptr< BusinessOpeningHours > businessOpeningHours { }
 Optional. For private chats with business accounts, the opening hours of the business.
std::shared_ptr< Chat > personalChat { }
 Optional. For private chats, the personal channel of the user.
std::shared_ptr< Chat > parentChat { }
 Optional. Information about the corresponding channel chat; for direct messages chats only.
std::optional< std::vector< std::shared_ptr< ReactionType > > > availableReactions { }
 Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
std::optional< std::string > backgroundCustomEmojiId { }
 Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background.
std::optional< std::int32_t > profileAccentColorId { }
 Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.
std::optional< std::string > profileBackgroundCustomEmojiId { }
 Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background.
std::optional< std::string > emojiStatusCustomEmojiId { }
 Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat.
std::optional< std::int32_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::optional< std::string > bio { }
 Optional. Bio of the other party in a private chat.
std::optional< 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.
std::optional< bool > hasRestrictedVoiceAndVideoMessages { }
 Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat.
std::optional< bool > joinToSendMessages { }
 Optional. True, if users need to join the supergroup before they can send messages.
std::optional< bool > joinByRequest { }
 Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators.
std::optional< std::string > description { }
 Optional. Description, for groups, supergroups and channel chats.
std::optional< 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).
std::shared_ptr< ChatPermissions > permissions { }
 Optional. Default chat member permissions, for groups and supergroups.
std::shared_ptr< AcceptedGiftTypes > acceptedGiftTypes { }
 Information about types of gifts that are accepted by the chat or by the corresponding user for private chats.
std::optional< bool > canSendPaidMedia { }
 Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
std::optional< std::int32_t > slowModeDelay { }
 Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds.
std::optional< 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::optional< std::int32_t > messageAutoDeleteTime { }
 Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds.
std::optional< bool > hasAggressiveAntiSpamEnabled { }
 Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
std::optional< bool > hasHiddenMembers { }
 Optional. True, if non-administrators can only get the list of bots and administrators in the chat.
std::optional< bool > hasProtectedContent { }
 Optional. True, if messages from the chat can't be forwarded to other chats.
std::optional< bool > hasVisibleHistory { }
 Optional. True, if new chat members will have access to old messages; available only to chat administrators.
std::optional< std::string > stickerSetName { }
 Optional. For supergroups, name of the group sticker set.
std::optional< bool > canSetStickerSet { }
 Optional. True, if the bot can change the group sticker set.
std::optional< std::string > 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.
std::optional< 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. 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.
std::shared_ptr< ChatLocation > location { }
 Optional. For supergroups, the location to which the supergroup is connected.
std::shared_ptr< UserRating > rating { }
 Optional. For private chats, the rating of the user if any.
std::shared_ptr< Audio > firstProfileAudio { }
 Optional. For private chats, the first audio added to the profile of the user.
std::shared_ptr< UniqueGiftColors > uniqueGiftColors { }
 Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews.
std::optional< std::int32_t > paidMessageStarCount { }
 Optional. The number of Telegram Stars a general user has to pay to send a message to the chat.
std::shared_ptr< User > guardBot { }
 Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators.
std::shared_ptr< Community > community { }
 Optional. The Community to which the chat belongs.

Detailed Description

This object contains full information about a chat.

Definition at line 1784 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::ChatFullInfo::Ptr = std::shared_ptr<ChatFullInfo>

Definition at line 1785 of file Types.h.

Member Data Documentation

◆ accentColorId

std::int32_t TgBot::ChatFullInfo::accentColorId { }

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.

Definition at line 1826 of file Types.h.

◆ acceptedGiftTypes

std::shared_ptr<AcceptedGiftTypes> TgBot::ChatFullInfo::acceptedGiftTypes { }

Information about types of gifts that are accepted by the chat or by the corresponding user for private chats.

Definition at line 1938 of file Types.h.

◆ activeUsernames

std::optional<std::vector<std::string> > TgBot::ChatFullInfo::activeUsernames { }

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

Definition at line 1839 of file Types.h.

◆ availableReactions

std::optional<std::vector<std::shared_ptr<ReactionType> > > TgBot::ChatFullInfo::availableReactions { }

Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.

Definition at line 1869 of file Types.h.

◆ backgroundCustomEmojiId

std::optional<std::string> TgBot::ChatFullInfo::backgroundCustomEmojiId { }

Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background.

Definition at line 1874 of file Types.h.

◆ bio

std::optional<std::string> TgBot::ChatFullInfo::bio { }

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

Definition at line 1898 of file Types.h.

◆ birthdate

std::shared_ptr<Birthdate> TgBot::ChatFullInfo::birthdate { }

Optional. For private chats, the date of birth of the user.

Definition at line 1843 of file Types.h.

◆ businessIntro

std::shared_ptr<BusinessIntro> TgBot::ChatFullInfo::businessIntro { }

Optional. For private chats with business accounts, the intro of the business.

Definition at line 1847 of file Types.h.

◆ businessLocation

std::shared_ptr<BusinessLocation> TgBot::ChatFullInfo::businessLocation { }

Optional. For private chats with business accounts, the location of the business.

Definition at line 1851 of file Types.h.

◆ businessOpeningHours

std::shared_ptr<BusinessOpeningHours> TgBot::ChatFullInfo::businessOpeningHours { }

Optional. For private chats with business accounts, the opening hours of the business.

Definition at line 1855 of file Types.h.

◆ canSendPaidMedia

std::optional<bool> TgBot::ChatFullInfo::canSendPaidMedia { }

Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.

Definition at line 1943 of file Types.h.

◆ canSetStickerSet

std::optional<bool> TgBot::ChatFullInfo::canSetStickerSet { }

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

Definition at line 1985 of file Types.h.

◆ community

std::shared_ptr<Community> TgBot::ChatFullInfo::community { }

Optional. The Community to which the chat belongs.

Definition at line 2029 of file Types.h.

◆ customEmojiStickerSetName

std::optional<std::string> TgBot::ChatFullInfo::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.

Definition at line 1990 of file Types.h.

◆ description

std::optional<std::string> TgBot::ChatFullInfo::description { }

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

Definition at line 1921 of file Types.h.

◆ emojiStatusCustomEmojiId

std::optional<std::string> TgBot::ChatFullInfo::emojiStatusCustomEmojiId { }

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

Definition at line 1889 of file Types.h.

◆ emojiStatusExpirationDate

std::optional<std::int32_t> TgBot::ChatFullInfo::emojiStatusExpirationDate { }

Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any.

Definition at line 1894 of file Types.h.

◆ firstName

std::optional<std::string> TgBot::ChatFullInfo::firstName { }

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

Definition at line 1809 of file Types.h.

◆ firstProfileAudio

std::shared_ptr<Audio> TgBot::ChatFullInfo::firstProfileAudio { }

Optional. For private chats, the first audio added to the profile of the user.

Definition at line 2010 of file Types.h.

◆ guardBot

std::shared_ptr<User> TgBot::ChatFullInfo::guardBot { }

Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators.

Definition at line 2025 of file Types.h.

◆ hasAggressiveAntiSpamEnabled

std::optional<bool> TgBot::ChatFullInfo::hasAggressiveAntiSpamEnabled { }

Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

Definition at line 1963 of file Types.h.

◆ hasHiddenMembers

std::optional<bool> TgBot::ChatFullInfo::hasHiddenMembers { }

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

Definition at line 1968 of file Types.h.

◆ hasPrivateForwards

std::optional<bool> TgBot::ChatFullInfo::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.

Definition at line 1903 of file Types.h.

◆ hasProtectedContent

std::optional<bool> TgBot::ChatFullInfo::hasProtectedContent { }

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

Definition at line 1972 of file Types.h.

◆ hasRestrictedVoiceAndVideoMessages

std::optional<bool> TgBot::ChatFullInfo::hasRestrictedVoiceAndVideoMessages { }

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

Definition at line 1908 of file Types.h.

◆ hasVisibleHistory

std::optional<bool> TgBot::ChatFullInfo::hasVisibleHistory { }

Optional. True, if new chat members will have access to old messages; available only to chat administrators.

Definition at line 1977 of file Types.h.

◆ id

std::int64_t TgBot::ChatFullInfo::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 1793 of file Types.h.

◆ inviteLink

std::optional<std::string> TgBot::ChatFullInfo::inviteLink { }

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

Definition at line 1925 of file Types.h.

◆ isDirectMessages

std::optional<bool> TgBot::ChatFullInfo::isDirectMessages { }

Optional. True, if the chat is the direct messages chat of a channel.

Definition at line 1821 of file Types.h.

◆ isForum

std::optional<bool> TgBot::ChatFullInfo::isForum { }

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

Definition at line 1817 of file Types.h.

◆ joinByRequest

std::optional<bool> TgBot::ChatFullInfo::joinByRequest { }

Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators.

Definition at line 1917 of file Types.h.

◆ joinToSendMessages

std::optional<bool> TgBot::ChatFullInfo::joinToSendMessages { }

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

Definition at line 1912 of file Types.h.

◆ lastName

std::optional<std::string> TgBot::ChatFullInfo::lastName { }

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

Definition at line 1813 of file Types.h.

◆ linkedChatId

std::optional<std::int64_t> TgBot::ChatFullInfo::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.

Definition at line 1998 of file Types.h.

◆ location

std::shared_ptr<ChatLocation> TgBot::ChatFullInfo::location { }

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

Definition at line 2002 of file Types.h.

◆ maxReactionCount

std::int32_t TgBot::ChatFullInfo::maxReactionCount { }

The maximum number of reactions that can be set on a message in the chat.

Definition at line 1830 of file Types.h.

◆ messageAutoDeleteTime

std::optional<std::int32_t> TgBot::ChatFullInfo::messageAutoDeleteTime { }

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

Definition at line 1958 of file Types.h.

◆ paidMessageStarCount

std::optional<std::int32_t> TgBot::ChatFullInfo::paidMessageStarCount { }

Optional. The number of Telegram Stars a general user has to pay to send a message to the chat.

Definition at line 2020 of file Types.h.

◆ parentChat

std::shared_ptr<Chat> TgBot::ChatFullInfo::parentChat { }

Optional. Information about the corresponding channel chat; for direct messages chats only.

Definition at line 1864 of file Types.h.

◆ permissions

std::shared_ptr<ChatPermissions> TgBot::ChatFullInfo::permissions { }

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

Definition at line 1933 of file Types.h.

◆ personalChat

std::shared_ptr<Chat> TgBot::ChatFullInfo::personalChat { }

Optional. For private chats, the personal channel of the user.

Definition at line 1859 of file Types.h.

◆ photo

std::shared_ptr<ChatPhoto> TgBot::ChatFullInfo::photo { }

Optional. Chat photo.

Definition at line 1834 of file Types.h.

◆ pinnedMessage

std::shared_ptr<Message> TgBot::ChatFullInfo::pinnedMessage { }

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

Definition at line 1929 of file Types.h.

◆ profileAccentColorId

std::optional<std::int32_t> TgBot::ChatFullInfo::profileAccentColorId { }

Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.

Definition at line 1879 of file Types.h.

◆ profileBackgroundCustomEmojiId

std::optional<std::string> TgBot::ChatFullInfo::profileBackgroundCustomEmojiId { }

Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background.

Definition at line 1884 of file Types.h.

◆ rating

std::shared_ptr<UserRating> TgBot::ChatFullInfo::rating { }

Optional. For private chats, the rating of the user if any.

Definition at line 2006 of file Types.h.

◆ slowModeDelay

std::optional<std::int32_t> TgBot::ChatFullInfo::slowModeDelay { }

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

Definition at line 1948 of file Types.h.

◆ stickerSetName

std::optional<std::string> TgBot::ChatFullInfo::stickerSetName { }

Optional. For supergroups, name of the group sticker set.

Definition at line 1981 of file Types.h.

◆ title

std::optional<std::string> TgBot::ChatFullInfo::title { }

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

Definition at line 1801 of file Types.h.

◆ type

std::string TgBot::ChatFullInfo::type { }

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

Definition at line 1797 of file Types.h.

◆ uniqueGiftColors

std::shared_ptr<UniqueGiftColors> TgBot::ChatFullInfo::uniqueGiftColors { }

Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews.

Definition at line 2015 of file Types.h.

◆ unrestrictBoostCount

std::optional<std::int32_t> TgBot::ChatFullInfo::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.

Definition at line 1953 of file Types.h.

◆ username

std::optional<std::string> TgBot::ChatFullInfo::username { }

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

Definition at line 1805 of file Types.h.


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