TDLib
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
message Class Referencefinal

Inherits Object.

Description

Describes a message.

Public Member Functions

 message ()
 message (int53 id_, object_ptr< MessageSender > &&sender_id_, object_ptr< MessageSender > &&receiver_id_, int53 chat_id_, object_ptr< MessageSendingState > &&sending_state_, object_ptr< MessageSchedulingState > &&scheduling_state_, bool is_outgoing_, bool is_pinned_, bool is_from_offline_, bool can_be_saved_, bool has_timestamped_media_, bool is_channel_post_, bool is_paid_star_suggested_post_, bool is_paid_gram_suggested_post_, bool contains_unread_mention_, bool contains_unread_poll_votes_, int32 date_, int32 edit_date_, object_ptr< messageForwardInfo > &&forward_info_, object_ptr< messageImportInfo > &&import_info_, object_ptr< messageInteractionInfo > &&interaction_info_, array< object_ptr< unreadReaction > > &&unread_reactions_, object_ptr< factCheck > &&fact_check_, object_ptr< suggestedPostInfo > &&suggested_post_info_, object_ptr< MessageReplyTo > &&reply_to_, object_ptr< MessageTopic > &&topic_id_, object_ptr< MessageSelfDestructType > &&self_destruct_type_, double self_destruct_in_, double auto_delete_in_, int53 via_bot_user_id_, object_ptr< MessageSender > &&guest_bot_caller_id_, int53 sender_business_bot_user_id_, int32 sender_boost_count_, string const &sender_tag_, int53 paid_message_star_count_, string const &author_signature_, int64 media_album_id_, int64 effect_id_, object_ptr< restrictionInfo > &&restriction_info_, string const &summary_language_code_, object_ptr< MessageContent > &&content_, object_ptr< ReplyMarkup > &&reply_markup_, int32 ephemeral_message_id_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

string author_signature_
 For channel posts and anonymous group messages, optional author signature.
double auto_delete_in_
 Time left before the message will be automatically deleted by message_auto_delete_time setting of the chat, in seconds; 0 if never.
bool can_be_saved_
 True, if content of the message can be saved locally.
int53 chat_id_
 Chat identifier.
bool contains_unread_mention_
 True, if the message contains an unread mention for the current user.
bool contains_unread_poll_votes_
 True, if the message is a poll message with unread votes.
object_ptr< MessageContent > content_
 Content of the message.
int32 date_
 Point in time (Unix timestamp) when the message was sent; 0 for scheduled messages.
int32 edit_date_
 Point in time (Unix timestamp) when the message was last edited; 0 for scheduled messages. If getOption("show_message_edit_date_by_default") is true, then the date must be shown along with the message instead of the date when the message was sent.
int64 effect_id_
 Unique identifier of the effect added to the message; 0 if none.
int32 ephemeral_message_id_
 Unique identifier of the ephemeral message if the message is ephemeral; for bots only.
object_ptr< factCheck > fact_check_
 Information about fact-check added to the message; may be null if none.
object_ptr< messageForwardInfo > forward_info_
 Information about the initial message sender; may be null if none or unknown.
object_ptr< MessageSender > guest_bot_caller_id_
 The identifier of the user or chat which used a guest bot to send the message; may be null if none.
bool has_timestamped_media_
 True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message.
int53 id_
 Message identifier; unique for the chat to which the message belongs.
object_ptr< messageImportInfo > import_info_
 Information about the initial message for messages created with importMessages; may be null if the message isn't imported.
object_ptr< messageInteractionInfo > interaction_info_
 Information about interactions with the message; may be null if none.
bool is_channel_post_
 True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts.
bool is_from_offline_
 True, if the message was sent because of a scheduled action by the message sender, for example, as away, or greeting service message.
bool is_outgoing_
 True, if the message is outgoing.
bool is_paid_gram_suggested_post_
 True, if the message is a suggested channel post which was paid in TON Grams; a warning must be shown if the message is deleted in less than getOption("suggested_post_lifetime_min") seconds after sending.
bool is_paid_star_suggested_post_
 True, if the message is a suggested channel post which was paid in Telegram Stars; a warning must be shown if the message is deleted in less than getOption("suggested_post_lifetime_min") seconds after sending.
bool is_pinned_
 True, if the message is pinned.
int64 media_album_id_
 Unique identifier of an album this message belongs to; 0 if none. Only audios, documents, photos and videos can be grouped together in albums.
int53 paid_message_star_count_
 The number of Telegram Stars the sender paid to send the message.
object_ptr< MessageSender > receiver_id_
 Identifier of the user or the chat which received the ephemeral message; may be null. Always null for non-ephemeral messages.
object_ptr< ReplyMarkup > reply_markup_
 Reply markup for the message; may be null if none.
object_ptr< MessageReplyTo > reply_to_
 Information about the message or the story this message is replying to; may be null if none.
object_ptr< restrictionInfo > restriction_info_
 Information about the restrictions that must be applied to the message content; may be null if none.
object_ptr< MessageSchedulingState > scheduling_state_
 The scheduling state of the message; may be null if the message isn't scheduled.
double self_destruct_in_
 Time left before the message self-destruct timer expires, in seconds; 0 if self-destruction isn't scheduled yet.
object_ptr< MessageSelfDestructType > self_destruct_type_
 The message's self-destruct type; may be null if none.
int32 sender_boost_count_
 Number of times the sender of the message boosted the supergroup at the time the message was sent; 0 if none or unknown. For messages sent by the current user, supergroupFullInfo.my_boost_count must be used instead.
int53 sender_business_bot_user_id_
 If non-zero, the user identifier of the business bot that sent this message.
object_ptr< MessageSender > sender_id_
 Identifier of the sender of the message.
string sender_tag_
 Tag of the sender of the message in the supergroup at the time the message was sent; may be empty if none or unknown. For messages sent in basic groups or supergroup administrators, the current custom title or tag must be used instead.
object_ptr< MessageSendingState > sending_state_
 The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent.
object_ptr< suggestedPostInfo > suggested_post_info_
 Information about the suggested post; may be null if the message isn't a suggested post.
string summary_language_code_
 IETF language tag of the message language on which it can be summarized; empty if summary isn't available for the message.
object_ptr< MessageTopic > topic_id_
 Identifier of the topic within the chat to which the message belongs; may be null if none; may change when the chat is converted to a forum or back.
array< object_ptr< unreadReaction > > unread_reactions_
 Information about unread reactions added to the message.
int53 via_bot_user_id_
 If non-zero, the user identifier of the inline bot through which this message was sent.

Static Public Attributes

static const std::int32_t ID = -1553901480
 Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

◆ message() [1/2]

message ( )

Describes a message.

◆ message() [2/2]

message ( int53 id_,
object_ptr< MessageSender > && sender_id_,
object_ptr< MessageSender > && receiver_id_,
int53 chat_id_,
object_ptr< MessageSendingState > && sending_state_,
object_ptr< MessageSchedulingState > && scheduling_state_,
bool is_outgoing_,
bool is_pinned_,
bool is_from_offline_,
bool can_be_saved_,
bool has_timestamped_media_,
bool is_channel_post_,
bool is_paid_star_suggested_post_,
bool is_paid_gram_suggested_post_,
bool contains_unread_mention_,
bool contains_unread_poll_votes_,
int32 date_,
int32 edit_date_,
object_ptr< messageForwardInfo > && forward_info_,
object_ptr< messageImportInfo > && import_info_,
object_ptr< messageInteractionInfo > && interaction_info_,
array< object_ptr< unreadReaction > > && unread_reactions_,
object_ptr< factCheck > && fact_check_,
object_ptr< suggestedPostInfo > && suggested_post_info_,
object_ptr< MessageReplyTo > && reply_to_,
object_ptr< MessageTopic > && topic_id_,
object_ptr< MessageSelfDestructType > && self_destruct_type_,
double self_destruct_in_,
double auto_delete_in_,
int53 via_bot_user_id_,
object_ptr< MessageSender > && guest_bot_caller_id_,
int53 sender_business_bot_user_id_,
int32 sender_boost_count_,
string const & sender_tag_,
int53 paid_message_star_count_,
string const & author_signature_,
int64 media_album_id_,
int64 effect_id_,
object_ptr< restrictionInfo > && restriction_info_,
string const & summary_language_code_,
object_ptr< MessageContent > && content_,
object_ptr< ReplyMarkup > && reply_markup_,
int32 ephemeral_message_id_ )

Describes a message.

Parameters
[in]id_Message identifier; unique for the chat to which the message belongs.
[in]sender_id_Identifier of the sender of the message.
[in]receiver_id_Identifier of the user or the chat which received the ephemeral message; may be null. Always null for non-ephemeral messages.
[in]chat_id_Chat identifier.
[in]sending_state_The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent.
[in]scheduling_state_The scheduling state of the message; may be null if the message isn't scheduled.
[in]is_outgoing_True, if the message is outgoing.
[in]is_pinned_True, if the message is pinned.
[in]is_from_offline_True, if the message was sent because of a scheduled action by the message sender, for example, as away, or greeting service message.
[in]can_be_saved_True, if content of the message can be saved locally.
[in]has_timestamped_media_True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message.
[in]is_channel_post_True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts.
[in]is_paid_star_suggested_post_True, if the message is a suggested channel post which was paid in Telegram Stars; a warning must be shown if the message is deleted in less than getOption("suggested_post_lifetime_min") seconds after sending.
[in]is_paid_gram_suggested_post_True, if the message is a suggested channel post which was paid in TON Grams; a warning must be shown if the message is deleted in less than getOption("suggested_post_lifetime_min") seconds after sending.
[in]contains_unread_mention_True, if the message contains an unread mention for the current user.
[in]contains_unread_poll_votes_True, if the message is a poll message with unread votes.
[in]date_Point in time (Unix timestamp) when the message was sent; 0 for scheduled messages.
[in]edit_date_Point in time (Unix timestamp) when the message was last edited; 0 for scheduled messages. If getOption("show_message_edit_date_by_default") is true, then the date must be shown along with the message instead of the date when the message was sent.
[in]forward_info_Information about the initial message sender; may be null if none or unknown.
[in]import_info_Information about the initial message for messages created with importMessages; may be null if the message isn't imported.
[in]interaction_info_Information about interactions with the message; may be null if none.
[in]unread_reactions_Information about unread reactions added to the message.
[in]fact_check_Information about fact-check added to the message; may be null if none.
[in]suggested_post_info_Information about the suggested post; may be null if the message isn't a suggested post.
[in]reply_to_Information about the message or the story this message is replying to; may be null if none.
[in]topic_id_Identifier of the topic within the chat to which the message belongs; may be null if none; may change when the chat is converted to a forum or back.
[in]self_destruct_type_The message's self-destruct type; may be null if none.
[in]self_destruct_in_Time left before the message self-destruct timer expires, in seconds; 0 if self-destruction isn't scheduled yet.
[in]auto_delete_in_Time left before the message will be automatically deleted by message_auto_delete_time setting of the chat, in seconds; 0 if never.
[in]via_bot_user_id_If non-zero, the user identifier of the inline bot through which this message was sent.
[in]guest_bot_caller_id_The identifier of the user or chat which used a guest bot to send the message; may be null if none.
[in]sender_business_bot_user_id_If non-zero, the user identifier of the business bot that sent this message.
[in]sender_boost_count_Number of times the sender of the message boosted the supergroup at the time the message was sent; 0 if none or unknown. For messages sent by the current user, supergroupFullInfo.my_boost_count must be used instead.
[in]sender_tag_Tag of the sender of the message in the supergroup at the time the message was sent; may be empty if none or unknown. For messages sent in basic groups or supergroup administrators, the current custom title or tag must be used instead.
[in]paid_message_star_count_The number of Telegram Stars the sender paid to send the message.
[in]author_signature_For channel posts and anonymous group messages, optional author signature.
[in]media_album_id_Unique identifier of an album this message belongs to; 0 if none. Only audios, documents, photos and videos can be grouped together in albums.
[in]effect_id_Unique identifier of the effect added to the message; 0 if none.
[in]restriction_info_Information about the restrictions that must be applied to the message content; may be null if none.
[in]summary_language_code_IETF language tag of the message language on which it can be summarized; empty if summary isn't available for the message.
[in]content_Content of the message.
[in]reply_markup_Reply markup for the message; may be null if none.
[in]ephemeral_message_id_Unique identifier of the ephemeral message if the message is ephemeral; for bots only.

Member Function Documentation

◆ store()

void store ( TlStorerToString & s,
const char * field_name ) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0