libtd-ktx / kotlinx.telegram.coroutines / downloadFile

downloadFile

suspend fun TelegramFlow.downloadFile(fileId: Int, priority: Int, offset: Int, limit: Int, synchronous: Boolean): File

Suspend function, which downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates.

Parameters

fileId - Identifier of the file to download.

priority - 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 was called will be downloaded first.

offset - The starting position from which the file should be downloaded.

limit - Number of bytes which should be downloaded starting from the "offset" position before the download will be automatically cancelled; use 0 to download without a limit.

synchronous - If false, this request returns file state just after the download has been started. If true, this request returns file state only after the download has succeeded, has failed, has been cancelled or a new downloadFile request with different offset/limit parameters was sent.

Return File Represents a file.