td::td_api::remoteFile Class Reference

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

Inheritance diagram for td::td_api::remoteFile:

Public Member Functions
	remoteFile ()
	remoteFile (string const &id_, string const &unique_id_, bool is_uploading_active_, bool is_uploading_completed_, int53 uploaded_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	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 identifier 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/addFileToDownloads 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.
int53	uploaded_size_
	Size of the remote available part of the file, in bytes; 0 if unknown.

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

Detailed Description

Represents a remote file.

Definition at line 58800 of file td_api.h.

Constructor & Destructor Documentation

remoteFile() [1/2]

td::td_api::remoteFile::remoteFile

(

)

Represents a remote file.

remoteFile() [2/2]

td::td_api::remoteFile::remoteFile	(	string const &	id_,
		string const &	unique_id_,
		bool	is_uploading_active_,
		bool	is_uploading_completed_,
		int53	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 identifier 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/addFileToDownloads 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.

Member Function Documentation

store()

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

Member Data Documentation

ID

const std::int32_t td::td_api::remoteFile::ID = 747731030

static

Identifier uniquely determining a type of the object.

Definition at line 58838 of file td_api.h.

id_

string td::td_api::remoteFile::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 identifier 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/addFileToDownloads 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.

Definition at line 58811 of file td_api.h.

is_uploading_active_

bool td::td_api::remoteFile::is_uploading_active_

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

Definition at line 58815 of file td_api.h.

is_uploading_completed_

bool td::td_api::remoteFile::is_uploading_completed_

True, if a remote copy is fully available.

Definition at line 58817 of file td_api.h.

unique_id_

string td::td_api::remoteFile::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.

Definition at line 58813 of file td_api.h.

uploaded_size_

int53 td::td_api::remoteFile::uploaded_size_

Size of the remote available part of the file, in bytes; 0 if unknown.

Definition at line 58819 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h