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

#include <Message.hpp>

Public Member Functions
	Message ()=default

	Message (const nl::json &json)

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

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

Public Attributes
std::int32_t	messageId {}
	Unique message identifier inside this chat.

std::int32_t	messageThreadId {}
	Optional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only.

Ptr< DirectMessagesTopic >	directMessagesTopic
	Optional. Information about the direct messages chat topic that contains the message.

Ptr< User >	from
	Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

Ptr< Chat >	senderChat
	Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

std::int32_t	senderBoostCount {}
	Optional. If the sender of the message boosted the chat, the number of boosts added by the user.

Ptr< User >	senderBusinessBot
	Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

std::string	senderTag
	Optional. Tag or custom title of the sender of the message; for supergroups only.

std::time_t	date {}
	Date the message was sent in Unix time. It is always a positive number, representing a valid date.

std::string	businessConnectionId
	Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

Ptr< Chat >	chat
	Conversation the message belongs to.

Ptr< MessageOrigin >	forwardOrigin
	Optional. Information about the original message for forwarded messages.

bool	isTopicMessage {}
	Optional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot.

bool	isAutomaticForward {}
	Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group.

Ptr< Message >	replyToMessage
	Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

Ptr< ExternalReplyInfo >	externalReply
	Optional. Information about the message that is being replied to, which may come from another chat or forum topic.

Ptr< TextQuote >	quote {}
	Optional. For replies that quote part of the original message, the quoted part of the message.

Ptr< Story >	replyToStory
	Optional. For replies to a story, the original story.

std::int32_t	replyToChecklistTaskId {}
	Optional. Identifier of the specific checklist task that is being replied to.

Ptr< User >	viaBot
	Optional. Bot through which the message was sent.

std::time_t	editDate {}
	Optional. Date the message was last edited in Unix time.

bool	hasProtectedContent {}
	Optional. True, if the message can't be forwarded.

bool	isFromOffline {}
	Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message.

bool	isPaidPost {}
	Optional. True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.

std::string	mediaGroupId
	Optional. The unique identifier of a media message group this message belongs to.

std::string	authorSignature
	Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator.

std::int64_t	paidStarCount {}
	Optional. The number of Telegram Stars that were paid by the sender of the message to send it.

std::string	text
	Optional. For text messages, the actual UTF-8 text of the message.

std::vector< Ptr< MessageEntity > >	entities
	Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.

Ptr< LinkPreviewOptions >	linkPreviewOptions
	Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed.

Ptr< SuggestedPostInfo >	suggestedPostInfo {}
	Optional. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.

std::string	effectId
	Optional. Unique identifier of the message effect added to the message.

Ptr< Animation >	animation
	Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.

Ptr< Audio >	audio
	Optional. Message is an audio file, information about the file.

Ptr< Document >	document
	Optional. Message is a general file, information about the file.

std::vector< Ptr< PhotoSize > >	photo
	Optional. Message is a photo, available sizes of the photo.

Ptr< Sticker >	sticker
	Optional. Message is a sticker, information about the sticker.

Ptr< Story >	story
	Optional. Message is a forwarded story.

Ptr< Video >	video
	Optional. Message is a video, information about the video.

Ptr< VideoNote >	videoNote
	Optional. Message is a video note, information about the video message.

Ptr< Voice >	voice
	Optional. Message is a voice message, information about the file.

std::string	caption
	Optional. Caption for the animation, audio, document, photo, video or voice.

std::vector< Ptr< MessageEntity > >	captionEntities
	Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption.

bool	showCaptionAboveMedia {}
	Optional. True, if the caption must be shown above the message media.

bool	hasMediaSpoiler {}
	Optional. True, if the message media is covered by a spoiler animation.

Ptr< Checklist >	checklist
	Optional. Message is a checklist.

Ptr< Contact >	contact
	Optional. Message is a shared contact, information about the contact.

Ptr< Dice >	dice
	Optional. Message is a dice with random value.

Ptr< Game >	game
	Optional. Message is a game, information about the game. about games » https://core.telegram.org/bots/api#games .

Ptr< Poll >	poll
	Optional. Message is a native poll, information about the poll.

Ptr< Venue >	venue
	Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.

Ptr< Location >	location
	Optional. Message is a shared location, information about the location.

std::vector< Ptr< User > >	newChatMembers
	Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

