This object represents a chat. https://core.telegram.org/bots/api#chatfullinfo. More...

#include <ChatFullInfo.hpp>

Inheritance diagram for tgbotxx::ChatFullInfo:

Public Member Functions
	ChatFullInfo ()=default

	ChatFullInfo (const nl::json &json)

nl::json	toJson () const override
	Serializes this object to JSON.

void	fromJson (const nl::json &json) override
	Deserializes this object from JSON.

Public Member Functions inherited from tgbotxx::Chat
	Chat ()=default

	Chat (const nl::json &json)

virtual	~Chat ()=default

Public Attributes
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. See accent colors for more details. Always returned in getChat.

std::int64_t	maxReactionCount {}
	The maximum number of reactions that can be set on a message in the chat.

Ptr< ChatPhoto >	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.

Ptr< Birthdate >	birthdate
	Optional. For private chats, the date of birth of the user.

Ptr< BusinessIntro >	businessIntro
	Optional. For private chats with business accounts, the intro of the business.

Ptr< BusinessLocation >	businessLocation
	Optional. For private chats with business accounts, the location of the business.

Ptr< BusinessOpeningHours >	businessOpeningHours
	Optional. For private chats with business accounts, the opening hours of the business.

Ptr< Chat >	personalChat
	Optional. For private chats, the personal channel of the user.

Ptr< Chat >	parentChat
	Optional. Information about the corresponding channel chat; for direct messages chats only.

std::vector< Ptr< ReactionType > >	availableReactions
	Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.

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. See profile accent colors for more details.

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 emoji status of the other party in a private chat. https://core.telegram.org/bots/api#getchat .

std::time_t	emojiStatusExpirationDate {}
	Optional. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. https://core.telegram.org/bots/api#getchat .

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.

Ptr< Message >	pinnedMessage
	Optional. The most recent pinned message (by sending date).

Ptr< ChatPermissions >	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. The field is only available to chat administrators.

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. Custom emoji from this set can be used by all users and bots in the group.

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.

Ptr< ChatLocation >	location
	Optional. For supergroups, the location to which the supergroup is connected.

Public Attributes inherited from tgbotxx::Chat
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) https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups .

bool	isDirectMessages {}
	Optional. True, if the supergroup chat is a forum (has topics enabled) https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups .

Additional Inherited Members
Public Types inherited from tgbotxx::Chat
enum class	Type : std::uint8_t { Private = 0 , Group , Supergroup , Channel }
	Enum of possible types of Type. More...

Static Public Member Functions inherited from tgbotxx::Chat
static std::optional< std::string >	TypeToString (const Type type) noexcept
	Converts enum Type to a string.

static std::optional< Type >	StringToType (const std::string &str) noexcept
	Converts string to an enum Type.

Detailed Description

This object represents a chat. https://core.telegram.org/bots/api#chatfullinfo.

Definition at line 17 of file ChatFullInfo.hpp.

Constructor & Destructor Documentation

◆ ChatFullInfo() [1/2]

tgbotxx::ChatFullInfo::ChatFullInfo ( )

default

◆ ChatFullInfo() [2/2]

tgbotxx::ChatFullInfo::ChatFullInfo ( const nl::json & json )

inlineexplicit

Definition at line 19 of file ChatFullInfo.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::ChatFullInfo::fromJson ( const nl::json & json )

inlineoverridevirtual

Deserializes this object from JSON.

Reimplemented from tgbotxx::Chat.

Definition at line 184 of file ChatFullInfo.hpp.

◆ toJson()

nl::json tgbotxx::ChatFullInfo::toJson ( ) const

inlineoverridevirtual

Serializes this object to JSON.

Returns: JSON representation of this object

Reimplemented from tgbotxx::Chat.

Definition at line 142 of file ChatFullInfo.hpp.

Member Data Documentation

◆ accentColorId

std::int32_t tgbotxx::ChatFullInfo::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. Always returned in getChat.

Definition at line 25 of file ChatFullInfo.hpp.

◆ activeUsernames

std::vector<std::string> tgbotxx::ChatFullInfo::activeUsernames

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

Definition at line 34 of file ChatFullInfo.hpp.

◆ availableReactions

std::vector<Ptr<ReactionType> > tgbotxx::ChatFullInfo::availableReactions

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

Definition at line 55 of file ChatFullInfo.hpp.

◆ backgroundCustomEmojiId

std::string tgbotxx::ChatFullInfo::backgroundCustomEmojiId

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

Definition at line 58 of file ChatFullInfo.hpp.

◆ bio

std::string tgbotxx::ChatFullInfo::bio

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

Definition at line 75 of file ChatFullInfo.hpp.

◆ birthdate

Ptr<Birthdate> tgbotxx::ChatFullInfo::birthdate

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

Definition at line 37 of file ChatFullInfo.hpp.

◆ businessIntro

Ptr<BusinessIntro> tgbotxx::ChatFullInfo::businessIntro

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

Definition at line 40 of file ChatFullInfo.hpp.

◆ businessLocation

Ptr<BusinessLocation> tgbotxx::ChatFullInfo::businessLocation

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

