This object represents a general file (as opposed to photos, voice messages and audio files). More...

#include <Types.h>

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

Public Attributes
std::string	fileId { }
	Identifier for this file, which can be used to download or reuse the file.
std::string	fileUniqueId { }
	Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
std::shared_ptr< PhotoSize >	thumbnail { }
	Optional. Document thumbnail as defined by the sender.
std::optional< std::string >	fileName { }
	Optional. Original filename as defined by the sender.
std::optional< std::string >	mimeType { }
	Optional. MIME type of the file as defined by the sender.
std::optional< std::int64_t >	fileSize { }
	Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Detailed Description

This object represents a general file (as opposed to photos, voice messages and audio files).

Definition at line 3333 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 3334 of file Types.h.

Member Data Documentation

◆ fileId

std::string TgBot::Document::fileId { }

Identifier for this file, which can be used to download or reuse the file.

Definition at line 3339 of file Types.h.

◆ fileName

std::optional<std::string> TgBot::Document::fileName { }

Optional. Original filename as defined by the sender.

Definition at line 3355 of file Types.h.

◆ fileSize

std::optional<std::int64_t> TgBot::Document::fileSize { }

Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Definition at line 3368 of file Types.h.

◆ fileUniqueId

std::string TgBot::Document::fileUniqueId { }

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Definition at line 3345 of file Types.h.

◆ mimeType

std::optional<std::string> TgBot::Document::mimeType { }

Optional. MIME type of the file as defined by the sender.

Definition at line 3360 of file Types.h.

◆ thumbnail

std::shared_ptr<PhotoSize> TgBot::Document::thumbnail { }

Optional. Document thumbnail as defined by the sender.

Definition at line 3350 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes