tgbotxx 1.1.9.2
Telegram Bot C++ Library
Loading...
Searching...
No Matches
tgbotxx::Message Struct Reference

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 to which the message belongs; for supergroups only.
 
Ptr< DirectMessagesTopicdirectMessagesTopic
 Optional. Information about the direct messages chat topic that contains the message.
 
Ptr< Userfrom
 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< ChatsenderChat
 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< UsersenderBusinessBot
 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::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< Chatchat
 Conversation the message belongs to.
 
Ptr< MessageOriginforwardOrigin
 Optional. Information about the original message for forwarded messages.
 
bool isTopicMessage {}
 Optional. True, if the message is sent to a forum topic.
 
bool isAutomaticForward {}
 Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group.
 
Ptr< MessagereplyToMessage
 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< ExternalReplyInfoexternalReply
 Optional. Information about the message that is being replied to, which may come from another chat or forum topic.
 
Ptr< TextQuotequote {}
 Optional. For replies that quote part of the original message, the quoted part of the message.
 
Ptr< StoryreplyToStory
 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< UserviaBot
 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< LinkPreviewOptionslinkPreviewOptions
 Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed.
 
Ptr< SuggestedPostInfosuggestedPostInfo {}
 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< Animationanimation
 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< Audioaudio
 Optional. Message is an audio file, information about the file.
 
Ptr< Documentdocument
 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< Stickersticker
 Optional. Message is a sticker, information about the sticker.
 
Ptr< Storystory
 Optional. Message is a forwarded story.
 
Ptr< Videovideo
 Optional. Message is a video, information about the video.
 
Ptr< VideoNotevideoNote
 Optional. Message is a video note, information about the video message.
 
Ptr< Voicevoice
 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< Checklistchecklist
 Optional. Message is a checklist.
 
Ptr< Contactcontact
 Optional. Message is a shared contact, information about the contact.
 
Ptr< Dicedice
 Optional. Message is a dice with random value.
 
Ptr< Gamegame
 Optional. Message is a game, information about the game. about games » https://core.telegram.org/bots/api#games .
 
Ptr< Pollpoll
 Optional. Message is a native poll, information about the poll.
 
Ptr< Venuevenue
 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< Locationlocation
 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< UserleftChatMember
 Optional. A member was removed from the group, information about them (this member may be the bot itself)
 
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< MessageAutoDeleteTimerChangedmessageAutoDeleteTimerChanged
 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< Invoiceinvoice
 Optional. Message is an invoice for a payment, information about the invoice. about payments » https://core.telegram.org/bots/api#payments .
 
Ptr< SuccessfulPaymentsuccessfulPayment
 Optional. Message is a service message about a successful payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .
 
Ptr< RefundedPaymentrefundedPayment {}
 Optional. Message is a service message about a refunded payment, information about the payment. about payments » https://core.telegram.org/bots/api#payments .
 
Ptr< UsersSharedusersShared
 Optional. Service message: users were shared with the bot.
 
Ptr< ChatSharedchatShared
 Optional. Service message: a chat was shared with the bot.
 
Ptr< GiftInfogift {}
 Optional. Service message: a regular gift was sent or received.
 
Ptr< UniqueGiftInfouniqueGift {}
 Optional. Service message: a unique gift was sent or received.
 
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< WriteAccessAllowedwriteAccessAllowed
 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< PassportDatapassportData
 Optional. Telegram Passport data.
 
Ptr< ProximityAlertTriggeredproximityAlertTriggered
 Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
 
Ptr< ChatBoostAddedboostAdded {}
 Optional. Service message: user boosted the chat.
 
Ptr< ChatBackgroundchatBackgroundSet {}
 Optional. Service message: chat background set.
 
Ptr< ChecklistTasksDonechecklistTasksDone
 Optional. Service message: some tasks in a checklist were marked as done or not done.
 
