FilesExpand file tree

develop

/

block_user.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

52 lines (44 loc) · 1.65 KB

develop

/

block_user.py

Copy path

Top

File metadata and controls

• Code
• Blame

52 lines (44 loc) · 1.65 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

# Pyrogram - Telegram MTProto API Client Library for Python

# Copyright (C) 2017-2019 Dan Tès <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.api import functions

from ...ext import BaseClient

class BlockUser(BaseClient):

def block_user(

self,

user_id: Union[int, str]

) -> bool:

"""Block a user.

Parameters:

user_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).

Returns:

``bool``: True on success

Example:

.. code-block:: python

app.block_user(user_id)

"""

return bool(

self.send(

functions.contacts.Block(

id=self.resolve_peer(user_id)

)

)

)