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

This object represents a game. More...

#include <Game.h>

Public Types

typedef std::shared_ptr< Game > Ptr

Public Attributes

std::string title
 Title of the game.
std::string description
 Description of the game.
std::vector< PhotoSize::Ptr > photo
 Photo that will be displayed in the game message in chats.
std::string text
 Optional. Brief description of the game or high scores included in the game message.
std::vector< MessageEntity::Ptr > textEntities
 Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
Animation::Ptr animation
 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 21 of file Game.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 23 of file Game.h.

Member Data Documentation

◆ animation

Animation::Ptr TgBot::Game::animation

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

Definition at line 55 of file Game.h.

◆ description

std::string TgBot::Game::description

Description of the game.

Definition at line 33 of file Game.h.

◆ photo

std::vector<PhotoSize::Ptr> TgBot::Game::photo

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

Definition at line 38 of file Game.h.

◆ text

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 45 of file Game.h.

◆ textEntities

std::vector<MessageEntity::Ptr> TgBot::Game::textEntities

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

Definition at line 50 of file Game.h.

◆ title

std::string TgBot::Game::title

Title of the game.

Definition at line 28 of file Game.h.

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