Ptr< ChecklistTasksAddedchecklistTasksAdded
 Optional. Service message: tasks were added to a checklist.
 
Ptr< DirectMessagePriceChangeddirectMessagePriceChanged {}
 Optional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed.
 
Ptr< ForumTopicCreatedforumTopicCreated
 Optional. Service message: forum topic created.
 
Ptr< ForumTopicEditedforumTopicEdited
 Optional. Service message: forum topic edited.
 
Ptr< ForumTopicClosedforumTopicClosed
 Optional. Service message: forum topic closed.
 
Ptr< ForumTopicReopenedforumTopicReopened
 Optional. Service message: forum topic reopened.
 
Ptr< GeneralForumTopicHiddengeneralForumTopicHidden
 Optional. Service message: the 'General' forum topic hidden.
 
Ptr< GeneralForumTopicUnhiddengeneralForumTopicUnhidden
 Optional. Service message: the 'General' forum topic unhidden.
 
Ptr< GiveawayCreatedgiveawayCreated {}
 Optional. Service message: a scheduled giveaway was created.
 
Ptr< Giveawaygiveaway
 Optional. The message is a scheduled giveaway message.
 
Ptr< GiveawayWinnersgiveawayWinners
 Optional. A giveaway with public winners was completed.
 
Ptr< GiveawayCompletedgiveawayCompleted {}
 Optional. Service message: a giveaway without public winners was completed.
 
Ptr< PaidMessagePriceChangedpaidMessagePriceChanged {}
 Optional. Service message: the price for paid messages has changed in the chat.
 
Ptr< SuggestedPostApprovedsuggestedPostApproved {}
 Optional. Service message: a suggested post was approved.
 
Ptr< SuggestedPostApprovalFailedsuggestedPostApprovalFailed {}
 Optional. Service message: approval of a suggested post has failed.
 
Ptr< SuggestedPostDeclinedsuggestedPostDeclined {}
 Optional. Service message: a suggested post was declined.
 
Ptr< SuggestedPostPaidsuggestedPostPaid {}
 Optional. Service message: payment for a suggested post was received.
 
Ptr< SuggestedPostRefundedsuggestedPostRefunded {}
 Optional. Service message: payment for a suggested post was refunded.
 
Ptr< VideoChatScheduledvideoChatScheduled
 Optional. Service message: video chat scheduled.
 
Ptr< VideoChatStartedvideoChatStarted
 Optional. Service message: video chat started.
 
Ptr< VideoChatEndedvideoChatEnded
 Optional. Service message: video chat ended.
 
Ptr< VideoChatParticipantsInvitedvideoChatParticipantsInvited
 Optional. Service message: new participants invited to a video chat.
 
Ptr< WebAppDatawebAppData
 Optional. Service message: data sent by a Web App.
 
Ptr< InlineKeyboardMarkupreplyMarkup
 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 72 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 74 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 182 of file Message.hpp.

◆ audio

Ptr<Audio> tgbotxx::Message::audio

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

Definition at line 185 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 160 of file Message.hpp.

◆ boostAdded

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

Optional. Service message: user boosted the chat.

Definition at line 328 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 109 of file Message.hpp.

◆ caption

std::string tgbotxx::Message::caption

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

Definition at line 209 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 212 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 269 of file Message.hpp.

◆ chat

Ptr<Chat> tgbotxx::Message::chat

Conversation the message belongs to.

Definition at line 112 of file Message.hpp.

◆ chatBackgroundSet

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

Optional. Service message: chat background set.

Definition at line 331 of file Message.hpp.

◆ chatShared

Ptr<ChatShared> tgbotxx::Message::chatShared

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

Definition at line 305 of file Message.hpp.

◆ checklist

Ptr<Checklist> tgbotxx::Message::checklist

Optional. Message is a checklist.

Definition at line 221 of file Message.hpp.

◆ checklistTasksAdded

Ptr<ChecklistTasksAdded> tgbotxx::Message::checklistTasksAdded

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

