MadelineProtoDocs/old_docs/API_docs_v91/methods/messages_faveSticker.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

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**
2019-05-04 12:15:39 +02:00
### MadelineProto Example ([now async!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +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
```
Or, if you're into Lua:
```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