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

Inherits Object.

Description

Describes a chat background.

Public Fields

int64 id_
 Unique background identifier.
 
bool is_default_
 True, if this is one of default backgrounds.
 
bool is_dark_
 True, if the background is dark and is recommended to be used with dark theme.
 
string name_
 Unique background name.
 
object_ptr< documentdocument_
 Document with the background; may be null. Null only for filled and chat theme backgrounds.
 
object_ptr< BackgroundTypetype_
 Type of the background.
 

Public Instance Methods

 background ()
 
 background (int64 id_, bool is_default_, bool is_dark_, string const &name_, object_ptr< document > &&document_, object_ptr< BackgroundType > &&type_)
 
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 = -429971172
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ background() [1/2]

Describes a chat background.

◆ background() [2/2]

background ( int64  id_,
bool  is_default_,
bool  is_dark_,
string const &  name_,
object_ptr< document > &&  document_,
object_ptr< BackgroundType > &&  type_ 
)

Describes a chat background.

Parameters
[in]id_Unique background identifier.
[in]is_default_True, if this is one of default backgrounds.
[in]is_dark_True, if the background is dark and is recommended to be used with dark theme.
[in]name_Unique background name.
[in]document_Document with the background; may be null. Null only for filled and chat theme backgrounds.
[in]type_Type of the background.

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