MadelineProtoDocs/old_docs/API_docs_v105/methods/messages.toggleDialogPin.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: messages.toggleDialogPin
2019-12-27 17:48:04 +01:00
description: Pin/unpin a dialog
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: messages.toggleDialogPin
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Pin/unpin a dialog
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|pinned|[Bool](../types/Bool.md) | Whether to pin or unpin the dialog | Optional|
2019-06-23 13:07:51 +02:00
|peer|[Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | The dialog to pin | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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' => InputDialogPeer, ]);
```
Or, if you're into Lua:
```lua
Bool = messages.toggleDialogPin({pinned=Bool, peer=InputDialogPeer, })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|PEER_ID_INVALID|The provided peer id is invalid|
2019-06-23 13:07:51 +02:00