mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-15 15:06:55 +01:00
73 lines
1.4 KiB
Markdown
73 lines
1.4 KiB
Markdown
---
|
|
title: cancelDownloadFile
|
|
description: Stops file downloading. If file already downloaded do nothing.
|
|
---
|
|
## Method: cancelDownloadFile
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
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
|
|
$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, ]);
|
|
```
|
|
|
|
Or, if you're using the [PWRTelegram HTTP API](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, })
|
|
```
|
|
|