TgBot::InputMediaDocument Struct Reference

Represents a general file to be sent. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<InputMediaDocument>

Public Attributes
std::string	type { TYPE }
	Type of the media, must be document.
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 information on Sending Files »
std::optional< 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 »
std::optional< std::string >	caption { }
	Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the document caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > >	captionEntities { }
	Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::optional< 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.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Represents a general file to be sent.

Definition at line 6462 of file Types.h.

Member Typedef Documentation

Ptr

using TgBot::InputMediaDocument::Ptr = std::shared_ptr<InputMediaDocument>

Definition at line 6463 of file Types.h.

Member Data Documentation

caption

std::optional<std::string> TgBot::InputMediaDocument::caption { }

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

Definition at line 6494 of file Types.h.

captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InputMediaDocument::captionEntities { }

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

Definition at line 6506 of file Types.h.

disableContentTypeDetection

std::optional<bool> TgBot::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 6512 of file Types.h.

media

std::string TgBot::InputMediaDocument::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 information on Sending Files »

Definition at line 6478 of file Types.h.

parseMode

std::optional<std::string> TgBot::InputMediaDocument::parseMode { }

Optional. Mode for parsing entities in the document caption. See formatting options for more details.

Definition at line 6500 of file Types.h.

thumbnail

std::optional<std::string> TgBot::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 »

Definition at line 6489 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InputMediaDocument::TYPE

static

Definition at line 6465 of file Types.h.

type

std::string TgBot::InputMediaDocument::type { TYPE }

Type of the media, must be document.

Definition at line 6470 of file Types.h.

---

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

• include/tgbot/Types.h