remoteFile Class Reference

Inherits Object.

Description

Represents a remote file.

Public Fields
string	id_
	Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers. If the ID starts with "http://" or "https://", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known. If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and "#url#" as the conversion string. Application must generate the file by downloading it to the specified location.
string	unique_id_
	Unique file identifier; may be empty if unknown. The unique file identifier which is the same for the same file even for different users and is persistent over time.
bool	is_uploading_active_
	True, if the file is currently being uploaded (or a remote copy is being generated by some other means).
bool	is_uploading_completed_
	True, if a remote copy is fully available.
int32	uploaded_size_
	Size of the remote available part of the file, in bytes; 0 if unknown.

Public Instance Methods
	remoteFile ()
	remoteFile (string const &id_, string const &unique_id_, bool is_uploading_active_, bool is_uploading_completed_, int32 uploaded_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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

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

Constructor & Destructor Documentation

remoteFile() [1/2]

remoteFile

(

)

Represents a remote file.

remoteFile() [2/2]

remoteFile	(	string const &	id_,
		string const &	unique_id_,
		bool	is_uploading_active_,
		bool	is_uploading_completed_,
		int32	uploaded_size_
	)

Represents a remote file.

Parameters

[in]	id_	Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers. If the ID starts with "http://" or "https://", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known. If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and "#url#" as the conversion string. Application must generate the file by downloading it to the specified location.
[in]	unique_id_	Unique file identifier; may be empty if unknown. The unique file identifier which is the same for the same file even for different users and is persistent over time.
[in]	is_uploading_active_	True, if the file is currently being uploaded (or a remote copy is being generated by some other means).
[in]	is_uploading_completed_	True, if a remote copy is fully available.
[in]	uploaded_size_	Size of the remote available part of the file, in bytes; 0 if unknown.

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]	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:

• td/generate/auto/td/telegram/td_api.h