Skip to content

downloadFile

Function · TDLib 1.8.67 · d1085f9c

Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates

downloadFile(
  file_id: int32,
  priority: int32,
  offset: int53,
  limit: int53,
  synchronous: Bool
) → File

file_id

int32

Identifier of the file to download

priority

int32

Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first

offset

int53

The starting position from which the file needs to be downloaded

limit

int53

Number of bytes which need to be downloaded starting from the "offset" position before the download will automatically be canceled; use 0 to download without a limit

synchronous

Bool

Pass true to return response only after the file download has succeeded, has failed, has been canceled, or a new downloadFile request with different offset/limit parameters was sent; pass false to return file state immediately, just after the download has been started