MadelineProtoDocs/docs/API_docs/methods/messages_saveGif.md

70 lines
1.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.saveGif
description: Save a GIF
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.saveGif
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Save a GIF
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional|
|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```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();
$Bool = $MadelineProto->messages->saveGif(['id' => InputDocument, 'unsave' => Bool, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveGif`
Parameters:
id - Json encoded InputDocument
unsave - Json encoded Bool
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
Bool = messages.saveGif({id=InputDocument, unsave=Bool, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|GIF_ID_INVALID|The provided GIF ID is invalid|