From c8d40dccabaaa406faed6c0797a92bac811c9d0f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Tue, 5 Jun 2018 19:07:27 +0300 Subject: Update docs --- docs/class_tg_bot_1_1_game.html | 269 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 269 insertions(+) create mode 100644 docs/class_tg_bot_1_1_game.html (limited to 'docs/class_tg_bot_1_1_game.html') diff --git a/docs/class_tg_bot_1_1_game.html b/docs/class_tg_bot_1_1_game.html new file mode 100644 index 0000000..3739c33 --- /dev/null +++ b/docs/class_tg_bot_1_1_game.html @@ -0,0 +1,269 @@ + + + + + + + +tgbot-cpp: TgBot::Game Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
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. More...
 
std::string description
 Description of the game. More...
 
std::vector< PhotoSize::Ptr > photo
 Photo that will be displayed in the game message in chats. More...
 
std::string text
 Optional. Brief description of the game or high scores included in the game message. More...
 
std::vector< MessageEntity::Ptr > textEntities
 Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. More...
 
Animation::Ptr animation
 Optional. Animation that will be displayed in the game message in chats. Upload via BotFather. More...
 
+

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

+

Member Typedef Documentation

+ +

◆ Ptr

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

Definition at line 46 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 78 of file Game.h.

+ +
+
+ +

◆ description

+ +
+
+ + + + +
std::string TgBot::Game::description
+
+ +

Description of the game.

+ +

Definition at line 56 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 61 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 68 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 73 of file Game.h.

+ +
+
+ +

◆ title

+ +
+
+ + + + +
std::string TgBot::Game::title
+
+ +

Title of the game.

+ +

Definition at line 51 of file Game.h.

+ +
+
+
The documentation for this class was generated from the following file:
    +
  • include/tgbot/types/Game.h
    • +
+
+
+ + + + -- cgit v1.2.3