MadelineProto/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

---
title: messages.toggleDialogPin
2018-03-23 16:23:49 +01:00
description: Pin or unpin dialog
---
## Method: messages.toggleDialogPin
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Pin or unpin dialog
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?|
2018-03-23 16:23:49 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
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();
$Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputPeer, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
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/messages.toggleDialogPin`
Parameters:
pinned - Json encoded Bool
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
peer - Json encoded InputPeer
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:
```
Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|