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>
114 lines
4.1 KiB
Python
114 lines
4.1 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/>.
|
|
|
|
import os
|
|
from typing import Union, BinaryIO
|
|
|
|
from pyrogram import raw
|
|
from pyrogram import utils
|
|
from pyrogram.file_id import FileType
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class SetChatPhoto(Scaffold):
|
|
async def set_chat_photo(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
*,
|
|
photo: Union[str, BinaryIO] = None,
|
|
video: Union[str, BinaryIO] = None
|
|
) -> bool:
|
|
"""Set a new chat photo or video (H.264/MPEG-4 AVC video, max 5 seconds).
|
|
|
|
The ``photo`` and ``video`` arguments are mutually exclusive.
|
|
Pass either one as named argument (see examples below).
|
|
|
|
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 (int) or username (str) of the target chat.
|
|
|
|
photo (``str`` | ``BinaryIO``, *optional*):
|
|
New chat photo. You can pass a :obj:`~pyrogram.types.Photo` file_id, a file path to upload a new photo
|
|
from your local machine or a binary file-like object with its attribute
|
|
".name" set for in-memory uploads.
|
|
|
|
video (``str`` | ``BinaryIO``, *optional*):
|
|
New chat video. You can pass a :obj:`~pyrogram.types.Video` file_id, a file path to upload a new video
|
|
from your local machine or a binary file-like object with its attribute
|
|
".name" set for in-memory uploads.
|
|
|
|
Returns:
|
|
``bool``: True on success.
|
|
|
|
Raises:
|
|
ValueError: if a chat_id belongs to user.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Set chat photo using a local file
|
|
app.set_chat_photo(chat_id, photo="photo.jpg")
|
|
|
|
# Set chat photo using an exiting Photo file_id
|
|
app.set_chat_photo(chat_id, photo=photo.file_id)
|
|
|
|
|
|
# Set chat video using a local file
|
|
app.set_chat_photo(chat_id, video="video.mp4")
|
|
|
|
# Set chat photo using an exiting Video file_id
|
|
app.set_chat_photo(chat_id, video=video.file_id)
|
|
"""
|
|
peer = await self.resolve_peer(chat_id)
|
|
|
|
if isinstance(photo, str):
|
|
if os.path.isfile(photo):
|
|
photo = raw.types.InputChatUploadedPhoto(
|
|
file=await self.save_file(photo),
|
|
video=await self.save_file(video)
|
|
)
|
|
else:
|
|
photo = utils.get_input_media_from_file_id(photo, FileType.PHOTO)
|
|
photo = raw.types.InputChatPhoto(id=photo.id)
|
|
else:
|
|
photo = raw.types.InputChatUploadedPhoto(
|
|
file=await self.save_file(photo),
|
|
video=await self.save_file(video)
|
|
)
|
|
|
|
if isinstance(peer, raw.types.InputPeerChat):
|
|
await self.send(
|
|
raw.functions.messages.EditChatPhoto(
|
|
chat_id=peer.chat_id,
|
|
photo=photo
|
|
)
|
|
)
|
|
elif isinstance(peer, raw.types.InputPeerChannel):
|
|
await self.send(
|
|
raw.functions.channels.EditPhoto(
|
|
channel=peer,
|
|
photo=photo
|
|
)
|
|
)
|
|
else:
|
|
raise ValueError(f'The chat_id "{chat_id}" belongs to a user')
|
|
|
|
return True
|