# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hydrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from io import BytesIO
from hydrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from hydrogram.raw.core import TLObject
from hydrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class Message(TLObject): # type: ignore
"""A message
Constructor of :obj:`~hydrogram.raw.base.Message`.
Details:
- Layer: ``181``
- ID: ``94345242``
Parameters:
id (``int`` ``32-bit``):
ID of the message
peer_id (:obj:`Peer <hydrogram.raw.base.Peer>`):
Peer ID, the chat where this message was sent
date (``int`` ``32-bit``):
Date of the message
message (``str``):
The message
out (``bool``, *optional*):
Is this an outgoing message
mentioned (``bool``, *optional*):
Whether we were mentioned in this message
media_unread (``bool``, *optional*):
Whether there are unread media attachments in this message
silent (``bool``, *optional*):
Whether this is a silent message (no notification triggered)
post (``bool``, *optional*):
Whether this is a channel post
from_scheduled (``bool``, *optional*):
Whether this is a scheduled message
legacy (``bool``, *optional*):
This is a legacy message: it has to be refetched with the new layer
edit_hide (``bool``, *optional*):
Whether the message should be shown as not modified to the user, even if an edit date is present
pinned (``bool``, *optional*):
Whether this message is pinned
noforwards (``bool``, *optional*):
Whether this message is protected and thus cannot be forwarded; clients should also prevent users from saving attached media (i.e. videos should only be streamed, photos should be kept in RAM, et cetera).
invert_media (``bool``, *optional*):
If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.
offline (``bool``, *optional*):
from_id (:obj:`Peer <hydrogram.raw.base.Peer>`, *optional*):
ID of the sender of the message
from_boosts_applied (``int`` ``32-bit``, *optional*):
saved_peer_id (:obj:`Peer <hydrogram.raw.base.Peer>`, *optional*):
Messages fetched from a saved messages dialog » will have peer=inputPeerSelf and the saved_peer_id flag set to the ID of the saved dialog.
fwd_from (:obj:`MessageFwdHeader <hydrogram.raw.base.MessageFwdHeader>`, *optional*):
Info about forwarded messages
via_bot_id (``int`` ``64-bit``, *optional*):
ID of the inline bot that generated the message
via_business_bot_id (``int`` ``64-bit``, *optional*):
reply_to (:obj:`MessageReplyHeader <hydrogram.raw.base.MessageReplyHeader>`, *optional*):
Reply information
media (:obj:`MessageMedia <hydrogram.raw.base.MessageMedia>`, *optional*):
Media attachment
reply_markup (:obj:`ReplyMarkup <hydrogram.raw.base.ReplyMarkup>`, *optional*):
Reply markup (bot/inline keyboards)
entities (List of :obj:`MessageEntity <hydrogram.raw.base.MessageEntity>`, *optional*):
Message entities for styled text
views (``int`` ``32-bit``, *optional*):
View count for channel posts
forwards (``int`` ``32-bit``, *optional*):
Forward counter
replies (:obj:`MessageReplies <hydrogram.raw.base.MessageReplies>`, *optional*):
Info about post comments (for channels) or message replies (for groups)
edit_date (``int`` ``32-bit``, *optional*):
Last edit date of this message
post_author (``str``, *optional*):
Name of the author of this message for channel posts (with signatures enabled)
grouped_id (``int`` ``64-bit``, *optional*):
Multiple media messages sent using messages.sendMultiMedia with the same grouped ID indicate an album or media group
reactions (:obj:`MessageReactions <hydrogram.raw.base.MessageReactions>`, *optional*):
Reactions to this message
restriction_reason (List of :obj:`RestrictionReason <hydrogram.raw.base.RestrictionReason>`, *optional*):
Contains the reason why access to this message must be restricted.
ttl_period (``int`` ``32-bit``, *optional*):
Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well.
quick_reply_shortcut_id (``int`` ``32-bit``, *optional*):
effect (``int`` ``64-bit``, *optional*):
factcheck (:obj:`FactCheck <hydrogram.raw.base.FactCheck>`, *optional*):
"""
__slots__: List[str] = ["id", "peer_id", "date", "message", "out", "mentioned", "media_unread", "silent", "post", "from_scheduled", "legacy", "edit_hide", "pinned", "noforwards", "invert_media", "offline", "from_id", "from_boosts_applied", "saved_peer_id", "fwd_from", "via_bot_id", "via_business_bot_id", "reply_to", "media", "reply_markup", "entities", "views", "forwards", "replies", "edit_date", "post_author", "grouped_id", "reactions", "restriction_reason", "ttl_period", "quick_reply_shortcut_id", "effect", "factcheck"]
ID = 0x94345242
QUALNAME = "types.Message"
def __init__(self, *, id: int, peer_id: "raw.base.Peer", date: int, message: str, out: Optional[bool] = None, mentioned: Optional[bool] = None, media_unread: Optional[bool] = None, silent: Optional[bool] = None, post: Optional[bool] = None, from_scheduled: Optional[bool] = None, legacy: Optional[bool] = None, edit_hide: Optional[bool] = None, pinned: Optional[bool] = None, noforwards: Optional[bool] = None, invert_media: Optional[bool] = None, offline: Optional[bool] = None, from_id: "raw.base.Peer" = None, from_boosts_applied: Optional[int] = None, saved_peer_id: "raw.base.Peer" = None, fwd_from: "raw.base.MessageFwdHeader" = None, via_bot_id: Optional[int] = None, via_business_bot_id: Optional[int] = None, reply_to: "raw.base.MessageReplyHeader" = None, media: "raw.base.MessageMedia" = None, reply_markup: "raw.base.ReplyMarkup" = None, entities: Optional[List["raw.base.MessageEntity"]] = None, views: Optional[int] = None, forwards: Optional[int] = None, replies: "raw.base.MessageReplies" = None, edit_date: Optional[int] = None, post_author: Optional[str] = None, grouped_id: Optional[int] = None, reactions: "raw.base.MessageReactions" = None, restriction_reason: Optional[List["raw.base.RestrictionReason"]] = None, ttl_period: Optional[int] = None, quick_reply_shortcut_id: Optional[int] = None, effect: Optional[int] = None, factcheck: "raw.base.FactCheck" = None) -> None:
self.id = id # int
self.peer_id = peer_id # Peer
self.date = date # int
self.message = message # string
self.out = out # flags.1?true
self.mentioned = mentioned # flags.4?true
self.media_unread = media_unread # flags.5?true
self.silent = silent # flags.13?true
self.post = post # flags.14?true
self.from_scheduled = from_scheduled # flags.18?true
self.legacy = legacy # flags.19?true
self.edit_hide = edit_hide # flags.21?true
self.pinned = pinned # flags.24?true
self.noforwards = noforwards # flags.26?true
self.invert_media = invert_media # flags.27?true
self.offline = offline # flags2.1?true
self.from_id = from_id # flags.8?Peer
self.from_boosts_applied = from_boosts_applied # flags.29?int
self.saved_peer_id = saved_peer_id # flags.28?Peer
self.fwd_from = fwd_from # flags.2?MessageFwdHeader
self.via_bot_id = via_bot_id # flags.11?long
self.via_business_bot_id = via_business_bot_id # flags2.0?long
self.reply_to = reply_to # flags.3?MessageReplyHeader
self.media = media # flags.9?MessageMedia
self.reply_markup = reply_markup # flags.6?ReplyMarkup
self.entities = entities # flags.7?Vector<MessageEntity>
self.views = views # flags.10?int
self.forwards = forwards # flags.10?int
self.replies = replies # flags.23?MessageReplies
self.edit_date = edit_date # flags.15?int
self.post_author = post_author # flags.16?string
self.grouped_id = grouped_id # flags.17?long
self.reactions = reactions # flags.20?MessageReactions
self.restriction_reason = restriction_reason # flags.22?Vector<RestrictionReason>
self.ttl_period = ttl_period # flags.25?int
self.quick_reply_shortcut_id = quick_reply_shortcut_id # flags.30?int
self.effect = effect # flags2.2?long
self.factcheck = factcheck # flags2.3?FactCheck
@staticmethod
def read(b: BytesIO, *args: Any) -> "Message":
flags = Int.read(b)
out = True if flags & (1 << 1) else False
mentioned = True if flags & (1 << 4) else False
media_unread = True if flags & (1 << 5) else False
silent = True if flags & (1 << 13) else False
post = True if flags & (1 << 14) else False
from_scheduled = True if flags & (1 << 18) else False
legacy = True if flags & (1 << 19) else False
edit_hide = True if flags & (1 << 21) else False
pinned = True if flags & (1 << 24) else False
noforwards = True if flags & (1 << 26) else False
invert_media = True if flags & (1 << 27) else False
flags2 = Int.read(b)
offline = True if flags2 & (1 << 1) else False
id = Int.read(b)
from_id = TLObject.read(b) if flags & (1 << 8) else None
from_boosts_applied = Int.read(b) if flags & (1 << 29) else None
peer_id = TLObject.read(b)
saved_peer_id = TLObject.read(b) if flags & (1 << 28) else None
fwd_from = TLObject.read(b) if flags & (1 << 2) else None
via_bot_id = Long.read(b) if flags & (1 << 11) else None
via_business_bot_id = Long.read(b) if flags2 & (1 << 0) else None
reply_to = TLObject.read(b) if flags & (1 << 3) else None
date = Int.read(b)
message = String.read(b)
media = TLObject.read(b) if flags & (1 << 9) else None
reply_markup = TLObject.read(b) if flags & (1 << 6) else None
entities = TLObject.read(b) if flags & (1 << 7) else []
views = Int.read(b) if flags & (1 << 10) else None
forwards = Int.read(b) if flags & (1 << 10) else None
replies = TLObject.read(b) if flags & (1 << 23) else None
edit_date = Int.read(b) if flags & (1 << 15) else None
post_author = String.read(b) if flags & (1 << 16) else None
grouped_id = Long.read(b) if flags & (1 << 17) else None
reactions = TLObject.read(b) if flags & (1 << 20) else None
restriction_reason = TLObject.read(b) if flags & (1 << 22) else []
ttl_period = Int.read(b) if flags & (1 << 25) else None
quick_reply_shortcut_id = Int.read(b) if flags & (1 << 30) else None
effect = Long.read(b) if flags2 & (1 << 2) else None
factcheck = TLObject.read(b) if flags2 & (1 << 3) else None
return Message(id=id, peer_id=peer_id, date=date, message=message, out=out, mentioned=mentioned, media_unread=media_unread, silent=silent, post=post, from_scheduled=from_scheduled, legacy=legacy, edit_hide=edit_hide, pinned=pinned, noforwards=noforwards, invert_media=invert_media, offline=offline, from_id=from_id, from_boosts_applied=from_boosts_applied, saved_peer_id=saved_peer_id, fwd_from=fwd_from, via_bot_id=via_bot_id, via_business_bot_id=via_business_bot_id, reply_to=reply_to, media=media, reply_markup=reply_markup, entities=entities, views=views, forwards=forwards, replies=replies, edit_date=edit_date, post_author=post_author, grouped_id=grouped_id, reactions=reactions, restriction_reason=restriction_reason, ttl_period=ttl_period, quick_reply_shortcut_id=quick_reply_shortcut_id, effect=effect, factcheck=factcheck)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 1) if self.out else 0
flags |= (1 << 4) if self.mentioned else 0
flags |= (1 << 5) if self.media_unread else 0
flags |= (1 << 13) if self.silent else 0
flags |= (1 << 14) if self.post else 0
flags |= (1 << 18) if self.from_scheduled else 0
flags |= (1 << 19) if self.legacy else 0
flags |= (1 << 21) if self.edit_hide else 0
flags |= (1 << 24) if self.pinned else 0
flags |= (1 << 26) if self.noforwards else 0
flags |= (1 << 27) if self.invert_media else 0
flags |= (1 << 8) if self.from_id is not None else 0
flags |= (1 << 29) if self.from_boosts_applied is not None else 0
flags |= (1 << 28) if self.saved_peer_id is not None else 0
flags |= (1 << 2) if self.fwd_from is not None else 0
flags |= (1 << 11) if self.via_bot_id is not None else 0
flags |= (1 << 3) if self.reply_to is not None else 0
flags |= (1 << 9) if self.media is not None else 0
flags |= (1 << 6) if self.reply_markup is not None else 0
flags |= (1 << 7) if self.entities else 0
flags |= (1 << 10) if self.views is not None else 0
flags |= (1 << 10) if self.forwards is not None else 0
flags |= (1 << 23) if self.replies is not None else 0
flags |= (1 << 15) if self.edit_date is not None else 0
flags |= (1 << 16) if self.post_author is not None else 0
flags |= (1 << 17) if self.grouped_id is not None else 0
flags |= (1 << 20) if self.reactions is not None else 0
flags |= (1 << 22) if self.restriction_reason else 0
flags |= (1 << 25) if self.ttl_period is not None else 0
flags |= (1 << 30) if self.quick_reply_shortcut_id is not None else 0
b.write(Int(flags))
flags2 = 0
flags2 |= (1 << 1) if self.offline else 0
flags2 |= (1 << 0) if self.via_business_bot_id is not None else 0
flags2 |= (1 << 2) if self.effect is not None else 0
flags2 |= (1 << 3) if self.factcheck is not None else 0
b.write(Int(flags2))
b.write(Int(self.id))
if self.from_id is not None:
b.write(self.from_id.write())
if self.from_boosts_applied is not None:
b.write(Int(self.from_boosts_applied))
b.write(self.peer_id.write())
if self.saved_peer_id is not None:
b.write(self.saved_peer_id.write())
if self.fwd_from is not None:
b.write(self.fwd_from.write())
if self.via_bot_id is not None:
b.write(Long(self.via_bot_id))
if self.via_business_bot_id is not None:
b.write(Long(self.via_business_bot_id))
if self.reply_to is not None:
b.write(self.reply_to.write())
b.write(Int(self.date))
b.write(String(self.message))
if self.media is not None:
b.write(self.media.write())
if self.reply_markup is not None:
b.write(self.reply_markup.write())
if self.entities is not None:
b.write(Vector(self.entities))
if self.views is not None:
b.write(Int(self.views))
if self.forwards is not None:
b.write(Int(self.forwards))
if self.replies is not None:
b.write(self.replies.write())
if self.edit_date is not None:
b.write(Int(self.edit_date))
if self.post_author is not None:
b.write(String(self.post_author))
if self.grouped_id is not None:
b.write(Long(self.grouped_id))
if self.reactions is not None:
b.write(self.reactions.write())
if self.restriction_reason is not None:
b.write(Vector(self.restriction_reason))
if self.ttl_period is not None:
b.write(Int(self.ttl_period))
if self.quick_reply_shortcut_id is not None:
b.write(Int(self.quick_reply_shortcut_id))
if self.effect is not None:
b.write(Long(self.effect))
if self.factcheck is not None:
b.write(self.factcheck.write())
return b.getvalue()