MadelineProtoDocs/old_docs/API_docs_v102/methods/contacts_block.md

52 lines
1.2 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
title: contacts.block
description: Block a user
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
# Method: contacts.block
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-06-24 15:45:02 +02:00
Block a user
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-06-24 15:45:02 +02:00
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to block | Optional|
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Return type: [Bool](../types/Bool.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2019-06-24 15:45:02 +02:00
$Bool = $MadelineProto->contacts->block(['id' => InputUser, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
Bool = contacts.block({id=InputUser, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CONTACT_ID_INVALID|The provided contact ID is invalid|