MadelineProto/docs/API_docs/methods/channels_getAdminLog.md

84 lines
2.2 KiB
Markdown
Raw Normal View History

2017-06-30 15:36:33 +02:00
---
title: channels.getAdminLog
description: channels.getAdminLog parameters, return type and example
---
## Method: channels.getAdminLog
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-06-30 15:36:33 +02:00
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|q|[string](../types/string.md) | Yes|
|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|
|admins|Array of [InputUser](../types/InputUser.md) | Optional|
|max\_id|[long](../types/long.md) | Yes|
|min\_id|[long](../types/long.md) | Yes|
|limit|[int](../types/int.md) | Yes|
### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2017-06-30 15:36:33 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-06-30 15:36:33 +02:00
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-06-30 15:36:33 +02:00
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$channels_AdminLogResults = $MadelineProto->channels->getAdminLog(['channel' => InputChannel, 'q' => 'string', 'events_filter' => ChannelAdminLogEventsFilter, 'admins' => [InputUser], 'max_id' => long, 'min_id' => long, 'limit' => int, ]);
2017-06-30 15:36:33 +02:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getAdminLog`
Parameters:
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
q - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
events_filter - Json encoded ChannelAdminLogEventsFilter
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
admins - Json encoded array of InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_id - Json encoded long
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
min_id - Json encoded long
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
limit - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
2017-06-30 15:36:33 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, })
2017-06-30 15:36:33 +02:00
```