1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-13 14:27:21 +01:00
MadelineProto/old_docs/API_docs_v45/methods/channels_editAbout.md

84 lines
1.8 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: channels.editAbout
description: channels.editAbout parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: channels.editAbout
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|about|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
2017-09-25 12:26:30 +02:00
|CHAT_ABOUT_NOT_MODIFIED|About text has not changed|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2017-08-28 12:44:50 +02:00
2017-09-01 12:27:38 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->channels->editAbout(['channel' => InputChannel, 'about' => 'string', ]);
2017-02-13 04:33:06 +01: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
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.editAbout
2017-07-23 16:40:54 +02:00
* params - `{"channel": InputChannel, "about": "string", }`
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.editAbout`
Parameters:
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
about - Json encoded string
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
Bool = channels.editAbout({channel=InputChannel, about='string', })
```