getRemoteFile Class Reference

Inherits Function.

Description

Returns information about a file by its remote identifier. This is an offline method. Can be used to register a URL as a file for further uploading, or sending as a message. Even if the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application.

Returns object_ptr<File>.

Public Types
using	ReturnType = object_ptr<file>
	Typedef for the type returned by the function.

Public Member Functions
	getRemoteFile ()
	getRemoteFile (string const &remote_file_id_, object_ptr< FileType > &&file_type_)
void	store (TlStorerToString &s, const char *field_name) const final
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
object_ptr< FileType >	file_type_
	File type; pass null if unknown.
string	remote_file_id_
	Remote identifier of the file to get.

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

Constructor & Destructor Documentation

getRemoteFile() [1/2]

getRemoteFile

(

)

Default constructor for a function, which returns information about a file by its remote identifier. This is an offline method. Can be used to register a URL as a file for further uploading, or sending as a message. Even if the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application.

Returns object_ptr<File>.

getRemoteFile() [2/2]

getRemoteFile	(	string const &	remote_file_id_,
		object_ptr< FileType > &&	file_type_ )

Creates a function, which returns information about a file by its remote identifier. This is an offline method. Can be used to register a URL as a file for further uploading, or sending as a message. Even if the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application.

Returns object_ptr<File>.

Parameters

[in]	remote_file_id_	Remote identifier of the file to get.
[in]	file_type_	File type; pass null if unknown.

Member Function Documentation

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