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>
61 lines
2.2 KiB
Python
61 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.scaffold import Scaffold
|
|
|
|
|
|
class GetChatInviteLinksCount(Scaffold):
|
|
async def get_chat_invite_links_count(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
admin_id: Union[int, str],
|
|
revoked: bool = False,
|
|
) -> int:
|
|
"""Get the count of the invite links created by an administrator in a chat.
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier for the target chat or username of the target channel/supergroup
|
|
(in the format @username).
|
|
|
|
admin_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target user.
|
|
For you yourself you can simply use "me" or "self".
|
|
For a contact that exists in your Telegram address book you can use his phone number (str).
|
|
|
|
revoked (``bool``, *optional*):
|
|
True, if you want to get revoked links instead.
|
|
Defaults to False (get active links only).
|
|
|
|
Returns:
|
|
``int``: On success, the invite links count is returned.
|
|
"""
|
|
r = await self.send(
|
|
raw.functions.messages.GetExportedChatInvites(
|
|
peer=await self.resolve_peer(chat_id),
|
|
admin_id=await self.resolve_peer(admin_id),
|
|
limit=1,
|
|
revoked=revoked
|
|
)
|
|
)
|
|
|
|
return r.count
|