tgbot-cpp
Loading...
Searching...
No Matches
TgBot::File Struct Reference

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

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<File>

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::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.
std::optional< std::string > filePath { }
 Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.

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.

Definition at line 3638 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 3639 of file Types.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 3644 of file Types.h.

◆ filePath

std::optional<std::string> TgBot::File::filePath { }

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

Definition at line 3664 of file Types.h.

◆ fileSize

std::optional<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 3658 of file Types.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 3650 of file Types.h.


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