ee5f39374c
* Add new invite link export methods * Implement higher-level Invite type * Update Docstrings and rename Invite * Docstrings are now more consistent with other methods * Invite is now InviteLink to be less arbitrary * Add method to get exported links * `get_exported_chat_invites` * prepare `__init__` for the other InvitesV2 methods * Update returned type `str` -> `types.InviteLink` * Add method to edit invite link Since editing the link returns a slightly different type to exporting, I have made a small "hack" in the InviteLink type. * Move Invites V2 methods to their own namespace * Add get_chat_invite_importers and InviteImporter Method to fetch information on users that joined via a specific link and the type to display the information * Add methods to delete revoked links * delete_exported_chat_invite to delete a single revoked link * delete_revoked_exported_chat_invites to delete all revoked links of a specified admin * Renaming Invite(s) to InviteLink(s) As per @delivrance's request https://github.com/pyrogram/pyrogram/pull/630#issuecomment-791893890 Also sorted invites' __init__ alphabetically * Add Method to get admins with exported invite link Documentation needs an update and the respective type needs to be created. I cannot test this, as I lack Creator permissions. * Invite Links overhaul * Rearrange code Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
67 lines
2.2 KiB
Python
67 lines
2.2 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 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 RevokeChatInviteLink(Scaffold):
|
|
async def revoke_chat_invite_link(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
invite_link: str,
|
|
) -> "types.ChatInviteLink":
|
|
"""Revoke a previously created invite link.
|
|
|
|
If the primary link is revoked, a new link is automatically generated.
|
|
|
|
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
|
|
|
|
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 to revoke.
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.ChatInviteLink`: On success, the invite link object is returned.
|
|
"""
|
|
|
|
r = await self.send(
|
|
raw.functions.messages.EditExportedChatInvite(
|
|
peer=await self.resolve_peer(chat_id),
|
|
link=invite_link,
|
|
revoked=True
|
|
)
|
|
)
|
|
|
|
users = {i.id: i for i in r.users}
|
|
|
|
chat_invite = (
|
|
r.new_invite
|
|
if isinstance(r, raw.types.messages.ExportedChatInviteReplaced)
|
|
else r.invite
|
|
)
|
|
|
|
return types.ChatInviteLink._parse(self, chat_invite, users)
|