Ptr< User >	leftChatMember
	Optional. A member was removed from the group, information about them (this member may be the bot itself)

Ptr< ChatOwnerLeft >	chatOwnerLeft
	Optional. Service message: chat owner has left.

Ptr< ChatOwnerChanged >	chatOwnerChanged
	Optional. Service message: chat owner has changed.

std::string	newChatTitle
	Optional. A chat title was changed to this value.

std::vector< Ptr< PhotoSize > >	newChatPhoto
	Optional. A chat photo was change to this value.

bool	deleteChatPhoto {}
	Optional. Service message: the chat photo was deleted.

bool	groupChatCreated {}
	Optional. Service message: the group has been created.

bool	supergroupChatCreated {}
	Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

bool	channelChatCreated {}
	Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.

Ptr< MessageAutoDeleteTimerChanged >	messageAutoDeleteTimerChanged
	Optional. Service message: auto-delete timer settings changed in the chat.

std::int64_t	migrateToChatId {}
	Optional. The group has been migrated to a supergroup with the specified identifier. 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::int64_t	migrateFromChatId {}
	Optional. The supergroup has been migrated from a group with the specified identifier. 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.

MaybeInaccessibleMessage	pinnedMessage {}
	Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

Ptr< Invoice >	invoice
	Optional. Message is an invoice for a payment, information about the invoice. about payments » https://core.telegram.org/bots/api#payments .

Ptr< SuccessfulPayment >	successfulPayment
	Optional. Message is a service message about a successful payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .

Ptr< RefundedPayment >	refundedPayment {}
	Optional. Message is a service message about a refunded payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .

Ptr< UsersShared >	usersShared
	Optional. Service message: users were shared with the bot.

Ptr< ChatShared >	chatShared
	Optional. Service message: a chat was shared with the bot.

Ptr< GiftInfo >	gift {}
	Optional. Service message: a regular gift was sent or received.

Ptr< UniqueGiftInfo >	uniqueGift {}
	Optional. Service message: a unique gift was sent or received.

Ptr< GiftInfo >	giftUpgradeSent {}
	Optional. Service message: upgrade of a gift was purchased after the gift was sent.

std::string	connectedWebsite
	Optional. The domain name of the website on which the user has logged in. about Telegram Login » https://core.telegram.org/widgets/login .

Ptr< WriteAccessAllowed >	writeAccessAllowed
	Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

Ptr< PassportData >	passportData
	Optional. Telegram Passport data.

Ptr< ProximityAlertTriggered >	proximityAlertTriggered
	Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.

Ptr< ChatBoostAdded >	boostAdded {}
	Optional. Service message: user boosted the chat.

Ptr< ChatBackground >	chatBackgroundSet {}
	Optional. Service message: chat background set.

Ptr< ChecklistTasksDone >	checklistTasksDone
	Optional. Service message: some tasks in a checklist were marked as done or not done.

Ptr< ChecklistTasksAdded >	checklistTasksAdded
	Optional. Service message: tasks were added to a checklist.

Ptr< DirectMessagePriceChanged >	directMessagePriceChanged {}
	Optional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed.

Ptr< ForumTopicCreated >	forumTopicCreated
	Optional. Service message: forum topic created.

Ptr< ForumTopicEdited >	forumTopicEdited
	Optional. Service message: forum topic edited.

Ptr< ForumTopicClosed >	forumTopicClosed
	Optional. Service message: forum topic closed.

Ptr< ForumTopicReopened >	forumTopicReopened
	Optional. Service message: forum topic reopened.

Ptr< GeneralForumTopicHidden >	generalForumTopicHidden
	Optional. Service message: the 'General' forum topic hidden.

Ptr< GeneralForumTopicUnhidden >	generalForumTopicUnhidden
	Optional. Service message: the 'General' forum topic unhidden.

Ptr< GiveawayCreated >	giveawayCreated {}
	Optional. Service message: a scheduled giveaway was created.

Ptr< Giveaway >	giveaway
	Optional. The message is a scheduled giveaway message.

Ptr< GiveawayWinners >	giveawayWinners
	Optional. A giveaway with public winners was completed.

Ptr< GiveawayCompleted >	giveawayCompleted {}
	Optional. Service message: a giveaway without public winners was completed.

