MadelineProtoDocs/docs/API_docs/methods/upload.getFile.md

70 lines
2.7 KiB
Markdown
Raw Normal View History

2019-08-15 20:25:16 +02:00
---
title: upload.getFile
2020-06-16 17:50:25 +02:00
description: Returns content of a whole file or its part.
2019-08-15 20:25:16 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/upload_getFile.html
2019-08-15 20:25:16 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: upload.getFile
2019-08-15 20:25:16 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Returns content of a whole file or its part.
2019-08-15 20:25:16 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2019-08-15 20:25:16 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|precise|[Bool](../types/Bool.md) | Disable some checks on limit and offset values, useful for example to stream videos by keyframes | Optional|
|cdn\_supported|[Bool](../types/Bool.md) | Whether the current client supports [CDN downloads](https://core.telegram.org/cdn) | Optional|
|location|[InputFileLocation](../types/InputFileLocation.md) | File location | Yes|
|offset|[int](../types/int.md) | Number of bytes to be skipped | Yes|
|limit|[int](../types/int.md) | Number of bytes to be returned | Yes|
2019-09-02 17:41:28 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [upload.File](../types/upload.File.md)
2019-09-02 17:41:28 +02:00
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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-03-06 12:24:14 +01:00
$upload.File = $MadelineProto->upload->getFile(['precise' => Bool, 'cdn_supported' => Bool, 'location' => InputFileLocation, 'offset' => int, 'limit' => int, ]);
2019-09-02 17:41:28 +02:00
```
Or, if you're into Lua:
```lua
2020-03-06 12:24:14 +01:00
upload.File = upload.getFile({precise=Bool, cdn_supported=Bool, location=InputFileLocation, offset=int, limit=int, })
2019-09-02 17:41:28 +02:00
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
2020-03-06 13:09:28 +01:00
|400|CHANNEL_INVALID|The provided channel is invalid|
2020-06-16 17:50:25 +02:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2019-09-02 17:41:28 +02:00
|400|FILE_ID_INVALID|The provided file id is invalid|
2020-03-06 13:09:28 +01:00
|400|FILE_REFERENCE_EXPIRED|File reference expired, it must be refetched as described in https://core.telegram.org/api/file_reference|
2019-09-02 17:41:28 +02:00
|400|INPUT_FETCH_FAIL|Failed deserializing TL payload|
|400|LIMIT_INVALID|The provided limit is invalid|
|400|LOCATION_INVALID|The provided location is invalid|
2020-01-10 14:18:02 +01:00
|400|MSG_ID_INVALID|Invalid message ID provided|
2019-09-02 17:41:28 +02:00
|400|OFFSET_INVALID|The provided offset is invalid|
2020-02-23 19:29:04 +01:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-12-27 17:48:04 +01:00
|406|FILEREF_UPGRADE_NEEDED|The client has to be updated in order to support [file references](https://core.telegram.org/api/file_reference)|
2019-09-02 17:41:28 +02:00
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|-503|Timeout|Timeout while fetching data|
2019-08-15 20:25:16 +02:00