-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathdelete_contacts.py
More file actions
66 lines (52 loc) · 2.43 KB
/
delete_contacts.py
File metadata and controls
66 lines (52 loc) · 2.43 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import hydrogram
from hydrogram import raw, types
class DeleteContacts:
async def delete_contacts(
self: hydrogram.Client, user_ids: int | str | list[int | str]
) -> types.User | list[types.User] | None:
"""Delete contacts from your Telegram address book.
.. include:: /_includes/usable-by/users.rst
Parameters:
user_ids (``int`` | ``str`` | List of ``int`` or ``str``):
A single user id/username or a list of user identifiers (id or username).
Returns:
:obj:`~hydrogram.types.User` | List of :obj:`~hydrogram.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]