List of all members | Public Fields | Public Instance Methods | Static Public Attributes
message Class Referencefinal

Inherits Object.

Description

Describes a message.

Public Fields

int53 id_
 Message identifier; unique for the chat to which the message belongs.
 
object_ptr< MessageSendersender_id_
 Identifier of the sender of the message.
 
int53 chat_id_
 Chat identifier.
 
object_ptr< MessageSendingStatesending_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< MessageSchedulingStatescheduling_state_
 The scheduling state of the message; may be null if the message isn't scheduled.
 
bool is_outgoing_
 True, if the message is outgoing.
 
bool is_pinned_
 True, if the message is pinned.
 
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 can_be_saved_
 True, if content of the message can be saved locally or copied using inputMessageForwarded or forwardMessages with copy options.
 
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.
 
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_topic_message_
 True, if the message is a forum topic message.
 
bool contains_unread_mention_
 True, if the message contains an unread mention for the current user.
 
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.
 
object_ptr< messageForwardInfoforward_info_
 Information about the initial message sender; may be null if none or unknown.
 
object_ptr< messageImportInfoimport_info_
 Information about the initial message for messages created with importMessages; may be null if the message isn't imported.
 
object_ptr< messageInteractionInfointeraction_info_
 Information about interactions with the message; may be null if none.
 
array< object_ptr< unreadReaction > > unread_reactions_
 Information about unread reactions added to the message.
 
object_ptr< factCheckfact_check_
 Information about fact-check added to the message; may be null if none.
 
object_ptr< MessageReplyToreply_to_
 Information about the message or the story this message is replying to; may be null if none.
 
int53 message_thread_id_
 If non-zero, the identifier of the message thread the message belongs to; unique within the chat to which the message belongs.
 
int53 saved_messages_topic_id_
 Identifier of the Saved Messages topic for the message; 0 for messages not from Saved Messages.
 
object_ptr< MessageSelfDestructTypeself_destruct_type_
 The message's self-destruct type; may be null if none.
 
double self_destruct_in_
 Time left before the message self-destruct timer expires, in seconds; 0 if self-destruction isn't scheduled yet.
 
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.
 
int53 via_bot_user_id_
 If non-zero, the user identifier of the inline bot through which this message was sent.
 
int53 sender_business_bot_user_id_
 If non-zero, the user identifier of the business bot that sent this message.
 
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.
 
string author_signature_
 For channel posts and anonymous group messages, optional author signature.
 
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.
 
int64 effect_id_
 Unique identifier of the effect added to the message; 0 if none.
 
bool has_sensitive_content_
 True, if media content of the message must be hidden with 18+ spoiler.
 
string restriction_reason_
 If non-empty, contains a human-readable description of the reason why access to this message must be restricted.
 
object_ptr< MessageContentcontent_
 Content of the message.
 
object_ptr< ReplyMarkupreply_markup_
 Reply markup for the message; may be null if none.
 

Public Instance Methods

 message ()
 
 message (int53 id_, object_ptr< MessageSender > &&sender_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_topic_message_, bool contains_unread_mention_, 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< MessageReplyTo > &&reply_to_, int53 message_thread_id_, int53 saved_messages_topic_id_, object_ptr< MessageSelfDestructType > &&self_destruct_type_, double self_destruct_in_, double auto_delete_in_, int53 via_bot_user_id_, int53 sender_business_bot_user_id_, int32 sender_boost_count_, string const &author_signature_, int64 media_album_id_, int64 effect_id_, bool has_sensitive_content_, string const &restriction_reason_, object_ptr< MessageContent > &&content_, object_ptr< ReplyMarkup > &&reply_markup_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = 1132260831
 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_,
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_topic_message_,
bool  contains_unread_mention_,
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< MessageReplyTo > &&  reply_to_,
int53  message_thread_id_,
int53  saved_messages_topic_id_,
object_ptr< MessageSelfDestructType > &&  self_destruct_type_,
double  self_destruct_in_,
double  auto_delete_in_,
int53  via_bot_user_id_,
int53  sender_business_bot_user_id_,
int32  sender_boost_count_,
string const &  author_signature_,
int64  media_album_id_,
int64  effect_id_,
bool  has_sensitive_content_,
string const &  restriction_reason_,
object_ptr< MessageContent > &&  content_,
object_ptr< ReplyMarkup > &&  reply_markup_ 
)

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]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 or copied using inputMessageForwarded or forwardMessages with copy options.
[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_topic_message_True, if the message is a forum topic message.
[in]contains_unread_mention_True, if the message contains an unread mention for the current user.
[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.
[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]reply_to_Information about the message or the story this message is replying to; may be null if none.
[in]message_thread_id_If non-zero, the identifier of the message thread the message belongs to; unique within the chat to which the message belongs.
[in]saved_messages_topic_id_Identifier of the Saved Messages topic for the message; 0 for messages not from Saved Messages.
[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]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]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]has_sensitive_content_True, if media content of the message must be hidden with 18+ spoiler.
[in]restriction_reason_If non-empty, contains a human-readable description of the reason why access to this message must be restricted.
[in]content_Content of the message.
[in]reply_markup_Reply markup for the message; may be null if none.

Method 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: