From 985837f2152383c304d043bd4dc8af23914b112f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 2 Jan 2017 23:05:43 +0300 Subject: Docs --- docs/class_tg_bot_1_1_file.html | 195 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 docs/class_tg_bot_1_1_file.html (limited to 'docs/class_tg_bot_1_1_file.html') diff --git a/docs/class_tg_bot_1_1_file.html b/docs/class_tg_bot_1_1_file.html new file mode 100644 index 0000000..e29fb3f --- /dev/null +++ b/docs/class_tg_bot_1_1_file.html @@ -0,0 +1,195 @@ + + + + + + + +tgbot-cpp: TgBot::File Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
TgBot::File Class Reference
Types
+
+
+ +

#include <File.h>

+ + + + +

+Public Types

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

+Public Attributes

std::string fileId
 
int32_t fileSize
 
std::string filePath
 
+

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. Maximum file size to download is 20 MB

+ +

Definition at line 21 of file File.h.

+

Member Typedef Documentation

+ +

◆ Ptr

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

Definition at line 24 of file File.h.

+ +
+
+

Member Data Documentation

+ +

◆ fileId

+ +
+
+ + + + +
std::string TgBot::File::fileId
+
+

Unique identifier for this file

+ +

Definition at line 29 of file File.h.

+ +
+
+ +

◆ filePath

+ +
+
+ + + + +
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 40 of file File.h.

+ +
+
+ +

◆ fileSize

+ +
+
+ + + + +
int32_t TgBot::File::fileSize
+
+

Optional. File size, if known

+ +

Definition at line 34 of file File.h.

+ +
+
+
The documentation for this class was generated from the following file:
    +
  • include/tgbot/types/File.h
    • +
+
+
+ + + + -- cgit v1.2.3