TDLib
Loading...
Searching...
No Matches
td::td_api::file Class Referencefinal

Inherits td::td_api::Object.

Public Member Functions

 file ()
 
 file (int32 id_, int53 size_, int53 expected_size_, object_ptr< localFile > &&local_, object_ptr< remoteFile > &&remote_)
 
std::int32_t get_id () const final
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

int32 id_
 Unique file identifier.
 
int53 size_
 File size, in bytes; 0 if unknown.
 
int53 expected_size_
 Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress.
 
object_ptr< localFilelocal_
 Information about the local copy of the file.
 
object_ptr< remoteFileremote_
 Information about the remote copy of the file.
 

Static Public Attributes

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

Detailed Description

Represents a file.

Constructor & Destructor Documentation

◆ file() [1/2]

td::td_api::file::file ( )

Represents a file.

◆ file() [2/2]

td::td_api::file::file ( int32  id_,
int53  size_,
int53  expected_size_,
object_ptr< localFile > &&  local_,
object_ptr< remoteFile > &&  remote_ 
)

Represents a file.

Parameters
[in]id_Unique file identifier.
[in]size_File size, in bytes; 0 if unknown.
[in]expected_size_Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress.
[in]local_Information about the local copy of the file.
[in]remote_Information about the remote copy of the file.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::file::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::file::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.


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