Definition at line 337 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 334 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 315 of file Message.hpp.

◆ contact

Ptr<Contact> tgbotxx::Message::contact

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

Definition at line 224 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 104 of file Message.hpp.

◆ deleteChatPhoto

bool tgbotxx::Message::deleteChatPhoto {}

Optional. Service message: the chat photo was deleted.

Definition at line 256 of file Message.hpp.

◆ dice

Ptr<Dice> tgbotxx::Message::dice

Optional. Message is a dice with random value.

Definition at line 227 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 340 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 85 of file Message.hpp.

◆ document

Ptr<Document> tgbotxx::Message::document

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

Definition at line 188 of file Message.hpp.

◆ editDate

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

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

Definition at line 144 of file Message.hpp.

◆ effectId

std::string tgbotxx::Message::effectId

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

Definition at line 178 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 169 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 129 of file Message.hpp.

◆ forumTopicClosed

Ptr<ForumTopicClosed> tgbotxx::Message::forumTopicClosed

Optional. Service message: forum topic closed.

Definition at line 349 of file Message.hpp.

◆ forumTopicCreated

Ptr<ForumTopicCreated> tgbotxx::Message::forumTopicCreated

Optional. Service message: forum topic created.

Definition at line 343 of file Message.hpp.

◆ forumTopicEdited

Ptr<ForumTopicEdited> tgbotxx::Message::forumTopicEdited

Optional. Service message: forum topic edited.

Definition at line 346 of file Message.hpp.

◆ forumTopicReopened

Ptr<ForumTopicReopened> tgbotxx::Message::forumTopicReopened

Optional. Service message: forum topic reopened.

Definition at line 352 of file Message.hpp.

◆ forwardOrigin

Ptr<MessageOrigin> tgbotxx::Message::forwardOrigin

Optional. Information about the original message for forwarded messages.

Definition at line 115 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 89 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 231 of file Message.hpp.

◆ generalForumTopicHidden

Ptr<GeneralForumTopicHidden> tgbotxx::Message::generalForumTopicHidden

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

Definition at line 355 of file Message.hpp.

◆ generalForumTopicUnhidden

Ptr<GeneralForumTopicUnhidden> tgbotxx::Message::generalForumTopicUnhidden

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

Definition at line 358 of file Message.hpp.

◆ gift

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

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

Definition at line 308 of file Message.hpp.

◆ giveaway

Ptr<Giveaway> tgbotxx::Message::giveaway

Optional. The message is a scheduled giveaway message.

Definition at line 364 of file Message.hpp.

◆ giveawayCompleted

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

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

Definition at line 370 of file Message.hpp.

◆ giveawayCreated

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

Optional. Service message: a scheduled giveaway was created.

Definition at line 361 of file Message.hpp.

◆ giveawayWinners

Ptr<GiveawayWinners> tgbotxx::Message::giveawayWinners

Optional. A giveaway with public winners was completed.

Definition at line 367 of file Message.hpp.

◆ groupChatCreated

bool tgbotxx::Message::groupChatCreated {}

Optional. Service message: the group has been created.

Definition at line 259 of file Message.hpp.

◆ hasMediaSpoiler

bool tgbotxx::Message::hasMediaSpoiler {}

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

Definition at line 218 of file Message.hpp.

◆ hasProtectedContent

bool tgbotxx::Message::hasProtectedContent {}

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

Definition at line 147 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 291 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 122 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 150 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 153 of file Message.hpp.

◆ isTopicMessage

bool tgbotxx::Message::isTopicMessage {}

Optional. True, if the message is sent to a forum topic.

Definition at line 118 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 247 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 172 of file Message.hpp.

◆ location

Ptr<Location> tgbotxx::Message::location

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

Definition at line 241 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 156 of file Message.hpp.

◆ messageAutoDeleteTimerChanged

Ptr<MessageAutoDeleteTimerChanged> tgbotxx::Message::messageAutoDeleteTimerChanged

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

