This object represents a file ready to be downloaded. More...

#include <File.hpp>

Public Member Functions
	File ()=default

	File (const nl::json &json)

nl::json	toJson () const
	Serializes this object to JSON. More...

void	fromJson (const nl::json &json)
	Deserializes this object from JSON. More...

Public Attributes
std::string	fileId
	Identifier for this file, which can be used to download or reuse the file. More...

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. More...

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. More...

std::string	filePath
	Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. More...

Detailed Description

This object represents a file ready to be downloaded.

The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.

Note: The maximum file size to download is 20 MB https://core.telegram.org/bots/api#file

Definition at line 13 of file File.hpp.

Constructor & Destructor Documentation

◆ File() [1/2]

tgbotxx::File::File ( )

default

◆ File() [2/2]

tgbotxx::File::File ( const nl::json & json )

inlineexplicit

Definition at line 15 of file File.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::File::fromJson ( const nl::json & json )

inline

Deserializes this object from JSON.

Definition at line 46 of file File.hpp.

◆ toJson()

nl::json tgbotxx::File::toJson ( ) const

inline

Serializes this object to JSON.

Returns: JSON representation of this object

Definition at line 36 of file File.hpp.

Member Data Documentation

◆ fileId

std::string tgbotxx::File::fileId

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

Definition at line 20 of file File.hpp.

◆ filePath

std::string tgbotxx::File::filePath

Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.

Definition at line 32 of file File.hpp.

◆ fileSize

std::int64_t tgbotxx::File::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 29 of file File.hpp.

◆ fileUniqueId

std::string tgbotxx::File::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 24 of file File.hpp.

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

include/tgbotxx/objects/File.hpp

Public Member Functions

Public Attributes