This object represents a sticker. More...

#include <Types.h>

Public Types
enum class	Type { Regular , Mask , CustomEmoji }
using	Ptr = std::shared_ptr<Sticker>

Public Attributes
std::string	fileId { }
	Identifier for this file, which can be used to download or reuse the file.
std::string	fileUniqueId { }
	Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Type	type { }
	Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.
std::int32_t	width { }
	Sticker width.
std::int32_t	height { }
	Sticker height.
bool	isAnimated { }
	True, if the sticker is animated.
bool	isVideo { }
	True, if the sticker is a video sticker.
std::shared_ptr< PhotoSize >	thumbnail { }
	Optional. Sticker thumbnail in the .WEBP or .JPG format.
std::optional< std::string >	emoji { }
	Optional. Emoji associated with the sticker.
std::optional< std::string >	setName { }
	Optional. Name of the sticker set to which the sticker belongs.
std::shared_ptr< File >	premiumAnimation { }
	Optional. For premium regular stickers, premium animation for the sticker.
std::shared_ptr< MaskPosition >	maskPosition { }
	Optional. For mask stickers, the position where the mask should be placed.
std::optional< std::string >	customEmojiId { }
	Optional. For custom emoji stickers, unique identifier of the custom emoji.
std::optional< bool >	needsRepainting { }
	Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places.
std::optional< std::int32_t >	fileSize { }
	Optional. File size in bytes.

Detailed Description

This object represents a sticker.

Definition at line 13351 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::Sticker::Ptr = std::shared_ptr<Sticker>

Definition at line 13352 of file Types.h.

Member Enumeration Documentation

◆ Type

enum class TgBot::Sticker::Type

strong

Enumerator
Regular
Mask
CustomEmoji

Definition at line 13354 of file Types.h.

Member Data Documentation

◆ customEmojiId

std::optional<std::string> TgBot::Sticker::customEmojiId { }

Optional. For custom emoji stickers, unique identifier of the custom emoji.

Definition at line 13422 of file Types.h.

◆ emoji

std::optional<std::string> TgBot::Sticker::emoji { }

Optional. Emoji associated with the sticker.

Definition at line 13402 of file Types.h.

◆ fileId

std::string TgBot::Sticker::fileId { }

Identifier for this file, which can be used to download or reuse the file.

Definition at line 13359 of file Types.h.

◆ fileSize

std::optional<std::int32_t> TgBot::Sticker::fileSize { }

Optional. File size in bytes.

Definition at line 13434 of file Types.h.

◆ fileUniqueId

std::string TgBot::Sticker::fileUniqueId { }

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Definition at line 13365 of file Types.h.

◆ height

std::int32_t TgBot::Sticker::height { }

Sticker height.

Definition at line 13382 of file Types.h.

◆ isAnimated

bool TgBot::Sticker::isAnimated { }

True, if the sticker is animated.

Definition at line 13387 of file Types.h.

◆ isVideo

bool TgBot::Sticker::isVideo { }

True, if the sticker is a video sticker.

Definition at line 13392 of file Types.h.

◆ maskPosition

std::shared_ptr<MaskPosition> TgBot::Sticker::maskPosition { }

Optional. For mask stickers, the position where the mask should be placed.

Definition at line 13417 of file Types.h.

◆ needsRepainting

std::optional<bool> TgBot::Sticker::needsRepainting { }

Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places.

Definition at line 13429 of file Types.h.

◆ premiumAnimation

std::shared_ptr<File> TgBot::Sticker::premiumAnimation { }

Optional. For premium regular stickers, premium animation for the sticker.

Definition at line 13412 of file Types.h.

◆ setName

std::optional<std::string> TgBot::Sticker::setName { }

Optional. Name of the sticker set to which the sticker belongs.

Definition at line 13407 of file Types.h.

◆ thumbnail

std::shared_ptr<PhotoSize> TgBot::Sticker::thumbnail { }

Optional. Sticker thumbnail in the .WEBP or .JPG format.

Definition at line 13397 of file Types.h.

◆ type

Type TgBot::Sticker::type { }

Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

Definition at line 13372 of file Types.h.

◆ width

std::int32_t TgBot::Sticker::width { }

Sticker width.

Definition at line 13377 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes