This object represents a sticker. More...

#include <Sticker.h>

Public Types
enum class	Type { Regular , Mask , CustomEmoji }
	Enum of possible types of a sticker. More...

typedef std::shared_ptr< Sticker >	Ptr

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 isAnimated and isVideo.

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.

PhotoSize::Ptr	thumb
	Optional. Sticker thumbnail in the .WEBP or .JPG format.

std::string	emoji
	Optional. Emoji associated with the sticker.

std::string	setName
	Optional. Name of the sticker set to which the sticker belongs.

File::Ptr	premiumAnimation
	Optional. For premium regular stickers, premium animation for the sticker.

MaskPosition::Ptr	maskPosition
	Optional. For mask stickers, the position where the mask should be placed.

std::string	customEmojiId
	Optional. For custom emoji stickers, unique identifier of the custom emoji.

std::int32_t	fileSize
	Optional. File size in bytes.

Detailed Description

This object represents a sticker.

Definition at line 19 of file Sticker.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<Sticker> TgBot::Sticker::Ptr

Definition at line 22 of file Sticker.h.

Member Enumeration Documentation

◆ Type

enum class TgBot::Sticker::Type

strong

Enum of possible types of a sticker.

Enumerator
Regular
Mask
CustomEmoji

Definition at line 27 of file Sticker.h.

Member Data Documentation

◆ customEmojiId

std::string TgBot::Sticker::customEmojiId

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

Definition at line 96 of file Sticker.h.

◆ emoji

std::string TgBot::Sticker::emoji

Optional. Emoji associated with the sticker.

Definition at line 76 of file Sticker.h.

◆ fileId

std::string TgBot::Sticker::fileId

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

Definition at line 34 of file Sticker.h.

◆ fileSize

std::int32_t TgBot::Sticker::fileSize

Optional. File size in bytes.

Definition at line 101 of file Sticker.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 40 of file Sticker.h.

◆ height

std::int32_t TgBot::Sticker::height

Sticker height.

Definition at line 56 of file Sticker.h.

◆ isAnimated

bool TgBot::Sticker::isAnimated

True, if the sticker is animated.

Definition at line 61 of file Sticker.h.

◆ isVideo

bool TgBot::Sticker::isVideo

True, if the sticker is a video sticker.

Definition at line 66 of file Sticker.h.

◆ maskPosition

MaskPosition::Ptr TgBot::Sticker::maskPosition

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

Definition at line 91 of file Sticker.h.

◆ premiumAnimation

File::Ptr TgBot::Sticker::premiumAnimation

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

Definition at line 86 of file Sticker.h.

◆ setName

std::string TgBot::Sticker::setName

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

Definition at line 81 of file Sticker.h.

◆ thumb

PhotoSize::Ptr TgBot::Sticker::thumb

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

Definition at line 71 of file Sticker.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 isAnimated and isVideo.

Definition at line 46 of file Sticker.h.

◆ width

std::int32_t TgBot::Sticker::width

Sticker width.

Definition at line 51 of file Sticker.h.

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

include/tgbot/types/Sticker.h

Public Types

Public Attributes