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

Arguments for Api::sendGame. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats.
std::string gameShortName { }
 Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
std::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
std::shared_ptr< InlineKeyboardMarkup > replyMarkup = nullptr
 A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
bool protectContent = false
 Protects the contents of the sent message from forwarding and saving.
std::string businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message will be sent.
bool allowPaidBroadcast = false
 Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; for private chats only.

Detailed Description

Arguments for Api::sendGame.

Definition at line 18185 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

bool TgBot::SendGameArgs::allowPaidBroadcast = false

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.

Definition at line 18240 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendGameArgs::businessConnectionId = ""

Unique identifier of the business connection on behalf of which the message will be sent.

Definition at line 18233 of file Types.h.

◆ chatId

std::variant<std::int64_t, std::string> TgBot::SendGameArgs::chatId { }

Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats.

Definition at line 18191 of file Types.h.

◆ disableNotification

bool TgBot::SendGameArgs::disableNotification = false

Sends the message silently. Users will receive a notification with no sound.

Definition at line 18215 of file Types.h.

◆ gameShortName

std::string TgBot::SendGameArgs::gameShortName { }

Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.

Definition at line 18197 of file Types.h.

◆ messageEffectId

std::string TgBot::SendGameArgs::messageEffectId = ""

Unique identifier of the message effect to be added to the message; for private chats only.

Definition at line 18246 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendGameArgs::messageThreadId = 0

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.

Definition at line 18222 of file Types.h.

◆ protectContent

bool TgBot::SendGameArgs::protectContent = false

Protects the contents of the sent message from forwarding and saving.

Definition at line 18227 of file Types.h.

◆ replyMarkup

std::shared_ptr<InlineKeyboardMarkup> TgBot::SendGameArgs::replyMarkup = nullptr

A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.

Definition at line 18209 of file Types.h.

◆ replyParameters

std::shared_ptr<ReplyParameters> TgBot::SendGameArgs::replyParameters = nullptr

Description of the message to reply to.

Definition at line 18202 of file Types.h.


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