tgbot-cpp
Loading...
Searching...
No Matches
TgBot::Game Struct Reference

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<Game>

Public Attributes

std::string title { }
 Title of the game.
std::string description { }
 Description of the game.
std::vector< std::shared_ptr< PhotoSize > > photo { }
 Photo that will be displayed in the game message in chats.
std::optional< std::string > text { }
 Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
std::optional< std::vector< std::shared_ptr< MessageEntity > > > textEntities { }
 Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
std::shared_ptr< Animationanimation { }
 Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.

Detailed Description

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

Definition at line 3825 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 3826 of file Types.h.

Member Data Documentation

◆ animation

std::shared_ptr<Animation> TgBot::Game::animation { }

Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.

Definition at line 3860 of file Types.h.

◆ description

std::string TgBot::Game::description { }

Description of the game.

Definition at line 3836 of file Types.h.

◆ photo

std::vector<std::shared_ptr<PhotoSize> > TgBot::Game::photo { }

Photo that will be displayed in the game message in chats.

Definition at line 3841 of file Types.h.

◆ text

std::optional<std::string> TgBot::Game::text { }

Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.

Definition at line 3848 of file Types.h.

◆ textEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::Game::textEntities { }

Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.

Definition at line 3854 of file Types.h.

◆ title

std::string TgBot::Game::title { }

Title of the game.

Definition at line 3831 of file Types.h.


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