MadelineProtoDocs/docs/API_docs/methods/messages_faveSticker.md

79 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02: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
---
2018-04-05 01:19:57 +02:00
# Method: messages.faveSticker
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Add a sticker to favorites
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|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
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### 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->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.faveSticker
* params - `{"id": InputDocument, "unfave": Bool, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.faveSticker`
Parameters:
id - Json encoded InputDocument
unfave - Json encoded Bool
Or, if you're into Lua:
```
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|STICKER_ID_INVALID|The provided sticker ID is invalid|