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

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 setChatBackground ()
 
 setChatBackground (int53 chat_id_, object_ptr< InputBackground > &&background_, object_ptr< BackgroundType > &&type_, int32 dark_theme_dimming_)
 
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

int53 chat_id_
 Chat identifier.
 
object_ptr< InputBackgroundbackground_
 The input background to use; pass null to create a new filled background or to remove the current background.
 
object_ptr< BackgroundTypetype_
 Background type; pass null to remove the current background.
 
int32 dark_theme_dimming_
 Dimming of the background in dark themes, as a percentage; 0-100.
 

Static Public Attributes

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

Detailed Description

Changes the background in a specific chat. Supported only in private and secret chats with non-deleted users.

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

◆ setChatBackground() [1/2]

td::td_api::setChatBackground::setChatBackground ( )

Default constructor for a function, which changes the background in a specific chat. Supported only in private and secret chats with non-deleted users.

Returns object_ptr<Ok>.

◆ setChatBackground() [2/2]

td::td_api::setChatBackground::setChatBackground ( int53  chat_id_,
object_ptr< InputBackground > &&  background_,
object_ptr< BackgroundType > &&  type_,
int32  dark_theme_dimming_ 
)

Creates a function, which changes the background in a specific chat. Supported only in private and secret chats with non-deleted users.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]background_The input background to use; pass null to create a new filled background or to remove the current background.
[in]type_Background type; pass null to remove the current background.
[in]dark_theme_dimming_Dimming of the background in dark themes, as a percentage; 0-100.

Member Function Documentation

◆ get_id()

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

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

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