2018-04-01 13:19:25 +02:00
|
|
|
---
|
2019-03-08 13:49:23 +01:00
|
|
|
title: messages.faveSticker
|
|
|
|
description: Add a sticker to favorites
|
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
|
|
|
---
|
2019-03-08 13:49:23 +01:00
|
|
|
# Method: messages.faveSticker
|
2018-04-01 13:19:25 +02:00
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
Add a sticker to favorites
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
2018-08-29 11:18:25 +02:00
|
|
|
| Name | Type | Description | Required |
|
|
|
|
|----------|---------------|-------------|----------|
|
2019-03-08 13:49:23 +01:00
|
|
|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional|
|
|
|
|
|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes|
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
### Return type: [Bool](../types/Bool.md)
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
### Can bots use this method: **YES**
|
|
|
|
|
|
|
|
|
|
|
|
### MadelineProto Example:
|
|
|
|
|
|
|
|
|
2018-10-17 17:10:50 +02:00
|
|
|
```php
|
2018-04-01 13:19:25 +02:00
|
|
|
if (!file_exists('madeline.php')) {
|
|
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
|
|
|
}
|
2019-03-12 13:25:41 +01:00
|
|
|
define('MADELINE_BRANCH', '');
|
2018-04-01 13:19:25 +02:00
|
|
|
include 'madeline.php';
|
|
|
|
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
|
|
|
$MadelineProto->start();
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
|
2018-04-01 13:19:25 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
|
|
|
|
|
|
|
|
### As a bot:
|
|
|
|
|
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
* method - messages.faveSticker
|
|
|
|
* params - `{"id": InputDocument, "unfave": Bool, }`
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### As a user:
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.faveSticker`
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2019-03-08 13:49:23 +01:00
|
|
|
id - Json encoded InputDocument
|
|
|
|
|
|
|
|
unfave - Json encoded Bool
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Or, if you're into Lua:
|
|
|
|
|
2018-10-17 17:10:50 +02:00
|
|
|
```lua
|
2019-03-08 13:49:23 +01:00
|
|
|
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
|
2018-04-01 13:19:25 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
### Errors this method can return:
|
|
|
|
|
|
|
|
| Error | Description |
|
|
|
|
|----------|---------------|
|
2019-03-08 13:49:23 +01:00
|
|
|
|STICKER_ID_INVALID|The provided sticker ID is invalid|
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|