MadelineProto/docs/TD_docs/methods/cancelDownloadFile.md

74 lines
1.4 KiB
Markdown
Raw Normal View History

---
title: cancelDownloadFile
description: Stops file downloading. If file already downloaded do nothing.
---
## Method: cancelDownloadFile
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Stops file downloading. If file already downloaded do nothing.
### Params:
| Name | Type | Required | Description |
|----------|:-------------:|:--------:|------------:|
|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel download|
### Return type: [Ok](../types/Ok.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$Ok = $MadelineProto->cancelDownloadFile(['file_id' => int, ]);
```
2017-07-23 16:11:02 +02:00
Or, if you're using [PWRTelegram](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - cancelDownloadFile
* params - {"file_id":"int"}
```
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/cancelDownloadFile`
Parameters:
file_id - Json encoded int
```
Or, if you're into Lua:
```
Ok = cancelDownloadFile({file_id=int, })
```