Ptr< PaidMessagePriceChanged >	paidMessagePriceChanged {}
	Optional. Service message: the price for paid messages has changed in the chat.

Ptr< SuggestedPostApproved >	suggestedPostApproved {}
	Optional. Service message: a suggested post was approved.

Ptr< SuggestedPostApprovalFailed >	suggestedPostApprovalFailed {}
	Optional. Service message: approval of a suggested post has failed.

Ptr< SuggestedPostDeclined >	suggestedPostDeclined {}
	Optional. Service message: a suggested post was declined.

Ptr< SuggestedPostPaid >	suggestedPostPaid {}
	Optional. Service message: payment for a suggested post was received.

Ptr< SuggestedPostRefunded >	suggestedPostRefunded {}
	Optional. Service message: payment for a suggested post was refunded.

Ptr< VideoChatScheduled >	videoChatScheduled
	Optional. Service message: video chat scheduled.

Ptr< VideoChatStarted >	videoChatStarted
	Optional. Service message: video chat started.

Ptr< VideoChatEnded >	videoChatEnded
	Optional. Service message: video chat ended.

Ptr< VideoChatParticipantsInvited >	videoChatParticipantsInvited
	Optional. Service message: new participants invited to a video chat.

Ptr< WebAppData >	webAppData
	Optional. Service message: data sent by a Web App.

Ptr< InlineKeyboardMarkup >	replyMarkup
	Optional. Inline keyboard attached to the message. `login_url` buttons are represented as ordinary `url` buttons.

Detailed Description

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

Definition at line 74 of file Message.hpp.

Constructor & Destructor Documentation

◆ Message() [1/2]

tgbotxx::Message::Message ( )

default

◆ Message() [2/2]

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

inlineexplicit

Definition at line 76 of file Message.hpp.

Member Function Documentation

◆ fromJson()

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

Deserializes this object from JSON.

◆ toJson()

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

Serializes this object to JSON.

Returns: JSON representation of this object

Member Data Documentation

◆ animation

Ptr<Animation> tgbotxx::Message::animation

Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.

Definition at line 187 of file Message.hpp.

◆ audio

Ptr<Audio> tgbotxx::Message::audio

Optional. Message is an audio file, information about the file.

Definition at line 190 of file Message.hpp.

◆ authorSignature

std::string tgbotxx::Message::authorSignature

Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator.

Definition at line 165 of file Message.hpp.

◆ boostAdded

Ptr<ChatBoostAdded> tgbotxx::Message::boostAdded {}

Optional. Service message: user boosted the chat.

Definition at line 342 of file Message.hpp.

◆ businessConnectionId

std::string tgbotxx::Message::businessConnectionId

Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

Definition at line 114 of file Message.hpp.

◆ caption

std::string tgbotxx::Message::caption

Optional. Caption for the animation, audio, document, photo, video or voice.

Definition at line 214 of file Message.hpp.

◆ captionEntities

std::vector<Ptr<MessageEntity> > tgbotxx::Message::captionEntities

Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption.

Definition at line 217 of file Message.hpp.

◆ channelChatCreated

bool tgbotxx::Message::channelChatCreated {}

Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.

Definition at line 280 of file Message.hpp.

◆ chat

Ptr<Chat> tgbotxx::Message::chat

Conversation the message belongs to.

Definition at line 117 of file Message.hpp.

◆ chatBackgroundSet

Ptr<ChatBackground> tgbotxx::Message::chatBackgroundSet {}

Optional. Service message: chat background set.

Definition at line 345 of file Message.hpp.

◆ chatOwnerChanged

Ptr<ChatOwnerChanged> tgbotxx::Message::chatOwnerChanged

Optional. Service message: chat owner has changed.

Definition at line 258 of file Message.hpp.

◆ chatOwnerLeft

Ptr<ChatOwnerLeft> tgbotxx::Message::chatOwnerLeft

Optional. Service message: chat owner has left.

Definition at line 255 of file Message.hpp.

◆ chatShared

Ptr<ChatShared> tgbotxx::Message::chatShared

Optional. Service message: a chat was shared with the bot.

Definition at line 316 of file Message.hpp.

◆ checklist

Ptr<Checklist> tgbotxx::Message::checklist

Optional. Message is a checklist.

Definition at line 226 of file Message.hpp.

