tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::getRemoteFile Class Referencefinal

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

Inheritance diagram for td::td_api::getRemoteFile:
td::td_api::Function td::TlObject

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

Public Attributes

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

Static Public Attributes

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

Detailed 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 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>.

Definition at line 111905 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 111941 of file td_api.h.

Constructor & Destructor Documentation

◆ getRemoteFile() [1/2]

td::td_api::getRemoteFile::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 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]

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

Member Data Documentation

◆ file_type_

object_ptr<FileType> td::td_api::getRemoteFile::file_type_

File type; pass null if unknown.

Definition at line 111918 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getRemoteFile::ID = 2137204530
static

Identifier uniquely determining a type of the object.

Definition at line 111938 of file td_api.h.

◆ remote_file_id_

string td::td_api::getRemoteFile::remote_file_id_

Remote identifier of the file to get.

Definition at line 111916 of file td_api.h.


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