Definition at line 272 of file Message.hpp.

◆ messageId

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

Unique message identifier inside this chat.

Definition at line 79 of file Message.hpp.

◆ messageThreadId

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

Optional. Unique identifier of a message thread to which the message belongs; for supergroups only.

Definition at line 82 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 284 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 278 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 244 of file Message.hpp.

◆ newChatPhoto

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

Optional. A chat photo was change to this value.

Definition at line 253 of file Message.hpp.

◆ newChatTitle

std::string tgbotxx::Message::newChatTitle

Optional. A chat title was changed to this value.

Definition at line 250 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 373 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 163 of file Message.hpp.

◆ passportData

Ptr<PassportData> tgbotxx::Message::passportData

Optional. Telegram Passport data.

Definition at line 322 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 191 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 287 of file Message.hpp.

◆ poll

Ptr<Poll> tgbotxx::Message::poll

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

Definition at line 234 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 325 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 132 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 299 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 406 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 138 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 126 of file Message.hpp.

◆ replyToStory

Ptr<Story> tgbotxx::Message::replyToStory

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

Definition at line 135 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 98 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 101 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 95 of file Message.hpp.

◆ showCaptionAboveMedia

bool tgbotxx::Message::showCaptionAboveMedia {}

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

Definition at line 215 of file Message.hpp.

◆ sticker

Ptr<Sticker> tgbotxx::Message::sticker

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

Definition at line 194 of file Message.hpp.

◆ story

Ptr<Story> tgbotxx::Message::story

Optional. Message is a forwarded story.

Definition at line 197 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 295 of file Message.hpp.

◆ suggestedPostApprovalFailed

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

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

Definition at line 379 of file Message.hpp.

◆ suggestedPostApproved

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

Optional. Service message: a suggested post was approved.

Definition at line 376 of file Message.hpp.

◆ suggestedPostDeclined

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

Optional. Service message: a suggested post was declined.

Definition at line 382 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 175 of file Message.hpp.

◆ suggestedPostPaid

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

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

Definition at line 385 of file Message.hpp.

◆ suggestedPostRefunded

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

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

Definition at line 388 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 264 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 166 of file Message.hpp.

◆ uniqueGift

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

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

Definition at line 311 of file Message.hpp.

◆ usersShared

Ptr<UsersShared> tgbotxx::Message::usersShared

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

Definition at line 302 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 238 of file Message.hpp.

◆ viaBot

Ptr<User> tgbotxx::Message::viaBot

Optional. Bot through which the message was sent.

Definition at line 141 of file Message.hpp.

◆ video

Ptr<Video> tgbotxx::Message::video

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

Definition at line 200 of file Message.hpp.

◆ videoChatEnded

Ptr<VideoChatEnded> tgbotxx::Message::videoChatEnded

Optional. Service message: video chat ended.

Definition at line 397 of file Message.hpp.

◆ videoChatParticipantsInvited

Ptr<VideoChatParticipantsInvited> tgbotxx::Message::videoChatParticipantsInvited

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

Definition at line 400 of file Message.hpp.

◆ videoChatScheduled

Ptr<VideoChatScheduled> tgbotxx::Message::videoChatScheduled

Optional. Service message: video chat scheduled.

Definition at line 391 of file Message.hpp.

◆ videoChatStarted

Ptr<VideoChatStarted> tgbotxx::Message::videoChatStarted

Optional. Service message: video chat started.

Definition at line 394 of file Message.hpp.

◆ videoNote

Ptr<VideoNote> tgbotxx::Message::videoNote

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

Definition at line 203 of file Message.hpp.

◆ voice

Ptr<Voice> tgbotxx::Message::voice

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

Definition at line 206 of file Message.hpp.

◆ webAppData

Ptr<WebAppData> tgbotxx::Message::webAppData

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

Definition at line 403 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 319 of file Message.hpp.


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