◆ checklistTasksAdded

Ptr<ChecklistTasksAdded> tgbotxx::Message::checklistTasksAdded

Optional. Service message: tasks were added to a checklist.

Definition at line 351 of file Message.hpp.

◆ checklistTasksDone

Ptr<ChecklistTasksDone> tgbotxx::Message::checklistTasksDone

Optional. Service message: some tasks in a checklist were marked as done or not done.

Definition at line 348 of file Message.hpp.

◆ connectedWebsite

std::string tgbotxx::Message::connectedWebsite

Optional. The domain name of the website on which the user has logged in. about Telegram Login » https://core.telegram.org/widgets/login .

Definition at line 329 of file Message.hpp.

◆ contact

Ptr<Contact> tgbotxx::Message::contact

Optional. Message is a shared contact, information about the contact.

Definition at line 229 of file Message.hpp.

◆ date

std::time_t tgbotxx::Message::date {}

Date the message was sent in Unix time. It is always a positive number, representing a valid date.

Definition at line 109 of file Message.hpp.

◆ deleteChatPhoto

bool tgbotxx::Message::deleteChatPhoto {}

Optional. Service message: the chat photo was deleted.

Definition at line 267 of file Message.hpp.

◆ dice

Ptr<Dice> tgbotxx::Message::dice

Optional. Message is a dice with random value.

Definition at line 232 of file Message.hpp.

◆ directMessagePriceChanged

Ptr<DirectMessagePriceChanged> tgbotxx::Message::directMessagePriceChanged {}

Optional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed.

Definition at line 354 of file Message.hpp.

◆ directMessagesTopic

Ptr<DirectMessagesTopic> tgbotxx::Message::directMessagesTopic

Optional. Information about the direct messages chat topic that contains the message.

Definition at line 87 of file Message.hpp.

◆ document

Ptr<Document> tgbotxx::Message::document

Optional. Message is a general file, information about the file.

Definition at line 193 of file Message.hpp.

◆ editDate

std::time_t tgbotxx::Message::editDate {}

Optional. Date the message was last edited in Unix time.

Definition at line 149 of file Message.hpp.

◆ effectId

std::string tgbotxx::Message::effectId

Optional. Unique identifier of the message effect added to the message.

Definition at line 183 of file Message.hpp.

◆ entities

std::vector<Ptr<MessageEntity> > tgbotxx::Message::entities

Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.

Definition at line 174 of file Message.hpp.

◆ externalReply

Ptr<ExternalReplyInfo> tgbotxx::Message::externalReply

Optional. Information about the message that is being replied to, which may come from another chat or forum topic.

Definition at line 134 of file Message.hpp.

◆ forumTopicClosed

Ptr<ForumTopicClosed> tgbotxx::Message::forumTopicClosed

Optional. Service message: forum topic closed.

Definition at line 363 of file Message.hpp.

◆ forumTopicCreated

Ptr<ForumTopicCreated> tgbotxx::Message::forumTopicCreated

Optional. Service message: forum topic created.

Definition at line 357 of file Message.hpp.

◆ forumTopicEdited

Ptr<ForumTopicEdited> tgbotxx::Message::forumTopicEdited

Optional. Service message: forum topic edited.

Definition at line 360 of file Message.hpp.

◆ forumTopicReopened

Ptr<ForumTopicReopened> tgbotxx::Message::forumTopicReopened

Optional. Service message: forum topic reopened.

Definition at line 366 of file Message.hpp.

◆ forwardOrigin

Ptr<MessageOrigin> tgbotxx::Message::forwardOrigin

Optional. Information about the original message for forwarded messages.

Definition at line 120 of file Message.hpp.

◆ from

Ptr<User> tgbotxx::Message::from

Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

Definition at line 91 of file Message.hpp.

◆ game

Ptr<Game> tgbotxx::Message::game

Optional. Message is a game, information about the game. about games » https://core.telegram.org/bots/api#games .

Definition at line 236 of file Message.hpp.

◆ generalForumTopicHidden

Ptr<GeneralForumTopicHidden> tgbotxx::Message::generalForumTopicHidden

Optional. Service message: the 'General' forum topic hidden.

Definition at line 369 of file Message.hpp.

◆ generalForumTopicUnhidden

