MessageEntity¶

class pyrogram.types.MessageEntity¶

One special entity in a text message.

For example, hashtags, usernames, URLs, etc.

Parameters:

type (MessageEntityType) – Type of the entity.
offset (int) – Offset in UTF-16 code units to the start of the entity.
length (int) – Length of the entity in UTF-16 code units.
url (str, optional) – For TEXT_LINK only, url that will be opened after user taps on the text.
user (User, optional) – For TEXT_MENTION only, the mentioned user.
language (str, optional) – For pre only, the programming language of the entity text.
custom_emoji_id (int, optional) – For CUSTOM_EMOJI only, unique identifier of the custom emoji. Use get_custom_emoji_stickers() to get full information about the sticker.
collapsed (bool, optional) – For BLOCKQUOTE only, whether the blockquote is expandable.
date (int, optional) – For FORMATTED_DATE only, the Unix timestamp of the date/time.
relative (bool, optional) – For FORMATTED_DATE only, show as relative time.
short_time (bool, optional) – For FORMATTED_DATE only, use short time format.
long_time (bool, optional) – For FORMATTED_DATE only, use long time format.
short_date (bool, optional) – For FORMATTED_DATE only, use short date format.
long_date (bool, optional) – For FORMATTED_DATE only, use long date format.
day_of_week (bool, optional) – For FORMATTED_DATE only, include day of week.
old_text (str, optional) – For DIFF_REPLACE only, the original text before replacement.