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

63 lines
2.2 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 import types
from pyrogram.scaffold import Scaffold
class GetCommonChats(Scaffold):
async def get_common_chats(self, user_id: Union[int, str]) -> list:
"""Get the common chats you have with a user.
Parameters:
user_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).
Returns:
List of :obj:`~pyrogram.types.Chat`: On success, a list of the common chats is returned.
Raises:
ValueError: If the user_id doesn't belong to a user.
Example:
.. code-block:: python
common = app.get_common_chats(user_id)
print(common)
"""
peer = await self.resolve_peer(user_id)
if isinstance(peer, raw.types.InputPeerUser):
r = await self.send(
raw.functions.messages.GetCommonChats(
user_id=peer,
max_id=0,
limit=100,
)
)
return types.List([types.Chat._parse_chat(self, x) for x in r.chats])
raise ValueError(f'The user_id "{user_id}" doesn\'t belong to a user')