yasirarism/pyrofork
1
0
Fork 0
mirror of https://github.com/Mayuri-Chan/pyrofork.git synced 2026-01-09 08:14:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

pyrofork: Add example(s) to translate_message_text method

Browse source 
Signed-off-by: wulan17 <wulan17@nusantararom.org>
This commit is contained in:
wulan17 2024-09-02 20:23:19 +07:00
parent 755d23028b
commit d9c6286044
No known key found for this signature in database
GPG key ID: 318CD6CD3A6AC0A5
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
pyrogram/methods/messages/translate_text.py
View file

@ -56,6 +56,22 @@ class TranslateText:
entities (List of :obj:`~pyrogram.types.MessageEntity`): entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in message text, which can be specified instead of *parse_mode*. List of special entities that appear in message text, which can be specified instead of *parse_mode*.
Example:
.. code-block:: python
# Using chat_id and message_ids
await app.translate_message_text("en", chat_id, message_ids)
# Using text
await app.translate_message_text("en", text="Hello, how are you?")
# Using text with parse_mode
await app.translate_message_text("en", text="*Hello*, how are you?", parse_mode=ParseMode.MARKDOWN)
# Using text with entities
entities = [types.MessageEntityBold(offset=0, length=5)]
await app.translate_message_text("en", text="*Hello*, how are you?", entities=entities)
Returns: Returns:
:obj:`~pyrogram.types.TranslatedText` | List of :obj:`~pyrogram.types.TranslatedText`: In case *message_ids* was not :obj:`~pyrogram.types.TranslatedText` | List of :obj:`~pyrogram.types.TranslatedText`: In case *message_ids* was not
a list, a single result is returned, otherwise a list of results is returned. a list, a single result is returned, otherwise a list of results is returned.