MadelineProtoDocs/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.toggleDialogPin
description: Pin or unpin dialog
---
## Method: messages.toggleDialogPin
[Back to methods index](index.md)
Pin or unpin dialog
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.toggleDialogPin`
Parameters:
pinned - Json encoded Bool
peer - Json encoded InputPeer
Or, if you're into Lua:
```
Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|