MadelineProtoDocs/old_docs/API_docs_v27/methods/messages.faveSticker.md

55 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: messages.faveSticker
description: Mark a sticker as favorite
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/messages_faveSticker.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: messages.faveSticker
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Mark a sticker as favorite
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Sticker to mark as favorite | Optional|
|unfave|[Bool](../types/Bool.md) | Unfavorite | Yes|
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [Bool](../types/Bool.md)
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](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');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-06-16 17:50:25 +02:00
$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
2020-06-16 17:50:25 +02:00
|400|STICKER_ID_INVALID|The provided sticker ID is invalid|
2018-04-01 13:19:25 +02:00