This object represents a file ready to be downloaded. The file can be downloaded via Api::downloadFile or via the link https://api.telegram.org/file/bot<token>/<filePath>. It is guaranteed that the File::filePath will be valid for at least 1 hour. When the File::filePath expires, a new one can be requested by calling Api::getFile. More...

#include <File.h>

Public Types
typedef std::shared_ptr< File >	Ptr

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::int64_t	fileSize
	Optional. File size in bytes.

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

Detailed Description

This object represents a file ready to be downloaded. The file can be downloaded via Api::downloadFile or via the link https://api.telegram.org/file/bot<token>/<filePath>. It is guaranteed that the File::filePath will be valid for at least 1 hour. When the File::filePath expires, a new one can be requested by calling Api::getFile.

The maximum file size to download is 20 MB

Definition at line 20 of file File.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<File> TgBot::File::Ptr

Definition at line 23 of file File.h.

Member Data Documentation

◆ fileId

std::string TgBot::File::fileId

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

Definition at line 28 of file File.h.

◆ filePath

std::string TgBot::File::filePath

Optional. File path. Use Api::downloadFile or https://api.telegram.org/file/bot<token>/<filePath> to get the file.

Definition at line 48 of file File.h.

◆ fileSize

std::int64_t TgBot::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 42 of file File.h.

◆ fileUniqueId

std::string TgBot::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 34 of file File.h.

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

include/tgbot/types/File.h

Public Types

Public Attributes