tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InputMedia Class Reference
Types

This abstract class is base of all input media. More...

#include <InputMedia.h>

Inheritance diagram for TgBot::InputMedia:
TgBot::InputMediaAnimation TgBot::InputMediaAudio TgBot::InputMediaDocument TgBot::InputMediaPhoto TgBot::InputMediaVideo

Public Types

typedef std::shared_ptr< InputMedia > Ptr

Public Member Functions

 InputMedia ()
virtual ~InputMedia ()

Public Attributes

std::string type
 Type of the result.
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.
std::vector< MessageEntity::Ptr > captionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.

Detailed Description

This abstract class is base of all input media.

This object represents the content of a media message to be sent.

Definition at line 19 of file InputMedia.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<InputMedia> TgBot::InputMedia::Ptr

Definition at line 21 of file InputMedia.h.

Constructor & Destructor Documentation

◆ InputMedia()

TgBot::InputMedia::InputMedia ( )
inline

Definition at line 23 of file InputMedia.h.

◆ ~InputMedia()

virtual TgBot::InputMedia::~InputMedia ( )
inlinevirtual

Definition at line 25 of file InputMedia.h.

Member Data Documentation

◆ caption

std::string TgBot::InputMedia::caption

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

Definition at line 43 of file InputMedia.h.

◆ captionEntities

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

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

Definition at line 55 of file InputMedia.h.

◆ media

std::string TgBot::InputMedia::media

File to send.

Pass a fileId 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. https://core.telegram.org/bots/api#sending-files

Definition at line 38 of file InputMedia.h.

◆ parseMode

std::string TgBot::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 50 of file InputMedia.h.

◆ type

std::string TgBot::InputMedia::type

Type of the result.

Definition at line 30 of file InputMedia.h.

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