MadelineProtoDocs/old_docs/API_docs_v32/methods/messages.updatePinnedMessag...

61 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: messages.updatePinnedMessage
description: Pin a message
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/messages_updatePinnedMessage.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: messages.updatePinnedMessage
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Pin a message
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|silent|[Bool](../types/Bool.md) | Pin the message silently, without triggering a notification | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer where to pin the message | Optional|
|id|[int](../types/int.md) | The message to pin, can be 0 to unpin any currently pinned messages | Yes|
2018-04-01 13:19:25 +02:00
2018-04-01 13:24:46 +02:00
### Return type: [Updates](../types/Updates.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **YES**
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();
2020-06-16 17:50:25 +02:00
$Updates = $MadelineProto->messages->updatePinnedMessage(['silent' => Bool, 'peer' => InputPeer, 'id' => int, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
Updates = messages.updatePinnedMessage({silent=Bool, peer=InputPeer, id=int, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
2020-06-16 17:50:25 +02:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified|
2019-09-02 17:41:28 +02:00
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
2020-09-12 12:47:38 +02:00
|400|PIN_RESTRICTED|You can't pin messages|
2020-06-16 17:50:25 +02:00
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
2018-04-01 13:19:25 +02:00