diff options
| author | JellyBrick <shlee1503@naver.com> | 2018-06-22 22:15:42 +0900 |
|---|---|---|
| committer | JellyBrick <shlee1503@naver.com> | 2018-06-22 22:15:42 +0900 |
| commit | 3e5a28fa0a1ba2d461271f22399476c241bcffe3 (patch) | |
| tree | 91786e1a0b268678153fca0ef03c1e26549a077f /docs/_input_media_8h_source.html | |
| parent | e2871c54a71a8015923b8215816c2a81e1b0c209 (diff) | |
Regenerate docs
Diffstat (limited to 'docs/_input_media_8h_source.html')
| -rw-r--r-- | docs/_input_media_8h_source.html | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/docs/_input_media_8h_source.html b/docs/_input_media_8h_source.html new file mode 100644 index 0000000..e804c60 --- /dev/null +++ b/docs/_input_media_8h_source.html @@ -0,0 +1,136 @@ +<!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: include/tgbot/types/InputMedia.h Source File</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 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</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('_input_media_8h_source.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="headertitle"> +<div class="title">InputMedia.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_input_media_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015 Oleg Morozenkov</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2016 Konstantin Kukin</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2018 JellyBrick</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef TGBOT_INPUTMEDIA_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define TGBOT_INPUTMEDIA_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespace_tg_bot.html">TgBot</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="class_tg_bot_1_1_input_media.html">InputMedia</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#abdc38ae21d5213ead3720db082ef1f9c"> 40</a></span>  <span class="keyword">typedef</span> std::shared_ptr<InputMedia> <a class="code" href="class_tg_bot_1_1_input_media.html#abdc38ae21d5213ead3720db082ef1f9c">Ptr</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73"> 42</a></span>  <span class="keyword">enum class</span> <a class="code" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> : uint8_t {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">PHOTO</a>,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18">VIDEO</a></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#a8080040900519b706a367ecfd7b28226"> 50</a></span>  <a class="code" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> <a class="code" href="class_tg_bot_1_1_input_media.html#a8080040900519b706a367ecfd7b28226">type</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#a3b06a5b4686339b58c4a95b5734b4b77"> 55</a></span>  std::string <a class="code" href="class_tg_bot_1_1_input_media.html#a3b06a5b4686339b58c4a95b5734b4b77">media</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#a5fd875b292792f8d699d7bb678e68c90"> 60</a></span>  std::string <a class="code" href="class_tg_bot_1_1_input_media.html#a5fd875b292792f8d699d7bb678e68c90">caption</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#ae2761ade0de31f96074d6760661c7edc"> 65</a></span>  std::string <a class="code" href="class_tg_bot_1_1_input_media.html#ae2761ade0de31f96074d6760661c7edc">parseMode</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#afa903b8b20fd1cf71b1f0510a4563a9a"> 70</a></span>  int32_t <a class="code" href="class_tg_bot_1_1_input_media.html#afa903b8b20fd1cf71b1f0510a4563a9a">width</a> = 0;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#aeac8eae9ef4e06fa0c67b98a8a8042f8"> 75</a></span>  int32_t <a class="code" href="class_tg_bot_1_1_input_media.html#aeac8eae9ef4e06fa0c67b98a8a8042f8">height</a> = 0;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#aadf7e972c4ea70c771a0da27da4aa7cd"> 80</a></span>  int32_t <a class="code" href="class_tg_bot_1_1_input_media.html#aadf7e972c4ea70c771a0da27da4aa7cd">duration</a> = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="class_tg_bot_1_1_input_media.html#a0b8e0cc28a8283ca946b4aa5c5384a3b"> 85</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_tg_bot_1_1_input_media.html#a0b8e0cc28a8283ca946b4aa5c5384a3b">supportsStreaming</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> };</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif //TGBOT_INPUTMEDIA_H</span></div><div class="ttc" id="class_tg_bot_1_1_input_media_html_aadf7e972c4ea70c771a0da27da4aa7cd"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#aadf7e972c4ea70c771a0da27da4aa7cd">TgBot::InputMedia::duration</a></div><div class="ttdeci">int32_t duration</div><div class="ttdoc">Optional. Video duration. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00080">InputMedia.h:80</a></div></div> +<div class="ttc" id="namespace_tg_bot_html"><div class="ttname"><a href="namespace_tg_bot.html">TgBot</a></div><div class="ttdef"><b>Definition:</b> <a href="_api_8h_source.html#l00049">Api.h:49</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_afa903b8b20fd1cf71b1f0510a4563a9a"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#afa903b8b20fd1cf71b1f0510a4563a9a">TgBot::InputMedia::width</a></div><div class="ttdeci">int32_t width</div><div class="ttdoc">Optional. Video width. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00070">InputMedia.h:70</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html">TgBot::InputMedia</a></div><div class="ttdoc">This object represents the content of a media message to be sent. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00038">InputMedia.h:38</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18">TgBot::InputMedia::TYPE::VIDEO</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a5fd875b292792f8d699d7bb678e68c90"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a5fd875b292792f8d699d7bb678e68c90">TgBot::InputMedia::caption</a></div><div class="ttdeci">std::string caption</div><div class="ttdoc">Optional. Caption of the photo to be sent, 0-200 characters. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00060">InputMedia.h:60</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_aeac8eae9ef4e06fa0c67b98a8a8042f8"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#aeac8eae9ef4e06fa0c67b98a8a8042f8">TgBot::InputMedia::height</a></div><div class="ttdeci">int32_t height</div><div class="ttdoc">Optional. Video height. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00075">InputMedia.h:75</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a8080040900519b706a367ecfd7b28226"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a8080040900519b706a367ecfd7b28226">TgBot::InputMedia::type</a></div><div class="ttdeci">TYPE type</div><div class="ttdoc">Type of the result, It should be one of TYPE::PHOTO/TYPE::VIDEO. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00050">InputMedia.h:50</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TgBot::InputMedia::TYPE::PHOTO</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a0b8e0cc28a8283ca946b4aa5c5384a3b"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a0b8e0cc28a8283ca946b4aa5c5384a3b">TgBot::InputMedia::supportsStreaming</a></div><div class="ttdeci">bool supportsStreaming</div><div class="ttdoc">Optional. Pass True, if the uploaded video is suitable for streaming. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00085">InputMedia.h:85</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_abdc38ae21d5213ead3720db082ef1f9c"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#abdc38ae21d5213ead3720db082ef1f9c">TgBot::InputMedia::Ptr</a></div><div class="ttdeci">std::shared_ptr< InputMedia > Ptr</div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00040">InputMedia.h:40</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a15b9867f0c1834b2a4d16ac48f25fb73"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TgBot::InputMedia::TYPE</a></div><div class="ttdeci">TYPE</div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00042">InputMedia.h:42</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_a3b06a5b4686339b58c4a95b5734b4b77"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#a3b06a5b4686339b58c4a95b5734b4b77">TgBot::InputMedia::media</a></div><div class="ttdeci">std::string media</div><div class="ttdoc">File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. </div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00055">InputMedia.h:55</a></div></div> +<div class="ttc" id="class_tg_bot_1_1_input_media_html_ae2761ade0de31f96074d6760661c7edc"><div class="ttname"><a href="class_tg_bot_1_1_input_media.html#ae2761ade0de31f96074d6760661c7edc">TgBot::InputMedia::parseMode</a></div><div class="ttdeci">std::string parseMode</div><div class="ttdoc">Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or ...</div><div class="ttdef"><b>Definition:</b> <a href="_input_media_8h_source.html#l00065">InputMedia.h:65</a></div></div> +</div><!-- fragment --></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_25b26b9fa3b0bd1537052b03f43dd617.html">tgbot</a></li><li class="navelem"><a class="el" href="dir_edd914e3fbf8e89da3c33d1968dd487e.html">types</a></li><li class="navelem"><a class="el" href="_input_media_8h.html">InputMedia.h</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> |