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::preliminaryUploadFile Class Referencefinal

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

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

Public Types

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

Public Member Functions

 preliminaryUploadFile ()
 
 preliminaryUploadFile (object_ptr< InputFile > &&file_, object_ptr< FileType > &&file_type_, int32 priority_)
 
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

object_ptr< InputFilefile_
 File to upload.
 
object_ptr< FileTypefile_type_
 File type; pass null if unknown.
 
int32 priority_
 Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first.
 

Static Public Attributes

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

Detailed Description

Preliminarily uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. In all other cases there is no need to preliminary upload a file. Updates updateFile will be used to notify about upload progress. The upload will not be completed until the file is sent in a message.

Returns object_ptr<File>.

Definition at line 118261 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 118300 of file td_api.h.

Constructor & Destructor Documentation

◆ preliminaryUploadFile() [1/2]

td::td_api::preliminaryUploadFile::preliminaryUploadFile ( )

Default constructor for a function, which preliminarily uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. In all other cases there is no need to preliminary upload a file. Updates updateFile will be used to notify about upload progress. The upload will not be completed until the file is sent in a message.

Returns object_ptr<File>.

◆ preliminaryUploadFile() [2/2]

td::td_api::preliminaryUploadFile::preliminaryUploadFile ( object_ptr< InputFile > &&  file_,
object_ptr< FileType > &&  file_type_,
int32  priority_ 
)

Creates a function, which preliminarily uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. In all other cases there is no need to preliminary upload a file. Updates updateFile will be used to notify about upload progress. The upload will not be completed until the file is sent in a message.

Returns object_ptr<File>.

Parameters
[in]file_File to upload.
[in]file_type_File type; pass null if unknown.
[in]priority_Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first.

Member Function Documentation

◆ store()

void td::td_api::preliminaryUploadFile::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_

object_ptr<InputFile> td::td_api::preliminaryUploadFile::file_

File to upload.

Definition at line 118272 of file td_api.h.

◆ file_type_

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

File type; pass null if unknown.

Definition at line 118274 of file td_api.h.

◆ ID

const std::int32_t td::td_api::preliminaryUploadFile::ID = 1894239129
static

Identifier uniquely determining a type of the object.

Definition at line 118297 of file td_api.h.

◆ priority_

int32 td::td_api::preliminaryUploadFile::priority_

Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first.

Definition at line 118276 of file td_api.h.


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