MTPyroger/pyrogram/methods/chats/get_chat_online_count.py
2022-01-07 10:23:45 +01:00

47 lines
1.6 KiB
Python

# 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 typing import Union
from pyrogram import raw
from pyrogram.scaffold import Scaffold
class GetChatOnlineCount(Scaffold):
async def get_chat_online_count(self, chat_id: Union[int, str]) -> int:
"""Get the number of members that are currently online in a chat.
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
Returns:
``int``: On success, the chat members online count is returned.
Example:
.. code-block:: python
online = app.get_chat_online_count(chat_id)
print(online)
"""
return (await self.send(
raw.functions.messages.GetOnlines(
peer=await self.resolve_peer(chat_id)
)
)).onlines