Ptr<GeneralForumTopicUnhidden> tgbotxx::Message::generalForumTopicUnhidden

Optional. Service message: the 'General' forum topic unhidden.

Definition at line 372 of file Message.hpp.

◆ gift

Ptr<GiftInfo> tgbotxx::Message::gift {}

Optional. Service message: a regular gift was sent or received.

Definition at line 319 of file Message.hpp.

◆ giftUpgradeSent

Ptr<GiftInfo> tgbotxx::Message::giftUpgradeSent {}

Optional. Service message: upgrade of a gift was purchased after the gift was sent.

Definition at line 325 of file Message.hpp.

◆ giveaway

Ptr<Giveaway> tgbotxx::Message::giveaway

Optional. The message is a scheduled giveaway message.

Definition at line 378 of file Message.hpp.

◆ giveawayCompleted

Ptr<GiveawayCompleted> tgbotxx::Message::giveawayCompleted {}

Optional. Service message: a giveaway without public winners was completed.

Definition at line 384 of file Message.hpp.

◆ giveawayCreated

Ptr<GiveawayCreated> tgbotxx::Message::giveawayCreated {}

Optional. Service message: a scheduled giveaway was created.

Definition at line 375 of file Message.hpp.

◆ giveawayWinners

Ptr<GiveawayWinners> tgbotxx::Message::giveawayWinners

Optional. A giveaway with public winners was completed.

Definition at line 381 of file Message.hpp.

◆ groupChatCreated

bool tgbotxx::Message::groupChatCreated {}

Optional. Service message: the group has been created.

Definition at line 270 of file Message.hpp.

◆ hasMediaSpoiler

bool tgbotxx::Message::hasMediaSpoiler {}

Optional. True, if the message media is covered by a spoiler animation.

Definition at line 223 of file Message.hpp.

◆ hasProtectedContent

bool tgbotxx::Message::hasProtectedContent {}

Optional. True, if the message can't be forwarded.

Definition at line 152 of file Message.hpp.

◆ invoice

Ptr<Invoice> tgbotxx::Message::invoice

Optional. Message is an invoice for a payment, information about the invoice. about payments » https://core.telegram.org/bots/api#payments .

Definition at line 302 of file Message.hpp.

◆ isAutomaticForward

bool tgbotxx::Message::isAutomaticForward {}

Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group.

Definition at line 127 of file Message.hpp.

◆ isFromOffline

bool tgbotxx::Message::isFromOffline {}

Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message.

Definition at line 155 of file Message.hpp.

◆ isPaidPost

bool tgbotxx::Message::isPaidPost {}

Optional. True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.

Definition at line 158 of file Message.hpp.

◆ isTopicMessage

bool tgbotxx::Message::isTopicMessage {}

Optional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot.

Definition at line 123 of file Message.hpp.

◆ leftChatMember

Ptr<User> tgbotxx::Message::leftChatMember

Optional. A member was removed from the group, information about them (this member may be the bot itself)

Definition at line 252 of file Message.hpp.

◆ linkPreviewOptions

Ptr<LinkPreviewOptions> tgbotxx::Message::linkPreviewOptions

Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed.

Definition at line 177 of file Message.hpp.

◆ location

Ptr<Location> tgbotxx::Message::location

Optional. Message is a shared location, information about the location.

Definition at line 246 of file Message.hpp.

◆ mediaGroupId

std::string tgbotxx::Message::mediaGroupId

Optional. The unique identifier of a media message group this message belongs to.

Definition at line 161 of file Message.hpp.

◆ messageAutoDeleteTimerChanged

Ptr<MessageAutoDeleteTimerChanged> tgbotxx::Message::messageAutoDeleteTimerChanged

Optional. Service message: auto-delete timer settings changed in the chat.

Definition at line 283 of file Message.hpp.

◆ messageId

std::int32_t tgbotxx::Message::messageId {}

Unique message identifier inside this chat.

Definition at line 81 of file Message.hpp.

◆ messageThreadId

std::int32_t tgbotxx::Message::messageThreadId {}

Optional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only.

Definition at line 84 of file Message.hpp.

◆ migrateFromChatId

std::int64_t tgbotxx::Message::migrateFromChatId {}

Optional. The supergroup has been migrated from a group with the specified identifier. 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 295 of file Message.hpp.

◆ migrateToChatId

