MadelineProtoDocs/old_docs/API_docs_v65/methods/upload.getFile.md

61 lines
2.6 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: upload.getFile
2019-12-27 18:02:36 +01:00
description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: upload.getFile
[Back to methods index](index.md)
2019-12-27 18:02:36 +01:00
You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 18:02:36 +01:00
|location|[InputFileLocation](../types/InputFileLocation.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes|
|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes|
|limit|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes|
2019-09-02 17:41:28 +02:00
### Return type: [upload\_File](../types/upload_File.md)
### 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();
$upload_File = $MadelineProto->upload->getFile(['location' => InputFileLocation, 'offset' => int, 'limit' => int, ]);
```
Or, if you're into Lua:
```lua
upload_File = upload.getFile({location=InputFileLocation, offset=int, limit=int, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|FILE_ID_INVALID|The provided file id is invalid|
|400|INPUT_FETCH_FAIL|Failed deserializing TL payload|
|400|LIMIT_INVALID|The provided limit is invalid|
|400|LOCATION_INVALID|The provided location is invalid|
|400|OFFSET_INVALID|The provided offset is invalid|
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-06-23 13:07:51 +02:00