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

55 lines
1.8 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 GetChatInviteLink(Scaffold):
async def get_chat_invite_link(
self,
chat_id: Union[int, str],
invite_link: str,
) -> "types.ChatInviteLink":
"""Get detailed information about a chat invite link.
Parameters:
chat_id (``int`` | ``str``):
Unique identifier for the target chat or username of the target channel/supergroup
(in the format @username).
invite_link (str):
The invite link.
Returns:
:obj:`~pyrogram.types.ChatInviteLink`: On success, the invite link is returned.
"""
r = await self.send(
raw.functions.messages.GetExportedChatInvite(
peer=await self.resolve_peer(chat_id),
link=invite_link
)
)
users = {i.id: i for i in r.users}
return types.ChatInviteLink._parse(self, r.invite, users)