mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-14 13:07:26 +01:00
67 lines
1.4 KiB
Markdown
67 lines
1.4 KiB
Markdown
---
|
|
title: messages.toggleDialogPin
|
|
description: messages.toggleDialogPin parameters, return type and example
|
|
---
|
|
## Method: messages.toggleDialogPin
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Required |
|
|
|----------|---------------|----------|
|
|
|pinned|[Bool](../types/Bool.md) | Optional|
|
|
|peer|[InputPeer](../types/InputPeer.md) | Yes|
|
|
|
|
|
|
### Return type: [Bool](../types/Bool.md)
|
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
### Errors this method can return:
|
|
|
|
| Error | Description |
|
|
|----------|---------------|
|
|
|PEER_ID_INVALID|The provided peer id is invalid|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
```
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
|
$MadelineProto->session = 'mySession.madeline';
|
|
if (isset($number)) { // Login as a user
|
|
$MadelineProto->phone_login($number);
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
|
$MadelineProto->complete_phone_login($code);
|
|
}
|
|
|
|
$Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputPeer, ]);
|
|
```
|
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
|
|
|
|
|
|
|
### 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, })
|
|
```
|
|
|