org.drinkless.tdlib

Class TdApi.DownloadFile

java.lang.Object

org.drinkless.tdlib.TdApi.Object

org.drinkless.tdlib.TdApi.Function<TdApi.File>

org.drinkless.tdlib.TdApi.DownloadFile

Enclosing class:

TdApi

public static class TdApi.DownloadFile
extends TdApi.Function<TdApi.File>

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

Returns File

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSTRUCTOR Identifier uniquely determining type of the object.
int	fileId Identifier of the file to download.
long	limit 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.
long	offset The starting position from which the file needs to be downloaded.
int	priority Priority of the download (1-32).
boolean	synchronous 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.

Constructor Summary

Constructors

Constructor and Description
DownloadFile() Default constructor for a function, which downloads a file from the cloud.
DownloadFile(int fileId, int priority, long offset, long limit, boolean synchronous) Creates a function, which downloads a file from the cloud.

Method Summary

Modifier and Type	Method and Description
int	getConstructor() Returns an identifier uniquely determining type of the object.

Methods inherited from class org.drinkless.tdlib.TdApi.Function

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fileId

public int fileId

Identifier of the file to download.

priority

public int 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/addFileToDownloads was called will be downloaded first.

offset

public long offset

The starting position from which the file needs to be downloaded.

limit

public long limit

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

public boolean synchronous

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.

CONSTRUCTOR

public static final int CONSTRUCTOR

Identifier uniquely determining type of the object.

See Also:

Constant Field Values

Constructor Detail

DownloadFile

public DownloadFile()

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

Returns File

DownloadFile

public DownloadFile(int fileId,
                    int priority,
                    long offset,
                    long limit,
                    boolean synchronous)

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

Returns File

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

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

limit - 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 - 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.

Method Detail

getConstructor

public int getConstructor()

Description copied from class: TdApi.Object

Returns an identifier uniquely determining type of the object.

Specified by:

getConstructor in class TdApi.Object

Returns:

this.CONSTRUCTOR