MadelineProtoDocs/old_docs/API_docs_v82/methods/messages_toggleDialogPin.md

70 lines
1.5 KiB
Markdown
Raw Normal View History

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