tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
td::td_api::localFile Class Referencefinal

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

Inheritance diagram for td::td_api::localFile:
td::td_api::Object td::TlObject

Public Member Functions

 localFile ()
 
 localFile (string const &path_, bool can_be_downloaded_, bool can_be_deleted_, bool is_downloading_active_, bool is_downloading_completed_, int53 download_offset_, int53 downloaded_prefix_size_, int53 downloaded_size_)
 
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

string path_
 Local path to the locally available file part; may be empty.
 
bool can_be_downloaded_
 True, if it is possible to download or generate the file.
 
bool can_be_deleted_
 True, if the file can be deleted.
 
bool is_downloading_active_
 True, if the file is currently being downloaded (or a local copy is being generated by some other means).
 
bool is_downloading_completed_
 True, if the local copy is fully available.
 
int53 download_offset_
 Download will be started from this offset. downloaded_prefix_size is calculated from this offset.
 
int53 downloaded_prefix_size_
 If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes.
 
int53 downloaded_size_
 Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.
 

Static Public Attributes

static const std::int32_t ID = -1562732153
 Identifier uniquely determining a type of the object.
 

Detailed Description

Represents a local file.

Definition at line 37766 of file td_api.h.

Constructor & Destructor Documentation

◆ localFile() [1/2]

td::td_api::localFile::localFile ( )

Represents a local file.

◆ localFile() [2/2]

td::td_api::localFile::localFile ( string const &  path_,
bool  can_be_downloaded_,
bool  can_be_deleted_,
bool  is_downloading_active_,
bool  is_downloading_completed_,
int53  download_offset_,
int53  downloaded_prefix_size_,
int53  downloaded_size_ 
)

Represents a local file.

Parameters
[in]path_Local path to the locally available file part; may be empty.
[in]can_be_downloaded_True, if it is possible to download or generate the file.
[in]can_be_deleted_True, if the file can be deleted.
[in]is_downloading_active_True, if the file is currently being downloaded (or a local copy is being generated by some other means).
[in]is_downloading_completed_True, if the local copy is fully available.
[in]download_offset_Download will be started from this offset. downloaded_prefix_size is calculated from this offset.
[in]downloaded_prefix_size_If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes.
[in]downloaded_size_Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.

Member Function Documentation

◆ store()

void td::td_api::localFile::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]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ can_be_deleted_

bool td::td_api::localFile::can_be_deleted_

True, if the file can be deleted.

Definition at line 37781 of file td_api.h.

◆ can_be_downloaded_

bool td::td_api::localFile::can_be_downloaded_

True, if it is possible to download or generate the file.

Definition at line 37779 of file td_api.h.

◆ download_offset_

int53 td::td_api::localFile::download_offset_

Download will be started from this offset. downloaded_prefix_size is calculated from this offset.

Definition at line 37787 of file td_api.h.

◆ downloaded_prefix_size_

int53 td::td_api::localFile::downloaded_prefix_size_

If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes.

Definition at line 37789 of file td_api.h.

◆ downloaded_size_

int53 td::td_api::localFile::downloaded_size_

Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage.

Definition at line 37791 of file td_api.h.

◆ ID

const std::int32_t td::td_api::localFile::ID = -1562732153
static

Identifier uniquely determining a type of the object.

Definition at line 37813 of file td_api.h.

◆ is_downloading_active_

bool td::td_api::localFile::is_downloading_active_

True, if the file is currently being downloaded (or a local copy is being generated by some other means).

Definition at line 37783 of file td_api.h.

◆ is_downloading_completed_

bool td::td_api::localFile::is_downloading_completed_

True, if the local copy is fully available.

Definition at line 37785 of file td_api.h.

◆ path_

string td::td_api::localFile::path_

Local path to the locally available file part; may be empty.

Definition at line 37777 of file td_api.h.

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