td::td_api::downloadFile Class Reference

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::downloadFile:

Public Types
using	ReturnType = object_ptr< file >
	Typedef for the type returned by the function.

Public Member Functions
	downloadFile ()
	downloadFile (int32 file_id_, int32 priority_, int53 offset_, int53 limit_, bool synchronous_)
void	store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from td::TlObject
virtual void	store (TlStorerUnsafe &s) const
virtual void	store (TlStorerCalcLength &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int32	file_id_
	Identifier of the file to download.
int32	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.
int53	offset_
	The starting position from which the file needs to be downloaded.
int53	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.
bool	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.

Static Public Attributes
static const std::int32_t	ID = 1059402292
	Identifier uniquely determining a type of the object.

Detailed Description

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

Returns object_ptr<File>.

Definition at line 97171 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::downloadFile::ReturnType = object_ptr<file>

Typedef for the type returned by the function.

Definition at line 97216 of file td_api.h.

Constructor & Destructor Documentation

downloadFile() [1/2]

td::td_api::downloadFile::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 object_ptr<File>.

downloadFile() [2/2]

td::td_api::downloadFile::downloadFile	(	int32	file_id_,
		int32	priority_,
		int53	offset_,
		int53	limit_,
		bool	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 object_ptr<File>.

Parameters

[in]	file_id_	Identifier of the file to download.
[in]	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.
[in]	offset_	The starting position from which the file needs to be downloaded.
[in]	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.
[in]	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.

Member Function Documentation

store()

void td::td_api::downloadFile::store ( TlStorerToString &  s, const char *  field_name  ) const

finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters

[in]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

Member Data Documentation

file_id_

int32 td::td_api::downloadFile::file_id_

Identifier of the file to download.

Definition at line 97182 of file td_api.h.

ID

const std::int32_t td::td_api::downloadFile::ID = 1059402292

static

Identifier uniquely determining a type of the object.

Definition at line 97213 of file td_api.h.

limit_

int53 td::td_api::downloadFile::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.

Definition at line 97188 of file td_api.h.

offset_

int53 td::td_api::downloadFile::offset_

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

Definition at line 97186 of file td_api.h.

priority_

int32 td::td_api::downloadFile::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.

Definition at line 97184 of file td_api.h.

synchronous_

bool td::td_api::downloadFile::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.

Definition at line 97190 of file td_api.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h