Inherits Update.

Description

The file generation process needs to be started by the application. Use setFileGenerationProgress and finishFileGeneration to generate the file.

Public Member Functions
void	store (TlStorerToString &s, const char *field_name) const final
	updateFileGenerationStart ()
	updateFileGenerationStart (int64 generation_id_, string const &original_path_, string const &destination_path_, string const &conversion_)
Public Member Functions inherited from TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
string	conversion_
	If the conversion is "#url#" than original_path contains an HTTP/HTTPS URL of a file that must be downloaded by the application. Otherwise, this is the conversion specified by the application in inputFileGenerated.
string	destination_path_
	The path to a file that must be created and where the new file must be generated by the application. If the application has no access to the path, it can use writeGeneratedFilePart to generate the file.
int64	generation_id_
	Unique identifier for the generation process.
string	original_path_
	The original path specified by the application in inputFileGenerated.

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

Constructor & Destructor Documentation

updateFileGenerationStart ( )

The file generation process needs to be started by the application. Use setFileGenerationProgress and finishFileGeneration to generate the file.

updateFileGenerationStart	(	int64	generation_id_,
		string const &	original_path_,
		string const &	destination_path_,
		string const &	conversion_ )

The file generation process needs to be started by the application. Use setFileGenerationProgress and finishFileGeneration to generate the file.

Parameters

[in]	generation_id_	Unique identifier for the generation process.
[in]	original_path_	The original path specified by the application in inputFileGenerated.
[in]	destination_path_	The path to a file that must be created and where the new file must be generated by the application. If the application has no access to the path, it can use writeGeneratedFilePart to generate the file.
[in]	conversion_	If the conversion is "#url#" than original_path contains an HTTP/HTTPS URL of a file that must be downloaded by the application. Otherwise, this is the conversion specified by the application in inputFileGenerated.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

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