Source code for pyrogram.methods.messages.send_chat_action
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram 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.
#
# Pyrogram 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 Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import pyrogram
from pyrogram import enums, raw
class SendChatAction:
async def send_chat_action(
self: pyrogram.Client,
chat_id: int | str,
action: enums.ChatAction,
top_msg_id: int | None = None,
business_connection_id: str | None = None,
) -> bool:
"""Tell the other party that something is happening on your side.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
action (:obj:`~pyrogram.enums.ChatAction`):
Type of action to broadcast.
top_msg_id (``int``, *optional*):
Unique identifier of the forum topic the action is broadcast to.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection on behalf of which the action will be sent.
Returns:
``bool``: On success, True is returned.
Raises:
ValueError: In case the provided string is not a valid chat action.
Example:
.. code-block:: python
from pyrogram import enums
# Send "typing" chat action
await app.send_chat_action(chat_id, enums.ChatAction.TYPING)
# Send "upload_video" chat action
await app.send_chat_action(chat_id, enums.ChatAction.UPLOAD_VIDEO)
# Send "playing" chat action
await app.send_chat_action(chat_id, enums.ChatAction.PLAYING)
# Cancel any current chat action
await app.send_chat_action(chat_id, enums.ChatAction.CANCEL)
"""
action_name = action.name.lower()
if "upload" in action_name or "history" in action_name:
action = action.value(progress=0)
else:
action = action.value()
return await self.invoke(
raw.functions.messages.SetTyping(
peer=await self.resolve_peer(chat_id), action=action, top_msg_id=top_msg_id
),
business_connection_id=business_connection_id,
)