std::int64_t tgbotxx::Message::migrateToChatId {}

Optional. The group has been migrated to a supergroup with the specified identifier. 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 289 of file Message.hpp.

◆ newChatMembers

std::vector<Ptr<User> > tgbotxx::Message::newChatMembers

Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

Definition at line 249 of file Message.hpp.

◆ newChatPhoto

std::vector<Ptr<PhotoSize> > tgbotxx::Message::newChatPhoto

Optional. A chat photo was change to this value.

Definition at line 264 of file Message.hpp.

◆ newChatTitle

std::string tgbotxx::Message::newChatTitle

Optional. A chat title was changed to this value.

Definition at line 261 of file Message.hpp.

◆ paidMessagePriceChanged

Ptr<PaidMessagePriceChanged> tgbotxx::Message::paidMessagePriceChanged {}

Optional. Service message: the price for paid messages has changed in the chat.

Definition at line 387 of file Message.hpp.

◆ paidStarCount

std::int64_t tgbotxx::Message::paidStarCount {}

Optional. The number of Telegram Stars that were paid by the sender of the message to send it.

Definition at line 168 of file Message.hpp.

◆ passportData

Ptr<PassportData> tgbotxx::Message::passportData

Optional. Telegram Passport data.

Definition at line 336 of file Message.hpp.

◆ photo

std::vector<Ptr<PhotoSize> > tgbotxx::Message::photo

Optional. Message is a photo, available sizes of the photo.

Definition at line 196 of file Message.hpp.

◆ pinnedMessage

MaybeInaccessibleMessage tgbotxx::Message::pinnedMessage {}

Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

Definition at line 298 of file Message.hpp.

◆ poll

Ptr<Poll> tgbotxx::Message::poll

Optional. Message is a native poll, information about the poll.

Definition at line 239 of file Message.hpp.

◆ proximityAlertTriggered

Ptr<ProximityAlertTriggered> tgbotxx::Message::proximityAlertTriggered

Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.

Definition at line 339 of file Message.hpp.

◆ quote

Ptr<TextQuote> tgbotxx::Message::quote {}

Optional. For replies that quote part of the original message, the quoted part of the message.

Definition at line 137 of file Message.hpp.

◆ refundedPayment

Ptr<RefundedPayment> tgbotxx::Message::refundedPayment {}

Optional. Message is a service message about a refunded payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .

Definition at line 310 of file Message.hpp.

◆ replyMarkup

Ptr<InlineKeyboardMarkup> tgbotxx::Message::replyMarkup

Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.

Definition at line 420 of file Message.hpp.

◆ replyToChecklistTaskId

std::int32_t tgbotxx::Message::replyToChecklistTaskId {}

Optional. Identifier of the specific checklist task that is being replied to.

Definition at line 143 of file Message.hpp.

◆ replyToMessage

Ptr<Message> tgbotxx::Message::replyToMessage

Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

Definition at line 131 of file Message.hpp.

◆ replyToStory

Ptr<Story> tgbotxx::Message::replyToStory

Optional. For replies to a story, the original story.

Definition at line 140 of file Message.hpp.

◆ senderBoostCount

std::int32_t tgbotxx::Message::senderBoostCount {}

Optional. If the sender of the message boosted the chat, the number of boosts added by the user.

Definition at line 100 of file Message.hpp.

◆ senderBusinessBot

Ptr<User> tgbotxx::Message::senderBusinessBot

Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.

Definition at line 103 of file Message.hpp.

◆ senderChat

Ptr<Chat> tgbotxx::Message::senderChat

Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

Definition at line 97 of file Message.hpp.

◆ senderTag

std::string tgbotxx::Message::senderTag

Optional. Tag or custom title of the sender of the message; for supergroups only.

Definition at line 106 of file Message.hpp.

◆ showCaptionAboveMedia

bool tgbotxx::Message::showCaptionAboveMedia {}

Optional. True, if the caption must be shown above the message media.

Definition at line 220 of file Message.hpp.

◆ sticker

Ptr<Sticker> tgbotxx::Message::sticker

Optional. Message is a sticker, information about the sticker.

Definition at line 199 of file Message.hpp.

◆ story

Ptr<Story> tgbotxx::Message::story

Optional. Message is a forwarded story.

Definition at line 202 of file Message.hpp.

