Source code for pyrogram.methods.chats.join_chat
# 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
class JoinChat:
async def join_chat(self: pyrogram.Client, chat_id: int | str) -> types.Chat:
"""Join a group chat or channel.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier for the target chat in form of a *t.me/joinchat/* link, a username of the target
channel/supergroup (in the format @username) or a chat id of a linked chat (channel or supergroup).
Returns:
:obj:`~pyrogram.types.Chat` | :obj:`~pyrogram.types.ChatJoinResult`: On success, a chat object is
returned. When a guard bot has to approve the join first, a
:obj:`~pyrogram.types.ChatJoinResultGuardBotApprovalRequired` is returned instead.
Example:
.. code-block:: python
# Join chat via invite link
await app.join_chat("https://t.me/+AbCdEf0123456789")
# Join chat via username
await app.join_chat("pyrogram")
# Join a linked chat
await app.join_chat(app.get_chat("pyrogram").linked_chat.id)
"""
match = self.INVITE_LINK_RE.match(str(chat_id))
if match:
r = await self.invoke(raw.functions.messages.ImportChatInvite(hash=match.group(1)))
else:
r = await self.invoke(
raw.functions.channels.JoinChannel(channel=await self.resolve_peer(chat_id))
)
if isinstance(r, raw.types.messages.ChatInviteJoinResultWebView):
return await types.ChatJoinResult._parse(self, r)
chat = r.updates if isinstance(r, raw.types.messages.ChatInviteJoinResultOk) else r
if isinstance(chat.chats[0], raw.types.Chat):
return types.Chat._parse_chat_chat(self, chat.chats[0])
return types.Chat._parse_channel_chat(self, chat.chats[0])