Add support for CUSTOM_EMOJI message entity type

delivrance · delivrance · commit cd69fb6d7619 · 2022-08-12T17:18:08.000+02:00
diff --git a/pyrogram/enums/message_entity_type.py b/pyrogram/enums/message_entity_type.py
@@ -77,5 +77,8 @@ class MessageEntityType(AutoName):
     BANK_CARD = raw.types.MessageEntityBankCard
     "Bank card text"
 
+    CUSTOM_EMOJI = raw.types.MessageEntityCustomEmoji
+    "Custom emoji"
+
     UNKNOWN = raw.types.MessageEntityUnknown
     "Unknown message entity type"
diff --git a/pyrogram/types/messages_and_media/message_entity.py b/pyrogram/types/messages_and_media/message_entity.py
@@ -40,13 +40,17 @@ class MessageEntity(Object):
             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.
+            For :obj:`~pyrogram.enums.MessageEntityType.TEXT_LINK` only, url that will be opened after user taps on the text.
 
         user (:obj:`~pyrogram.types.User`, *optional*):
-            For "text_mention" only, the mentioned user.
+            For :obj:`~pyrogram.enums.MessageEntityType.TEXT_MENTION` only, the mentioned user.
 
-        language (``str``. *optional*):
+        language (``str``, *optional*):
             For "pre" only, the programming language of the entity text.
+
+        custom_emoji_id (``int``, *optional*):
+            For :obj:`~pyrogram.enums.MessageEntityType.CUSTOM_EMOJI` only, unique identifier of the custom emoji.
+            Use :meth:`~pyrogram.Client.get_custom_emoji_stickers` to get full information about the sticker.
     """
 
     def __init__(
@@ -58,7 +62,8 @@ def __init__(
         length: int,
         url: str = None,
         user: "types.User" = None,
-        language: str = None
+        language: str = None,
+        custom_emoji_id: int = None
     ):
         super().__init__(client)
 
@@ -68,6 +73,7 @@ def __init__(
         self.url = url
         self.user = user
         self.language = language
+        self.custom_emoji_id = custom_emoji_id
 
     @staticmethod
     def _parse(client, entity: "raw.base.MessageEntity", users: dict) -> Optional["MessageEntity"]:
@@ -87,6 +93,7 @@ def _parse(client, entity: "raw.base.MessageEntity", users: dict) -> Optional["M
             url=getattr(entity, "url", None),
             user=types.User._parse(client, users.get(user_id, None)),
             language=getattr(entity, "language", None),
+            custom_emoji_id=getattr(entity, "document_id", None),
             client=client
         )
 
@@ -105,6 +112,9 @@ async def write(self):
         if self.language is None:
             args.pop("language")
 
+        if self.custom_emoji_id is None:
+            args.pop("custom_emoji_id")
+
         entity = self.type.value
 
         if entity is raw.types.MessageEntityMentionName:
