MadelineProto/docs/API_docs/methods/channels_editAbout.md
Daniil Gentili e4a326e552
Http refactor (#307)
* refactor

* Apply fixes from StyleCI

* Implement https and http transport, add support for new req_pq_multi, send pending acks and objects in containers along with the next method call, remove dependency on the socket extension.

* Apply fixes from StyleCI

* Make types with empty constructors optional, fix phar archives (fixes #217)

* Apply fixes from StyleCI

* Update to layer 75

* Update github pages gemfile.lock
2018-02-18 14:18:18 +01:00

82 lines
1.8 KiB
Markdown

---
title: channels.editAbout
description: channels.editAbout parameters, return type and example
---
## Method: channels.editAbout
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Optional|
|about|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ABOUT_NOT_MODIFIED|About text has not changed|
|CHAT_ABOUT_TOO_LONG|Chat about too long|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->channels->editAbout(['channel' => InputChannel, 'about' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.editAbout
* params - `{"channel": InputChannel, "about": "string", }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editAbout`
Parameters:
channel - Json encoded InputChannel
about - Json encoded string
Or, if you're into Lua:
```
Bool = channels.editAbout({channel=InputChannel, about='string', })
```