TgBot::InputMediaPhoto Struct Reference

Represents a photo to be sent. More...

#include <Types.h>

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

Public Attributes
std::string	type { TYPE }
	Type of the media, must be photo.
std::string	media { }
	File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, 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 »
std::optional< std::string >	caption { }
	Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the 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 photo needs to be covered with a spoiler animation.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Represents a photo to be sent.

Definition at line 6639 of file Types.h.

Member Typedef Documentation

Ptr

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

Definition at line 6640 of file Types.h.

Member Data Documentation

caption

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

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

Definition at line 6660 of file Types.h.

captionEntities

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

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

Definition at line 6672 of file Types.h.

hasSpoiler

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

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

Definition at line 6682 of file Types.h.

media

std::string TgBot::InputMediaPhoto::media { }

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, 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 »

Definition at line 6655 of file Types.h.

parseMode

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

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

Definition at line 6666 of file Types.h.

showCaptionAboveMedia

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

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

Definition at line 6677 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InputMediaPhoto::TYPE

static

Definition at line 6642 of file Types.h.

type

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

Type of the media, must be photo.

Definition at line 6647 of file Types.h.

---

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

• include/tgbot/Types.h