TgBot::InputMediaLivePhoto Struct Reference

Represents a live photo to be sent. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<InputMediaLivePhoto>

Public Attributes
std::string	type { TYPE }
	Type of the media, must be live_photo.
std::string	media { }
	Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
std::string	photo { }
	The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
std::optional< std::string >	caption { }
	Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the live photo caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > >	captionEntities { }
	Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::optional< bool >	showCaptionAboveMedia { }
	Optional. Pass True if the caption must be shown above the message media.
std::optional< bool >	hasSpoiler { }
	Optional. Pass True if the live photo needs to be covered with a spoiler animation.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Represents a live photo to be sent.

Definition at line 6545 of file Types.h.

Member Typedef Documentation

Ptr

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

Definition at line 6546 of file Types.h.

Member Data Documentation

caption

std::optional<std::string> TgBot::InputMediaLivePhoto::caption { }

Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing.

Definition at line 6574 of file Types.h.

captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InputMediaLivePhoto::captionEntities { }

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 6586 of file Types.h.

hasSpoiler

std::optional<bool> TgBot::InputMediaLivePhoto::hasSpoiler { }

Optional. Pass True if the live photo needs to be covered with a spoiler animation.

Definition at line 6596 of file Types.h.

media

std::string TgBot::InputMediaLivePhoto::media { }

Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.

Definition at line 6561 of file Types.h.

parseMode

std::optional<std::string> TgBot::InputMediaLivePhoto::parseMode { }

Optional. Mode for parsing entities in the live photo caption. See formatting options for more details.

Definition at line 6580 of file Types.h.

photo

std::string TgBot::InputMediaLivePhoto::photo { }

The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.

Definition at line 6569 of file Types.h.

showCaptionAboveMedia

std::optional<bool> TgBot::InputMediaLivePhoto::showCaptionAboveMedia { }

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

Definition at line 6591 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InputMediaLivePhoto::TYPE

static

Definition at line 6548 of file Types.h.

type

std::string TgBot::InputMediaLivePhoto::type { TYPE }

Type of the media, must be live_photo.

Definition at line 6553 of file Types.h.

---

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

• include/tgbot/Types.h