Source code for pyrogram.methods.users.get_common_chats
# 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 raw, types, utils
class GetCommonChats:
async def get_common_chats(
self: pyrogram.Client, user_id: int | str, limit: int = 0
) -> list[types.Chat]:
"""Get the common chats you have with a user.
.. include:: /_includes/usable-by/users.rst
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).
limit (``int``, *optional*):
Limits the number of common chats to be retrieved.
By default, no limit is applied and all common chats are returned.
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 = await app.get_common_chats(user_id)
print(common)
"""
peer = await self.resolve_peer(user_id)
if isinstance(peer, (raw.types.InputPeerUser, raw.types.InputPeerUserFromMessage)):
total = limit or (1 << 31) - 1
chats = types.List()
max_id = 0
while len(chats) < total:
batch = min(100, total - len(chats))
r = await self.invoke(
raw.functions.messages.GetCommonChats(
user_id=utils.get_input_user(peer),
max_id=max_id,
limit=batch,
)
)
chats.extend(types.Chat._parse_chat(self, x) for x in r.chats)
if len(r.chats) < batch:
break
max_id = r.chats[-1].id
return chats
raise ValueError(f'The user_id "{user_id}" doesn\'t belong to a user')