List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
setFileGenerationProgress Class Referencefinal

Inherits Function.

Description

Informs TDLib on a file generation progress.

Returns object_ptr<Ok>.

Public Fields

int64 generation_id_
 The identifier of the generation process.
 
int32 expected_size_
 Expected size of the generated file, in bytes; 0 if unknown.
 
int32 local_prefix_size_
 The number of bytes already generated.
 

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Instance Methods

 setFileGenerationProgress ()
 
 setFileGenerationProgress (int64 generation_id_, int32 expected_size_, int32 local_prefix_size_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ setFileGenerationProgress() [1/2]

Default constructor for a function, which informs TDLib on a file generation progress.

Returns object_ptr<Ok>.

◆ setFileGenerationProgress() [2/2]

setFileGenerationProgress ( int64  generation_id_,
int32  expected_size_,
int32  local_prefix_size_ 
)

Creates a function, which informs TDLib on a file generation progress.

Returns object_ptr<Ok>.

Parameters
[in]generation_id_The identifier of the generation process.
[in]expected_size_Expected size of the generated file, in bytes; 0 if unknown.
[in]local_prefix_size_The number of bytes already generated.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ store()

void 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 TlObject.


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