The background is a wallpaper in JPEG format. https://core.telegram.org/bots/api#backgroundtypewallpaper. More...

#include <BackgroundType.hpp>

Inheritance diagram for tgbotxx::BackgroundTypeWallpaper:

Public Member Functions
	BackgroundTypeWallpaper ()

	BackgroundTypeWallpaper (const nl::json &json)

nl::json	toJson () const override

void	fromJson (const nl::json &json) override

Public Member Functions inherited from tgbotxx::BackgroundType
	BackgroundType ()=default

	BackgroundType (const nl::json &json)

virtual	~BackgroundType ()=default

Public Attributes
Ptr< Document >	document
	Document with the wallpaper.

std::int32_t	darkThemeDimming {}
	Dimming of the background in dark themes, as a percentage; 0-100.

bool	isBlurred {}
	Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12.

bool	isMoving {}
	Optional. True, if the background moves slightly when the device is tilted.

Public Attributes inherited from tgbotxx::BackgroundType
std::string	type
	Type of the background, one of "fill", "wallpaper", "pattern", "chat_theme".

Detailed Description

The background is a wallpaper in JPEG format. https://core.telegram.org/bots/api#backgroundtypewallpaper.

Definition at line 72 of file BackgroundType.hpp.

Constructor & Destructor Documentation

◆ BackgroundTypeWallpaper() [1/2]

tgbotxx::BackgroundTypeWallpaper::BackgroundTypeWallpaper ( )

inline

Definition at line 73 of file BackgroundType.hpp.

◆ BackgroundTypeWallpaper() [2/2]

tgbotxx::BackgroundTypeWallpaper::BackgroundTypeWallpaper ( const nl::json & json )

inlineexplicit

Definition at line 76 of file BackgroundType.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::BackgroundTypeWallpaper::fromJson ( const nl::json & json )

inlineoverridevirtual

Reimplemented from tgbotxx::BackgroundType.

Definition at line 101 of file BackgroundType.hpp.

◆ toJson()

nl::json tgbotxx::BackgroundTypeWallpaper::toJson ( ) const

inlineoverridevirtual

Reimplemented from tgbotxx::BackgroundType.

Definition at line 92 of file BackgroundType.hpp.

Member Data Documentation

◆ darkThemeDimming

std::int32_t tgbotxx::BackgroundTypeWallpaper::darkThemeDimming {}

Dimming of the background in dark themes, as a percentage; 0-100.

Definition at line 84 of file BackgroundType.hpp.

◆ document

Ptr<Document> tgbotxx::BackgroundTypeWallpaper::document

Document with the wallpaper.

Definition at line 81 of file BackgroundType.hpp.

◆ isBlurred

bool tgbotxx::BackgroundTypeWallpaper::isBlurred {}

Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12.

Definition at line 87 of file BackgroundType.hpp.

◆ isMoving

bool tgbotxx::BackgroundTypeWallpaper::isMoving {}

Optional. True, if the background moves slightly when the device is tilted.

Definition at line 90 of file BackgroundType.hpp.

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

include/tgbotxx/objects/BackgroundType.hpp

Public Member Functions

Public Attributes