TDLib
Loading...
Searching...
No Matches
document Class Referencefinal

Inherits Object.

Description

Describes a document of any type.

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_)
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< file > document_
 File containing the document.
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< minithumbnail > minithumbnail_
 Document minithumbnail; may be null.
object_ptr< thumbnail > thumbnail_
 Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ document() [1/2]

document ( )

Describes a document of any type.

◆ document() [2/2]

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

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