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

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

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

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_, bool only_for_self_)
 
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 or chat theme background.
 
object_ptr< BackgroundTypetype_
 Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn&#x27;t supported for private and secret chats. Use chatBoostLevelFeatures.chat_theme_background_count and chatBoostLevelFeatures.can_set_custom_background to check whether the background type can be set in the boosted chat.
 
int32 dark_theme_dimming_
 Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background.
 
bool only_for_self_
 Pass true to set background only for self; pass false to set background for all chat users. Always false for backgrounds set in boosted chats. Background can be set for both users only by Telegram Premium users and if set background isn&#x27;t of the type inputBackgroundPrevious.
 

Static Public Attributes

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

Detailed Description

Sets the background in a specific chat. Supported only in private and secret chats with non-deleted users, and in chats with sufficient boost level and can_change_info administrator right.

Returns object_ptr<Ok>.

Definition at line 128818 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 128863 of file td_api.h.

Constructor & Destructor Documentation

◆ setChatBackground() [1/2]

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

Default constructor for a function, which sets the background in a specific chat. Supported only in private and secret chats with non-deleted users, and in chats with sufficient boost level and can_change_info administrator right.

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_,
bool  only_for_self_ 
)

Creates a function, which sets the background in a specific chat. Supported only in private and secret chats with non-deleted users, and in chats with sufficient boost level and can_change_info administrator right.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]background_The input background to use; pass null to create a new filled or chat theme background.
[in]type_Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn&#x27;t supported for private and secret chats. Use chatBoostLevelFeatures.chat_theme_background_count and chatBoostLevelFeatures.can_set_custom_background to check whether the background type can be set in the boosted chat.
[in]dark_theme_dimming_Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background.
[in]only_for_self_Pass true to set background only for self; pass false to set background for all chat users. Always false for backgrounds set in boosted chats. Background can be set for both users only by Telegram Premium users and if set background isn&#x27;t of the type inputBackgroundPrevious.

Member Function Documentation

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

Member Data Documentation

◆ background_

object_ptr<InputBackground> td::td_api::setChatBackground::background_

The input background to use; pass null to create a new filled or chat theme background.

Definition at line 128831 of file td_api.h.

◆ chat_id_

int53 td::td_api::setChatBackground::chat_id_

Chat identifier.

Definition at line 128829 of file td_api.h.

◆ dark_theme_dimming_

int32 td::td_api::setChatBackground::dark_theme_dimming_

Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background.

Definition at line 128835 of file td_api.h.

◆ ID

const std::int32_t td::td_api::setChatBackground::ID = 246727678
static

Identifier uniquely determining a type of the object.

Definition at line 128860 of file td_api.h.

◆ only_for_self_

bool td::td_api::setChatBackground::only_for_self_

Pass true to set background only for self; pass false to set background for all chat users. Always false for backgrounds set in boosted chats. Background can be set for both users only by Telegram Premium users and if set background isn&#x27;t of the type inputBackgroundPrevious.

Definition at line 128837 of file td_api.h.

◆ type_

object_ptr<BackgroundType> td::td_api::setChatBackground::type_

Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn&#x27;t supported for private and secret chats. Use chatBoostLevelFeatures.chat_theme_background_count and chatBoostLevelFeatures.can_set_custom_background to check whether the background type can be set in the boosted chat.

Definition at line 128833 of file td_api.h.


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