setChatBackground Class Reference

Inherits Function.

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

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 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< InputBackground >	background_
	The input background to use; pass null to create a new filled or chat theme background.
int53	chat_id_
	Chat identifier.
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't of the type inputBackgroundPrevious.
object_ptr< BackgroundType >	type_
	Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn'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.

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

Constructor & Destructor Documentation

setChatBackground() [1/2]

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]

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'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't of the type inputBackgroundPrevious.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h