This object represents the content of a media message to be sent. It should be one of: More...

#include <InputMedia.hpp>

Inheritance diagram for tgbotxx::InputMedia:

Public Member Functions
	InputMedia ()=default

	InputMedia (const nl::json &json)

virtual	~InputMedia ()=default

virtual nl::json	toJson () const
	Serializes this object to JSON.

virtual void	fromJson (const nl::json &json)
	Deserializes this object from JSON.

Public Attributes
std::string	type
	Type of the result.

std::variant< cpr::File, std::string >	media {""}
	File to send.

std::string	caption
	Optional. Caption of the media to be sent, 0-1024 characters after entities parsing.

std::string	parseMode
	Optional. Mode for parsing entities in the media caption. See https://core.telegram.org/bots/api#formatting-options for more details.

std::vector< Ptr< MessageEntity > >	captionEntities
	Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.

Detailed Description

This object represents the content of a media message to be sent. It should be one of:

Definition at line 13 of file InputMedia.hpp.

Constructor & Destructor Documentation

◆ InputMedia() [1/2]

tgbotxx::InputMedia::InputMedia ( )

default

◆ InputMedia() [2/2]

tgbotxx::InputMedia::InputMedia ( const nl::json & json )

inlineexplicit

Definition at line 15 of file InputMedia.hpp.

◆ ~InputMedia()

virtual tgbotxx::InputMedia::~InputMedia ( )

virtualdefault

Member Function Documentation

◆ fromJson()

virtual void tgbotxx::InputMedia::fromJson ( const nl::json & json )

inlinevirtual

Deserializes this object from JSON.

Reimplemented in tgbotxx::InputMediaAnimation, tgbotxx::InputMediaDocument, tgbotxx::InputMediaAudio, tgbotxx::InputMediaPhoto, and tgbotxx::InputMediaVideo.

Definition at line 59 of file InputMedia.hpp.

◆ toJson()

virtual nl::json tgbotxx::InputMedia::toJson ( ) const

inlinevirtual

Serializes this object to JSON.

Returns: JSON representation of this object

Reimplemented in tgbotxx::InputMediaAnimation, tgbotxx::InputMediaDocument, tgbotxx::InputMediaAudio, tgbotxx::InputMediaPhoto, and tgbotxx::InputMediaVideo.

Definition at line 44 of file InputMedia.hpp.

Member Data Documentation

◆ caption

std::string tgbotxx::InputMedia::caption

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

Definition at line 32 of file InputMedia.hpp.

◆ captionEntities

std::vector<Ptr<MessageEntity> > tgbotxx::InputMedia::captionEntities

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

Definition at line 39 of file InputMedia.hpp.

◆ media

std::variant<cpr::File, std::string> tgbotxx::InputMedia::media {""}

File to send.

Pass a file_id std::string to send a file that exists on the Telegram servers (recommended),
Pass an HTTP URL std::string for Telegram to get a file from the Internet, or
Pass a cpr::File to upload a local file The latter will internally use “attach://<file_attach_name>” with multipart/form-data under <file_attach_name> name to upload the local file. More information on Sending Files » https://core.telegram.org/bots/api#sending-files

Definition at line 29 of file InputMedia.hpp.

◆ parseMode

std::string tgbotxx::InputMedia::parseMode

Optional. Mode for parsing entities in the media caption. See https://core.telegram.org/bots/api#formatting-options for more details.

Definition at line 36 of file InputMedia.hpp.

◆ type

std::string tgbotxx::InputMedia::type

Type of the result.

Definition at line 21 of file InputMedia.hpp.

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

include/tgbotxx/objects/InputMedia.hpp

Public Member Functions

Public Attributes