MadelineProto/docs/API_docs/methods/messages_faveSticker.md

78 lines
1.6 KiB
Markdown
Raw Normal View History

---
title: messages.faveSticker
2018-03-23 16:23:49 +01:00
description: Add a sticker to favorites
---
## Method: messages.faveSticker
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Add a sticker to favorites
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites|
|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|STICKER_ID_INVALID|The provided sticker ID is invalid|
2018-03-20 19:57:36 +01:00
### 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, ]);
```
2018-03-20 19:57:36 +01:00
### [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, })
```