◆ successfulPayment

Ptr<SuccessfulPayment> tgbotxx::Message::successfulPayment

Optional. Message is a service message about a successful payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .

Definition at line 306 of file Message.hpp.

◆ suggestedPostApprovalFailed

Ptr<SuggestedPostApprovalFailed> tgbotxx::Message::suggestedPostApprovalFailed {}

Optional. Service message: approval of a suggested post has failed.

Definition at line 393 of file Message.hpp.

◆ suggestedPostApproved

Ptr<SuggestedPostApproved> tgbotxx::Message::suggestedPostApproved {}

Optional. Service message: a suggested post was approved.

Definition at line 390 of file Message.hpp.

◆ suggestedPostDeclined

Ptr<SuggestedPostDeclined> tgbotxx::Message::suggestedPostDeclined {}

Optional. Service message: a suggested post was declined.

Definition at line 396 of file Message.hpp.

◆ suggestedPostInfo

Ptr<SuggestedPostInfo> tgbotxx::Message::suggestedPostInfo {}

Optional. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.

Definition at line 180 of file Message.hpp.

◆ suggestedPostPaid

Ptr<SuggestedPostPaid> tgbotxx::Message::suggestedPostPaid {}

Optional. Service message: payment for a suggested post was received.

Definition at line 399 of file Message.hpp.

◆ suggestedPostRefunded

Ptr<SuggestedPostRefunded> tgbotxx::Message::suggestedPostRefunded {}

Optional. Service message: payment for a suggested post was refunded.

Definition at line 402 of file Message.hpp.

◆ supergroupChatCreated

bool tgbotxx::Message::supergroupChatCreated {}

Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

Definition at line 275 of file Message.hpp.

◆ text

std::string tgbotxx::Message::text

Optional. For text messages, the actual UTF-8 text of the message.

Definition at line 171 of file Message.hpp.

◆ uniqueGift

Ptr<UniqueGiftInfo> tgbotxx::Message::uniqueGift {}

Optional. Service message: a unique gift was sent or received.

Definition at line 322 of file Message.hpp.

◆ usersShared

Ptr<UsersShared> tgbotxx::Message::usersShared

Optional. Service message: users were shared with the bot.

Definition at line 313 of file Message.hpp.

◆ venue

Ptr<Venue> tgbotxx::Message::venue

Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.

Definition at line 243 of file Message.hpp.

◆ viaBot

Ptr<User> tgbotxx::Message::viaBot

Optional. Bot through which the message was sent.

Definition at line 146 of file Message.hpp.

◆ video

Ptr<Video> tgbotxx::Message::video

Optional. Message is a video, information about the video.

Definition at line 205 of file Message.hpp.

◆ videoChatEnded

Ptr<VideoChatEnded> tgbotxx::Message::videoChatEnded

Optional. Service message: video chat ended.

Definition at line 411 of file Message.hpp.

◆ videoChatParticipantsInvited

Ptr<VideoChatParticipantsInvited> tgbotxx::Message::videoChatParticipantsInvited

Optional. Service message: new participants invited to a video chat.

Definition at line 414 of file Message.hpp.

◆ videoChatScheduled

Ptr<VideoChatScheduled> tgbotxx::Message::videoChatScheduled

Optional. Service message: video chat scheduled.

Definition at line 405 of file Message.hpp.

◆ videoChatStarted

Ptr<VideoChatStarted> tgbotxx::Message::videoChatStarted

Optional. Service message: video chat started.

Definition at line 408 of file Message.hpp.

◆ videoNote

Ptr<VideoNote> tgbotxx::Message::videoNote

Optional. Message is a video note, information about the video message.

Definition at line 208 of file Message.hpp.

◆ voice

Ptr<Voice> tgbotxx::Message::voice

Optional. Message is a voice message, information about the file.

Definition at line 211 of file Message.hpp.

◆ webAppData

Ptr<WebAppData> tgbotxx::Message::webAppData

Optional. Service message: data sent by a Web App.

Definition at line 417 of file Message.hpp.

◆ writeAccessAllowed

Ptr<WriteAccessAllowed> tgbotxx::Message::writeAccessAllowed

Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

Definition at line 333 of file Message.hpp.

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

include/tgbotxx/objects/Message.hpp

Public Member Functions

Public Attributes