Definition at line 43 of file ChatFullInfo.hpp.

◆ businessOpeningHours

Ptr<BusinessOpeningHours> tgbotxx::ChatFullInfo::businessOpeningHours

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

Definition at line 46 of file ChatFullInfo.hpp.

◆ canSetStickerSet

bool tgbotxx::ChatFullInfo::canSetStickerSet {}

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

Definition at line 126 of file ChatFullInfo.hpp.

◆ customEmojiStickerSetName

std::string tgbotxx::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 129 of file ChatFullInfo.hpp.

◆ description

std::string tgbotxx::ChatFullInfo::description

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

Definition at line 90 of file ChatFullInfo.hpp.

◆ emojiStatusCustomEmojiId

std::string tgbotxx::ChatFullInfo::emojiStatusCustomEmojiId

Optional. Custom emoji identifier of emoji status of the other party in a private chat. https://core.telegram.org/bots/api#getchat .

Definition at line 68 of file ChatFullInfo.hpp.

◆ emojiStatusExpirationDate

std::time_t tgbotxx::ChatFullInfo::emojiStatusExpirationDate {}

Optional. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. https://core.telegram.org/bots/api#getchat .

Definition at line 72 of file ChatFullInfo.hpp.

◆ hasAggressiveAntiSpamEnabled

bool tgbotxx::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 111 of file ChatFullInfo.hpp.

◆ hasHiddenMembers

bool tgbotxx::ChatFullInfo::hasHiddenMembers {}

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

Definition at line 114 of file ChatFullInfo.hpp.

◆ hasPrivateForwards

bool tgbotxx::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 78 of file ChatFullInfo.hpp.

◆ hasProtectedContent

bool tgbotxx::ChatFullInfo::hasProtectedContent {}

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

Definition at line 117 of file ChatFullInfo.hpp.

◆ hasRestrictedVoiceAndVideoMessages

bool tgbotxx::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 81 of file ChatFullInfo.hpp.

◆ hasVisibleHistory

bool tgbotxx::ChatFullInfo::hasVisibleHistory {}

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

Definition at line 120 of file ChatFullInfo.hpp.

◆ inviteLink

std::string tgbotxx::ChatFullInfo::inviteLink

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

Definition at line 93 of file ChatFullInfo.hpp.

◆ joinByRequest

bool tgbotxx::ChatFullInfo::joinByRequest {}

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

Definition at line 87 of file ChatFullInfo.hpp.

◆ joinToSendMessages

bool tgbotxx::ChatFullInfo::joinToSendMessages {}

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

Definition at line 84 of file ChatFullInfo.hpp.

◆ linkedChatId

std::int64_t tgbotxx::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 135 of file ChatFullInfo.hpp.

◆ location

Ptr<ChatLocation> tgbotxx::ChatFullInfo::location

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

Definition at line 138 of file ChatFullInfo.hpp.

◆ maxReactionCount

std::int64_t tgbotxx::ChatFullInfo::maxReactionCount {}

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

Definition at line 28 of file ChatFullInfo.hpp.

◆ messageAutoDeleteTime

std::int32_t tgbotxx::ChatFullInfo::messageAutoDeleteTime {}

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

Definition at line 108 of file ChatFullInfo.hpp.

◆ parentChat

Ptr<Chat> tgbotxx::ChatFullInfo::parentChat

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

Definition at line 52 of file ChatFullInfo.hpp.

◆ permissions

Ptr<ChatPermissions> tgbotxx::ChatFullInfo::permissions

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

Definition at line 99 of file ChatFullInfo.hpp.

◆ personalChat

Ptr<Chat> tgbotxx::ChatFullInfo::personalChat

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

Definition at line 49 of file ChatFullInfo.hpp.

◆ photo

Ptr<ChatPhoto> tgbotxx::ChatFullInfo::photo

Optional. Chat photo.

Definition at line 31 of file ChatFullInfo.hpp.

◆ pinnedMessage

Ptr<Message> tgbotxx::ChatFullInfo::pinnedMessage

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

Definition at line 96 of file ChatFullInfo.hpp.

◆ profileAccentColorId

std::int32_t tgbotxx::ChatFullInfo::profileAccentColorId {}

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

Definition at line 61 of file ChatFullInfo.hpp.

◆ profileBackgroundCustomEmojiId

std::string tgbotxx::ChatFullInfo::profileBackgroundCustomEmojiId

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

Definition at line 64 of file ChatFullInfo.hpp.

◆ slowModeDelay

std::int32_t tgbotxx::ChatFullInfo::slowModeDelay {}

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

Definition at line 102 of file ChatFullInfo.hpp.

◆ stickerSetName

std::string tgbotxx::ChatFullInfo::stickerSetName

Optional. For supergroups, name of group sticker set.

Definition at line 123 of file ChatFullInfo.hpp.

◆ unrestrictBoostCount

std::int32_t tgbotxx::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 105 of file ChatFullInfo.hpp.

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

include/tgbotxx/objects/ChatFullInfo.hpp

Public Member Functions

Public Attributes

Additional Inherited Members