docs

SpEcHiDe · SpEcHiDe · commit 87a9cc23dcc2 · 2026-03-23T01:26:11.000+01:00
diff --git a/docs/source/releases/changes-in-this-fork.rst b/docs/source/releases/changes-in-this-fork.rst
@@ -32,6 +32,7 @@ Changes in this Fork
 | Scheme layer used: 223 |
 +------------------------+
 
+- Added the method :meth:`~pyrogram.Client.send_message_draft`, allowing bots to stream partial messages to a user while being generated. (contributed by @sudo-py-dev in `#231 <https://github.com/TelegramPlayground/pyrogram/pull/231>`__).
 - Added the :obj:`~pyrogram.types.MessageEntity` type :obj:`~pyrogram.enums.MessageEntityType.DATE_TIME`, allowing to show a formatted date and time to the user.
 - Added the fields ``chat_owner_left``, ``chat_owner_changed``, ``chat_has_protected_content_toggled`` and ``chat_has_protected_content_disable_requested`` to the class :obj:`~pyrogram.types.Message`.
 - Added the field ``can_edit_tag`` to the class :obj:`~pyrogram.types.ChatPermissions`.
diff --git a/pyrogram/methods/advanced/invoke.py b/pyrogram/methods/advanced/invoke.py
@@ -68,7 +68,7 @@ async def invoke(
             ``RawType``: The raw type response generated by the query.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         if not self.is_connected:
diff --git a/pyrogram/methods/advanced/save_file.py b/pyrogram/methods/advanced/save_file.py
@@ -90,7 +90,7 @@ async def save_file(
             ``InputFile``: On success, the uploaded file is returned in form of an InputFile object.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         if path is None:
diff --git a/pyrogram/methods/auth/accept_terms_of_service.py b/pyrogram/methods/auth/accept_terms_of_service.py
@@ -34,7 +34,7 @@ async def accept_terms_of_service(
                 The terms of service identifier.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         r = await self.invoke(
diff --git a/pyrogram/methods/auth/check_password.py b/pyrogram/methods/auth/check_password.py
@@ -44,7 +44,7 @@ async def check_password(
 
         Raises:
             BadRequest: In case the password is invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         r = await self.invoke(
diff --git a/pyrogram/methods/auth/get_active_sessions.py b/pyrogram/methods/auth/get_active_sessions.py
@@ -32,7 +32,7 @@ async def get_active_sessions(
             :obj:`~pyrogram.types.ActiveSessions`: On success, all the active sessions of the current user is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         r = await self.invoke(
diff --git a/pyrogram/methods/auth/get_password_hint.py b/pyrogram/methods/auth/get_password_hint.py
@@ -36,7 +36,7 @@ async def get_password_hint(
             ``str``: On success, the password hint as string is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         return (await self.invoke(raw.functions.account.GetPassword())).hint
diff --git a/pyrogram/methods/auth/log_out.py b/pyrogram/methods/auth/log_out.py
@@ -39,7 +39,7 @@ async def log_out(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/auth/recover_password.py b/pyrogram/methods/auth/recover_password.py
@@ -44,7 +44,7 @@ async def recover_password(
 
         Raises:
             BadRequest: In case the recovery code is invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         r = await self.invoke(
diff --git a/pyrogram/methods/auth/resend_code.py b/pyrogram/methods/auth/resend_code.py
@@ -51,7 +51,7 @@ async def resend_code(
 
         Raises:
             BadRequest: In case the arguments are invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         phone_number = phone_number.strip(" +")
diff --git a/pyrogram/methods/auth/send_code.py b/pyrogram/methods/auth/send_code.py
@@ -46,7 +46,7 @@ async def send_code(
 
         Raises:
             BadRequest: In case the phone number is invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         phone_number = phone_number.strip(" +")
diff --git a/pyrogram/methods/auth/sign_in.py b/pyrogram/methods/auth/sign_in.py
@@ -57,7 +57,7 @@ async def sign_in(
         Raises:
             BadRequest: In case the arguments are invalid.
             SessionPasswordNeeded: In case a password is needed to sign in.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         phone_number = phone_number.strip(" +")
diff --git a/pyrogram/methods/auth/sign_in_bot.py b/pyrogram/methods/auth/sign_in_bot.py
@@ -45,7 +45,7 @@ async def sign_in_bot(
 
         Raises:
             BadRequest: In case the bot token is invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         while True:
diff --git a/pyrogram/methods/auth/sign_up.py b/pyrogram/methods/auth/sign_up.py
@@ -55,7 +55,7 @@ async def sign_up(
 
         Raises:
             BadRequest: In case the arguments are invalid.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         phone_number = phone_number.strip(" +")
diff --git a/pyrogram/methods/auth/terminate_all_other_sessions.py b/pyrogram/methods/auth/terminate_all_other_sessions.py
@@ -32,7 +32,7 @@ async def terminate_all_other_sessions(
             ``bool``: On success, in case the session is destroyed, True is returned. Otherwise, False is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         return await self.invoke(
diff --git a/pyrogram/methods/auth/terminate_session.py b/pyrogram/methods/auth/terminate_session.py
@@ -37,7 +37,7 @@ async def terminate_session(
             ``bool``: On success, in case the session is destroyed, True is returned. Otherwise, False is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
         return await self.invoke(
diff --git a/pyrogram/methods/bots/answer_callback_query.py b/pyrogram/methods/bots/answer_callback_query.py
@@ -59,7 +59,7 @@ async def answer_callback_query(
             ``bool``: True, on success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/answer_inline_query.py b/pyrogram/methods/bots/answer_inline_query.py
@@ -84,7 +84,7 @@ async def answer_inline_query(
             ``bool``: True, on success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/answer_web_app_query.py b/pyrogram/methods/bots/answer_web_app_query.py
@@ -43,7 +43,7 @@ async def answer_web_app_query(
             :obj:`~pyrogram.types.SentWebAppMessage`: On success the sent web app message is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
 
diff --git a/pyrogram/methods/bots/delete_bot_commands.py b/pyrogram/methods/bots/delete_bot_commands.py
@@ -48,7 +48,7 @@ async def delete_bot_commands(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_bot_commands.py b/pyrogram/methods/bots/get_bot_commands.py
@@ -48,7 +48,7 @@ async def get_bot_commands(
             List of :obj:`~pyrogram.types.BotCommand`: On success, the list of bot commands is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_bot_default_privileges.py b/pyrogram/methods/bots/get_bot_default_privileges.py
@@ -41,7 +41,7 @@ async def get_bot_default_privileges(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_bot_info_description.py b/pyrogram/methods/bots/get_bot_info_description.py
@@ -48,7 +48,7 @@ async def get_bot_info_description(
             ``str``: On success, returns the text shown in the chat with a bot if the chat is empty in the given language.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_bot_info_short_description.py b/pyrogram/methods/bots/get_bot_info_short_description.py
@@ -48,7 +48,7 @@ async def get_bot_info_short_description(
             ``str``: On success, returns the text shown on a bot's profile page and sent together with the link when users share the bot in the given language.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_bot_name.py b/pyrogram/methods/bots/get_bot_name.py
@@ -45,7 +45,7 @@ async def get_bot_name(
                 The bot should have ``can_be_edited`` property set to True.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Returns:
             ``str``: On success, returns the name of a bot in the given language.
diff --git a/pyrogram/methods/bots/get_chat_menu_button.py b/pyrogram/methods/bots/get_chat_menu_button.py
@@ -38,7 +38,7 @@ async def get_chat_menu_button(
                 If not specified, default bot's menu button will be returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
 
diff --git a/pyrogram/methods/bots/get_game_high_scores.py b/pyrogram/methods/bots/get_game_high_scores.py
@@ -54,7 +54,7 @@ async def get_game_high_scores(
             List of :obj:`~pyrogram.types.GameHighScore`: On success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_inline_bot_results.py b/pyrogram/methods/bots/get_inline_bot_results.py
@@ -69,7 +69,7 @@ async def get_inline_bot_results(
 
         Raises:
             TimeoutError: In case the bot fails to answer within 10 seconds.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_owned_bots.py b/pyrogram/methods/bots/get_owned_bots.py
@@ -32,7 +32,7 @@ async def get_owned_bots(
             List of :obj:`~pyrogram.types.User`: On success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/get_similar_bots.py b/pyrogram/methods/bots/get_similar_bots.py
@@ -39,7 +39,7 @@ async def get_similar_bots(
             List of :obj:`~pyrogram.types.User`: On success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/request_callback_answer.py b/pyrogram/methods/bots/request_callback_answer.py
@@ -62,7 +62,7 @@ async def request_callback_answer(
         Raises:
             TimeoutError: In case the bot fails to answer within 10 seconds.
             ValueError: In case of invalid arguments.
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/send_game.py b/pyrogram/methods/bots/send_game.py
@@ -100,7 +100,7 @@ async def send_game(
             :obj:`~pyrogram.types.Message`: On success, the sent game message is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/send_inline_bot_result.py b/pyrogram/methods/bots/send_inline_bot_result.py
@@ -84,7 +84,7 @@ async def send_inline_bot_result(
             :obj:`~pyrogram.types.Message`: On success, the sent message is returned or False if no message was sent.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/send_web_app_custom_request.py b/pyrogram/methods/bots/send_web_app_custom_request.py
@@ -48,7 +48,7 @@ async def send_web_app_custom_request(
             ``str``: On success, a JSON-serialized result is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
 
diff --git a/pyrogram/methods/bots/set_bot_commands.py b/pyrogram/methods/bots/set_bot_commands.py
@@ -52,7 +52,7 @@ async def set_bot_commands(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/set_bot_default_privileges.py b/pyrogram/methods/bots/set_bot_default_privileges.py
@@ -46,7 +46,7 @@ async def set_bot_default_privileges(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/set_bot_info_description.py b/pyrogram/methods/bots/set_bot_info_description.py
@@ -52,7 +52,7 @@ async def set_bot_info_description(
             ``bool``: True on success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/set_bot_info_short_description.py b/pyrogram/methods/bots/set_bot_info_short_description.py
@@ -52,7 +52,7 @@ async def set_bot_info_short_description(
             ``bool``: True on success.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/bots/set_bot_name.py b/pyrogram/methods/bots/set_bot_name.py
@@ -49,7 +49,7 @@ async def set_bot_name(
                 The bot should have ``can_be_edited`` property set to True.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Returns:
             ``bool``: True on success.
diff --git a/pyrogram/methods/bots/set_chat_menu_button.py b/pyrogram/methods/bots/set_chat_menu_button.py
@@ -43,7 +43,7 @@ async def set_chat_menu_button(
                 Defaults to :obj:`~pyrogram.types.MenuButtonDefault`.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         """
 
diff --git a/pyrogram/methods/bots/set_game_score.py b/pyrogram/methods/bots/set_game_score.py
@@ -69,7 +69,7 @@ async def set_game_score(
             message is returned, True otherwise.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/chat_topics/toggle_forum_topic_is_pinned.py b/pyrogram/methods/chat_topics/toggle_forum_topic_is_pinned.py
@@ -46,7 +46,7 @@ async def toggle_forum_topic_is_pinned(
             ``bool``: On success, True is returned.
 
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/chats/add_profile_audio.py b/pyrogram/methods/chats/add_profile_audio.py
@@ -40,7 +40,7 @@ async def add_profile_audio(
             ``bool``: On success, True is returned.
         
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/chats/set_chat_direct_messages_group.py b/pyrogram/methods/chats/set_chat_direct_messages_group.py
@@ -50,7 +50,7 @@ async def set_chat_direct_messages_group(
             otherwise, in case a message object couldn't be returned, True is returned.
         
         Raises:
-            :doc:`RPCError <../../start/errors>`: In case of a Telegram RPC error.
+            :obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
 
         Example:
             .. code-block:: python
diff --git a/pyrogram/methods/chats/set_chat_protected_content.py b/pyrogram/methods/chats/set_chat_protected_content.py
diff --git a/pyrogram/methods/chats/transfer_chat_ownership.py b/pyrogram/methods/chats/transfer_chat_ownership.py
diff --git a/pyrogram/methods/messages/copy_message.py b/pyrogram/methods/messages/copy_message.py
diff --git a/pyrogram/methods/messages/download_media.py b/pyrogram/methods/messages/download_media.py
diff --git a/pyrogram/methods/stories/edit_story.py b/pyrogram/methods/stories/edit_story.py
diff --git a/pyrogram/methods/stories/hide_my_story_view.py b/pyrogram/methods/stories/hide_my_story_view.py
diff --git a/pyrogram/methods/stories/post_story.py b/pyrogram/methods/stories/post_story.py
diff --git a/pyrogram/types/authorization/active_session.py b/pyrogram/types/authorization/active_session.py
diff --git a/pyrogram/types/bots_and_keyboards/callback_query.py b/pyrogram/types/bots_and_keyboards/callback_query.py
diff --git a/pyrogram/types/inline_mode/chosen_inline_result.py b/pyrogram/types/inline_mode/chosen_inline_result.py
diff --git a/pyrogram/types/input_message_content/external_reply_info.py b/pyrogram/types/input_message_content/external_reply_info.py
diff --git a/pyrogram/types/messages_and_media/message.py b/pyrogram/types/messages_and_media/message.py
diff --git a/pyrogram/types/messages_and_media/poll.py b/pyrogram/types/messages_and_media/poll.py
diff --git a/pyrogram/types/stories/story.py b/pyrogram/types/stories/story.py
diff --git a/pyrogram/types/user_and_chats/chat.py b/pyrogram/types/user_and_chats/chat.py
diff --git a/pyrogram/types/user_and_chats/chat_join_request.py b/pyrogram/types/user_and_chats/chat_join_request.py
diff --git a/pyrogram/types/user_and_chats/user.py b/pyrogram/types/user_and_chats/user.py
