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

Arguments for Api::sendLivePhoto. 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 channel (in the format @channelusername).
std::variant< std::shared_ptr< InputFile >, std::string > livePhoto { }
 Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
std::variant< std::shared_ptr< InputFile >, std::string > photo { }
 The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
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 businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message will be sent.
std::string callbackQueryId = ""
 Identifier of the callback query which triggered the ephemeral message.
std::string caption = ""
 Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing.
std::vector< std::shared_ptr< MessageEntity > > captionEntities = { }
 A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
std::int64_t directMessagesTopicId = 0
 Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
bool hasSpoiler = false
 Pass True if the video needs to be covered with a spoiler animation.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; for private chats only.
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.
std::string parseMode = ""
 Mode for parsing entities in the video caption. See formatting options for more details.
bool protectContent = false
 Protects the contents of the sent message from forwarding and saving.
std::int64_t receiverUserId = 0
 Identifier of the user who will receive the ephemeral message.
std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup = { }
 Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
std::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
bool showCaptionAboveMedia = false
 Pass True if the caption must be shown above the message media.
std::shared_ptr< SuggestedPostParameters > suggestedPostParameters = nullptr
 A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
std::shared_ptr< EphemeralMessageParameters > ephemeralMessageParameters = nullptr
 A JSON-serialized object containing the parameters of the ephemeral message to send.

Detailed Description

Arguments for Api::sendLivePhoto.

Definition at line 18507 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

bool TgBot::SendLivePhotoArgs::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 18536 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendLivePhotoArgs::businessConnectionId = ""

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

Definition at line 18542 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendLivePhotoArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 18547 of file Types.h.

◆ caption

std::string TgBot::SendLivePhotoArgs::caption = ""

Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing.

Definition at line 18553 of file Types.h.

◆ captionEntities

std::vector<std::shared_ptr<MessageEntity> > TgBot::SendLivePhotoArgs::captionEntities = { }

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 18559 of file Types.h.

◆ chatId

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

Unique identifier for the target chat or username of the target channel (in the format @channelusername).

Definition at line 18512 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::SendLivePhotoArgs::directMessagesTopicId = 0

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.

Definition at line 18565 of file Types.h.

◆ disableNotification

bool TgBot::SendLivePhotoArgs::disableNotification = false

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

Definition at line 18571 of file Types.h.

◆ ephemeralMessageParameters

std::shared_ptr<EphemeralMessageParameters> TgBot::SendLivePhotoArgs::ephemeralMessageParameters = nullptr

A JSON-serialized object containing the parameters of the ephemeral message to send.

Definition at line 18638 of file Types.h.

◆ hasSpoiler

bool TgBot::SendLivePhotoArgs::hasSpoiler = false

Pass True if the video needs to be covered with a spoiler animation.

Definition at line 18576 of file Types.h.

◆ livePhoto

std::variant<std::shared_ptr<InputFile>, std::string> TgBot::SendLivePhotoArgs::livePhoto { }

Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.

Definition at line 18521 of file Types.h.

◆ messageEffectId

std::string TgBot::SendLivePhotoArgs::messageEffectId = ""

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

Definition at line 18582 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendLivePhotoArgs::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 18589 of file Types.h.

◆ parseMode

std::string TgBot::SendLivePhotoArgs::parseMode = ""

Mode for parsing entities in the video caption. See formatting options for more details.

Definition at line 18595 of file Types.h.

◆ photo

std::variant<std::shared_ptr<InputFile>, std::string> TgBot::SendLivePhotoArgs::photo { }

The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.

Definition at line 18529 of file Types.h.

◆ protectContent

bool TgBot::SendLivePhotoArgs::protectContent = false

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

Definition at line 18600 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendLivePhotoArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 18605 of file Types.h.

◆ replyMarkup

std::variant<std::shared_ptr<InlineKeyboardMarkup>, std::shared_ptr<ReplyKeyboardMarkup>, std::shared_ptr<ReplyKeyboardRemove>, std::shared_ptr<ForceReply> > TgBot::SendLivePhotoArgs::replyMarkup = { }

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.

Definition at line 18614 of file Types.h.

◆ replyParameters

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

Description of the message to reply to.

Definition at line 18619 of file Types.h.

◆ showCaptionAboveMedia

bool TgBot::SendLivePhotoArgs::showCaptionAboveMedia = false

Pass True if the caption must be shown above the message media.

Definition at line 18624 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::SendLivePhotoArgs::suggestedPostParameters = nullptr

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Definition at line 18632 of file Types.h.


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