MadelineProtoDocs/old_docs/API_docs_v27/methods/contacts.getBlocked.md

48 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
title: contacts.getBlocked
2019-12-27 17:48:04 +01:00
description: Returns the list of blocked users.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/contacts_getBlocked.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: contacts.getBlocked
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
2019-12-27 17:48:04 +01:00
Returns the list of blocked users.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|offset|[int](../types/int.md) | The number of list elements to be skipped | Yes|
|limit|[int](../types/int.md) | The number of list elements to be returned | Yes|
2018-04-01 13:19:25 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [contacts.Blocked](../types/contacts.Blocked.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-12-27 18:25:37 +01:00
$contacts.Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
contacts.Blocked = contacts.getBlocked({offset=int, limit=int, })
2018-04-01 13:19:25 +02:00
```