MadelineProto/docs/API_docs/methods/messages_saveGif.md

67 lines
1.3 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.saveGif
description: messages.saveGif parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.saveGif
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
2016-12-19 19:43:50 +01:00
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|id|[InputDocument](../types/InputDocument.md) | Yes|
|unsave|[Bool](../types/Bool.md) | Yes|
2016-12-19 19:43:50 +01:00
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|GIF_ID_INVALID|The provided GIF ID is invalid|
2016-12-19 19:43:50 +01:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2016-12-19 19:43:50 +01:00
$MadelineProto->complete_phone_login($code);
}
2016-12-21 10:40:30 +01:00
$Bool = $MadelineProto->messages->saveGif(['id' => InputDocument, 'unsave' => Bool, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveGif`
Parameters:
id - Json encoded InputDocument
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
unsave - Json encoded Bool
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
Bool = messages.saveGif({id=InputDocument, unsave=Bool, })
```