TDLib
Loading...
Searching...
No Matches
td::td_api::document Class Referencefinal

Inherits td::td_api::Object.

Public Member Functions

 document ()
 
 document (string const &file_name_, string const &mime_type_, object_ptr< minithumbnail > &&minithumbnail_, object_ptr< thumbnail > &&thumbnail_, object_ptr< file > &&document_)
 
std::int32_t get_id () const final
 
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 file_name_
 Original name of the file; as defined by the sender.
 
string mime_type_
 MIME type of the file; as defined by the sender.
 
object_ptr< minithumbnailminithumbnail_
 Document minithumbnail; may be null.
 
object_ptr< thumbnailthumbnail_
 Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null.
 
object_ptr< filedocument_
 File containing the document.
 

Static Public Attributes

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

Detailed Description

Describes a document of any type.

Constructor & Destructor Documentation

◆ document() [1/2]

td::td_api::document::document ( )

Describes a document of any type.

◆ document() [2/2]

td::td_api::document::document ( string const &  file_name_,
string const &  mime_type_,
object_ptr< minithumbnail > &&  minithumbnail_,
object_ptr< thumbnail > &&  thumbnail_,
object_ptr< file > &&  document_ 
)

Describes a document of any type.

Parameters
[in]file_name_Original name of the file; as defined by the sender.
[in]mime_type_MIME type of the file; as defined by the sender.
[in]minithumbnail_Document minithumbnail; may be null.
[in]thumbnail_Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null.
[in]document_File containing the document.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::document::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

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


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