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

Inherits Function.

Description

Returns information about a file by its remote ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even 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 Fields

string remote_file_id_
 Remote identifier of the file to get.
 
object_ptr< FileTypefile_type_
 File type; pass null if unknown.
 

Public Types

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

Public Instance Methods

 getRemoteFile ()
 
 getRemoteFile (string const &remote_file_id_, object_ptr< FileType > &&file_type_)
 
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 = 2137204530
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ getRemoteFile() [1/2]

Default constructor for a function, which returns information about a file by its remote ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even 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 ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even 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.

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: