MadelineProtoDocs/old_docs/API_docs_v82/methods/contacts_getBlocked.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01:00
title: contacts.getBlocked
description: Get blocked users
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
---
2018-12-26 02:56:50 +01:00
# Method: contacts.getBlocked
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Get blocked users
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2018-12-26 02:56:50 +01:00
|offset|[int](../types/int.md) | Initially 0, then set to the number of blocked contacts previously fetched | Yes|
|limit|[int](../types/int.md) | How many blocked contacts to fetch | Yes|
2018-04-01 13:19:25 +02:00
2018-12-26 02:56:50 +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();
2018-12-26 02:56:50 +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
2018-12-26 02:56:50 +01:00
contacts_Blocked = contacts.getBlocked({offset=int, limit=int, })
2018-04-01 13:19:25 +02:00
```