Represents a general file to be sent. https://core.telegram.org/bots/api#inputmediadocument. More...
#include <InputMedia.hpp>
Public Member Functions | |
| InputMediaDocument () | |
| InputMediaDocument (const nl::json &json) | |
| nl::json | toJson () const override |
| Serializes this object to JSON. More... | |
| void | fromJson (const nl::json &json) override |
| Deserializes this object from JSON. More... | |
 Public Member Functions inherited from tgbotxx::InputMedia | |
| InputMedia ()=default | |
| InputMedia (const nl::json &json) | |
Public Attributes | |
| std::string | thumbnail |
| Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » https://core.telegram.org/bots/api#sending-files. More... | |
| bool | disableContentTypeDetection {} |
| Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album. More... | |
| Public Attributes inherited from tgbotxx::InputMedia | |
| std::string | type |
| Type of the result. More... | |
| std::variant< cpr::File, std::string > | media {""} |
| File to send. More... | |
| std::string | caption |
| Optional. Caption of the media to be sent, 0-1024 characters after entities parsing. More... | |
| std::string | parseMode |
| Optional. Mode for parsing entities in the media caption. See https://core.telegram.org/bots/api#formatting-options for more details. More... | |
| std::vector< Ptr< MessageEntity > > | captionEntities |
| Optional. List of special entities that appear in the caption, which can be specified instead of parseMode. More... | |
Detailed Description
Represents a general file to be sent. https://core.telegram.org/bots/api#inputmediadocument.
Definition at line 126 of file InputMedia.hpp.
Constructor & Destructor Documentation
◆ InputMediaDocument() [1/2]
|
inline |
Definition at line 127 of file InputMedia.hpp.
◆ InputMediaDocument() [2/2]
|
inlineexplicit |
Definition at line 130 of file InputMedia.hpp.
Member Function Documentation
◆ fromJson()
|
inlineoverridevirtual |
Deserializes this object from JSON.
Reimplemented from tgbotxx::InputMedia.
Definition at line 152 of file InputMedia.hpp.
◆ toJson()
|
inlineoverridevirtual |
Serializes this object to JSON.
- Returns
- JSON representation of this object
Reimplemented from tgbotxx::InputMedia.
Definition at line 146 of file InputMedia.hpp.
Member Data Documentation
◆ disableContentTypeDetection
| bool tgbotxx::InputMediaDocument::disableContentTypeDetection {} |
Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
Definition at line 143 of file InputMedia.hpp.
◆ thumbnail
| std::string tgbotxx::InputMediaDocument::thumbnail |
Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » https://core.telegram.org/bots/api#sending-files.
Definition at line 139 of file InputMedia.hpp.
The documentation for this struct was generated from the following file:
- include/tgbotxx/objects/InputMedia.hpp
