mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
6e1425ada3
* delete_messages: Drop support for generators Since we used a list there anyway, this approach will lead to more localized errors and can reduce function overhead. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * delete_messages: Return pts_count:int An example usecase would be for a normal bot which uses range based on message ids instead of keeping a track of messages and using the DeletedMessagesHandler. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * Drop support for Iterators and update docstrings and some cleanups. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * Update get_users.py * Update get_messages.py * Update delete_messages.py * Update forward_messages.py * Update get_messages.py Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
64 lines
2.3 KiB
Python
64 lines
2.3 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 List, Union
|
|
|
|
import pyrogram
|
|
from pyrogram import raw, types
|
|
|
|
|
|
class DeleteContacts:
|
|
async def delete_contacts(
|
|
self: "pyrogram.Client",
|
|
user_ids: Union[int, str, List[Union[int, str]]]
|
|
) -> Union["types.User", List["types.User"], None]:
|
|
"""Delete contacts from your Telegram address book.
|
|
|
|
Parameters:
|
|
user_ids (``int`` | ``str`` | List of ``int`` or ``str``):
|
|
A single user id/username o a list of user identifiers (id or username).
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.User` | List of :obj:`~pyrogram.types.User` | ``None``: In case *user_ids* was an
|
|
integer or a string, a single User object is returned. In case *user_ids* was a list, a list of User objects
|
|
is returned. In case nothing changed after calling the method (for example, when deleting a non-existent
|
|
contact), None is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
await app.delete_contacts(user_id)
|
|
await app.delete_contacts([user_id1, user_id2, user_id3])
|
|
"""
|
|
is_list = isinstance(user_ids, list)
|
|
|
|
if not is_list:
|
|
user_ids = [user_ids]
|
|
|
|
r = await self.invoke(
|
|
raw.functions.contacts.DeleteContacts(
|
|
id=[await self.resolve_peer(i) for i in user_ids]
|
|
)
|
|
)
|
|
|
|
if not r.updates:
|
|
return None
|
|
|
|
users = types.List([types.User._parse(self, i) for i in r.users])
|
|
|
|
return users if is_list else users[0]
|