tgbot-cpp
TgBot::InputMedia Class Reference

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

#include <InputMedia.h>

Inheritance diagram for TgBot::InputMedia:
TgBot::InputMediaPhoto TgBot::InputMediaVideo

Public Types

enum  TYPE : uint8_t { TYPE::PHOTO, TYPE::VIDEO }
 
typedef std::shared_ptr< InputMediaPtr
 

Public Attributes

TYPE type
 Type of the result, It should be one of TYPE::PHOTO/TYPE::VIDEO. More...
 
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...
 
std::string caption
 Optional. Caption of the photo to be sent, 0-200 characters. More...
 
std::string parseMode
 Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. More...
 
int32_t width = 0
 Optional. Video width. More...
 
int32_t height = 0
 Optional. Video height. More...
 
int32_t duration = 0
 Optional. Video duration. More...
 
bool supportsStreaming = false
 Optional. Pass True, if the uploaded video is suitable for streaming. More...
 

Detailed Description

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

Definition at line 38 of file InputMedia.h.

Member Typedef Documentation

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

Definition at line 40 of file InputMedia.h.

Member Enumeration Documentation

enum TgBot::InputMedia::TYPE : uint8_t
strong
Enumerator
PHOTO 
VIDEO 

Definition at line 42 of file InputMedia.h.

Member Data Documentation

std::string TgBot::InputMedia::caption

Optional. Caption of the photo to be sent, 0-200 characters.

Definition at line 60 of file InputMedia.h.

int32_t TgBot::InputMedia::duration = 0

Optional. Video duration.

Definition at line 80 of file InputMedia.h.

int32_t TgBot::InputMedia::height = 0

Optional. Video height.

Definition at line 75 of file InputMedia.h.

std::string TgBot::InputMedia::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.

Definition at line 55 of file InputMedia.h.

std::string TgBot::InputMedia::parseMode

Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

Definition at line 65 of file InputMedia.h.

bool TgBot::InputMedia::supportsStreaming = false

Optional. Pass True, if the uploaded video is suitable for streaming.

Definition at line 85 of file InputMedia.h.

TYPE TgBot::InputMedia::type

Type of the result, It should be one of TYPE::PHOTO/TYPE::VIDEO.

Definition at line 50 of file InputMedia.h.

int32_t TgBot::InputMedia::width = 0

Optional. Video width.

Definition at line 70 of file InputMedia.h.


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