docs/class_tg_bot_1_1_file.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>tgbot-cpp: TgBot::File Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">tgbot-cpp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_tg_bot_1_1_file.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_tg_bot_1_1_file-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TgBot::File Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This object represents a file ready to be downloaded.  
 <a href="class_tg_bot_1_1_file.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_file_8h_source.html">File.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac47e9c73b9d762eef2322c0932c5a934"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr&lt; <a class="el" href="class_tg_bot_1_1_file.html">File</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_file.html#ac47e9c73b9d762eef2322c0932c5a934">Ptr</a></td></tr>
<tr class="separator:ac47e9c73b9d762eef2322c0932c5a934"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0e64b7f89b84e674ea890399ea27dd6e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_file.html#a0e64b7f89b84e674ea890399ea27dd6e">fileId</a></td></tr>
<tr class="memdesc:a0e64b7f89b84e674ea890399ea27dd6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier for this file.  <a href="#a0e64b7f89b84e674ea890399ea27dd6e">More...</a><br /></td></tr>
<tr class="separator:a0e64b7f89b84e674ea890399ea27dd6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c4a6f8d51e846ec75d15ffa2c5d1445"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_file.html#a1c4a6f8d51e846ec75d15ffa2c5d1445">fileSize</a></td></tr>
<tr class="memdesc:a1c4a6f8d51e846ec75d15ffa2c5d1445"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> size, if known.  <a href="#a1c4a6f8d51e846ec75d15ffa2c5d1445">More...</a><br /></td></tr>
<tr class="separator:a1c4a6f8d51e846ec75d15ffa2c5d1445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1abfaf438998878eee537fc82b4bb6e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_file.html#ad1abfaf438998878eee537fc82b4bb6e">filePath</a></td></tr>
<tr class="memdesc:ad1abfaf438998878eee537fc82b4bb6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> path.  <a href="#ad1abfaf438998878eee537fc82b4bb6e">More...</a><br /></td></tr>
<tr class="separator:ad1abfaf438998878eee537fc82b4bb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This object represents a file ready to be downloaded. </p>
<p>The file can be downloaded via the link <a href="https://api.telegram.org/file/bot">https://api.telegram.org/file/bot</a>&lt;token&gt;/&lt;file_path&gt;. 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 </p>

<p>Definition at line <a class="el" href="_file_8h_source.html#l00023">23</a> of file <a class="el" href="_file_8h_source.html">File.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ac47e9c73b9d762eef2322c0932c5a934"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::shared_ptr&lt;<a class="el" href="class_tg_bot_1_1_file.html">File</a>&gt; <a class="el" href="class_tg_bot_1_1_file.html#ac47e9c73b9d762eef2322c0932c5a934">TgBot::File::Ptr</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_file_8h_source.html#l00026">26</a> of file <a class="el" href="_file_8h_source.html">File.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0e64b7f89b84e674ea890399ea27dd6e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string TgBot::File::fileId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unique identifier for this file. </p>

<p>Definition at line <a class="el" href="_file_8h_source.html#l00031">31</a> of file <a class="el" href="_file_8h_source.html">File.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad1abfaf438998878eee537fc82b4bb6e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string TgBot::File::filePath</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> path. </p>
<p>Use <a href="https://api.telegram.org/file/bot">https://api.telegram.org/file/bot</a>&lt;token&gt;/&lt;file_path&gt; to get the file. </p>

<p>Definition at line <a class="el" href="_file_8h_source.html#l00043">43</a> of file <a class="el" href="_file_8h_source.html">File.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1c4a6f8d51e846ec75d15ffa2c5d1445"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t TgBot::File::fileSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Optional. <a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> size, if known. </p>

<p>Definition at line <a class="el" href="_file_8h_source.html#l00036">36</a> of file <a class="el" href="_file_8h_source.html">File.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/tgbot/types/<a class="el" href="_file_8h_source.html">File.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_file.html">File</a></li>
    <li class="footer">Generated on Fri Jun 22 2018 22:14:16 for tgbot-cpp by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>