From ce9bcf9d653a0598b41fcf52708d01b396c6fd30 Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Sun, 27 May 2018 22:44:51 +0300 Subject: Update README.md and docs --- docs/class_tg_bot_1_1_input_media.html | 333 +++++++++++++++++++++++++++++++++ 1 file changed, 333 insertions(+) create mode 100644 docs/class_tg_bot_1_1_input_media.html (limited to 'docs/class_tg_bot_1_1_input_media.html') diff --git a/docs/class_tg_bot_1_1_input_media.html b/docs/class_tg_bot_1_1_input_media.html new file mode 100644 index 0000000..b85c89b --- /dev/null +++ b/docs/class_tg_bot_1_1_input_media.html @@ -0,0 +1,333 @@ + + + + + + + +tgbot-cpp: TgBot::InputMedia Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
TgBot::InputMedia Class Reference
Types
+
+
+ +

#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< InputMedia > Ptr
 
+ + + + + + + + + + + + + + + + + +

+Public Attributes

TYPE type
 
std::string media
 
std::string caption
 
std::string parseMode
 
int32_t width = 0
 
int32_t height = 0
 
int32_t duration = 0
 
bool supportsStreaming = false
 
+

Detailed Description

+

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

+ +

Definition at line 37 of file InputMedia.h.

+

Member Typedef Documentation

+ +

◆ Ptr

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

Definition at line 39 of file InputMedia.h.

+ +
+
+

Member Enumeration Documentation

+ +

◆ TYPE

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

Definition at line 41 of file InputMedia.h.

+ +
+
+

Member Data Documentation

+ +

◆ caption

+ +
+
+ + + + +
std::string TgBot::InputMedia::caption
+
+

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

+ +

Definition at line 59 of file InputMedia.h.

+ +
+
+ +

◆ duration

+ +
+
+ + + + +
int32_t TgBot::InputMedia::duration = 0
+
+

Optional. Video duration

+ +

Definition at line 79 of file InputMedia.h.

+ +
+
+ +

◆ height

+ +
+
+ + + + +
int32_t TgBot::InputMedia::height = 0
+
+

Optional. Video height

+ +

Definition at line 74 of file InputMedia.h.

+ +
+
+ +

◆ media

+ +
+
+ + + + +
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 54 of file InputMedia.h.

+ +
+
+ +

◆ parseMode

+ +
+
+ + + + +
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 64 of file InputMedia.h.

+ +
+
+ +

◆ supportsStreaming

+ +
+
+ + + + +
bool TgBot::InputMedia::supportsStreaming = false
+
+

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

+ +

Definition at line 84 of file InputMedia.h.

+ +
+
+ +

◆ type

+ +
+
+ + + + +
TYPE TgBot::InputMedia::type
+
+

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

+ +

Definition at line 49 of file InputMedia.h.

+ +
+
+ +

◆ width

+ +
+
+ + + + +
int32_t TgBot::InputMedia::width = 0
+
+

Optional. Video width

+ +

Definition at line 69 of file InputMedia.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.3