diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_input_media.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_input_media.html | 333 |
1 files changed, 333 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_input_media.html b/docs/class_tg_bot_1_1_input_media.html new file mode 100644 index 0000000..b85c89b --- /dev/null +++ b/docs/class_tg_bot_1_1_input_media.html @@ -0,0 +1,333 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>tgbot-cpp: TgBot::InputMedia 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); +</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> +<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.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></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_input_media.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> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_input_media-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::InputMedia Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_input_media_8h_source.html">InputMedia.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for TgBot::InputMedia:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_tg_bot_1_1_input_media.png" usemap="#TgBot::InputMedia_map" alt=""/> + <map id="TgBot::InputMedia_map" name="TgBot::InputMedia_map"> +<area href="class_tg_bot_1_1_input_media_photo.html" alt="TgBot::InputMediaPhoto" shape="rect" coords="0,56,145,80"/> +<area href="class_tg_bot_1_1_input_media_video.html" alt="TgBot::InputMediaVideo" shape="rect" coords="155,56,300,80"/> +</map> + </div></div> +<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:a15b9867f0c1834b2a4d16ac48f25fb73"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> : uint8_t { <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TYPE::PHOTO</a>, +<a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18">TYPE::VIDEO</a> + }</td></tr> +<tr class="separator:a15b9867f0c1834b2a4d16ac48f25fb73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abdc38ae21d5213ead3720db082ef1f9c"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_input_media.html">InputMedia</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#abdc38ae21d5213ead3720db082ef1f9c">Ptr</a></td></tr> +<tr class="separator:abdc38ae21d5213ead3720db082ef1f9c"><td class="memSeparator" colspan="2"> </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:a8080040900519b706a367ecfd7b28226"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a8080040900519b706a367ecfd7b28226">type</a></td></tr> +<tr class="separator:a8080040900519b706a367ecfd7b28226"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3b06a5b4686339b58c4a95b5734b4b77"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a3b06a5b4686339b58c4a95b5734b4b77">media</a></td></tr> +<tr class="separator:a3b06a5b4686339b58c4a95b5734b4b77"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5fd875b292792f8d699d7bb678e68c90"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a5fd875b292792f8d699d7bb678e68c90">caption</a></td></tr> +<tr class="separator:a5fd875b292792f8d699d7bb678e68c90"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae2761ade0de31f96074d6760661c7edc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#ae2761ade0de31f96074d6760661c7edc">parseMode</a></td></tr> +<tr class="separator:ae2761ade0de31f96074d6760661c7edc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afa903b8b20fd1cf71b1f0510a4563a9a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#afa903b8b20fd1cf71b1f0510a4563a9a">width</a> = 0</td></tr> +<tr class="separator:afa903b8b20fd1cf71b1f0510a4563a9a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeac8eae9ef4e06fa0c67b98a8a8042f8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#aeac8eae9ef4e06fa0c67b98a8a8042f8">height</a> = 0</td></tr> +<tr class="separator:aeac8eae9ef4e06fa0c67b98a8a8042f8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aadf7e972c4ea70c771a0da27da4aa7cd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#aadf7e972c4ea70c771a0da27da4aa7cd">duration</a> = 0</td></tr> +<tr class="separator:aadf7e972c4ea70c771a0da27da4aa7cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0b8e0cc28a8283ca946b4aa5c5384a3b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a0b8e0cc28a8283ca946b4aa5c5384a3b">supportsStreaming</a> = false</td></tr> +<tr class="separator:a0b8e0cc28a8283ca946b4aa5c5384a3b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object represents the content of a media message to be sent. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00037">37</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="abdc38ae21d5213ead3720db082ef1f9c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abdc38ae21d5213ead3720db082ef1f9c">◆ </a></span>Ptr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_input_media.html">InputMedia</a>> <a class="el" href="class_tg_bot_1_1_input_media.html#abdc38ae21d5213ead3720db082ef1f9c">TgBot::InputMedia::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00039">39</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Enumeration Documentation</h2> +<a id="a15b9867f0c1834b2a4d16ac48f25fb73"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a15b9867f0c1834b2a4d16ac48f25fb73">◆ </a></span>TYPE</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TgBot::InputMedia::TYPE</a> : uint8_t</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">strong</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf"></a>PHOTO </td><td class="fielddoc"></td></tr> +<tr><td class="fieldname"><a id="a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18"></a>VIDEO </td><td class="fielddoc"></td></tr> +</table> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00041">41</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a5fd875b292792f8d699d7bb678e68c90"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5fd875b292792f8d699d7bb678e68c90">◆ </a></span>caption</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::InputMedia::caption</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Caption of the photo to be sent, 0-200 characters </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00059">59</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="aadf7e972c4ea70c771a0da27da4aa7cd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aadf7e972c4ea70c771a0da27da4aa7cd">◆ </a></span>duration</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::InputMedia::duration = 0</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> duration </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00079">79</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="aeac8eae9ef4e06fa0c67b98a8a8042f8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aeac8eae9ef4e06fa0c67b98a8a8042f8">◆ </a></span>height</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::InputMedia::height = 0</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> height </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00074">74</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="a3b06a5b4686339b58c4a95b5734b4b77"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3b06a5b4686339b58c4a95b5734b4b77">◆ </a></span>media</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::InputMedia::media</td> + </tr> + </table> +</div><div class="memdoc"> +<p><a class="el" href="class_tg_bot_1_1_file.html">File</a> 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. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00054">54</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="ae2761ade0de31f96074d6760661c7edc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae2761ade0de31f96074d6760661c7edc">◆ </a></span>parseMode</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::InputMedia::parseMode</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00064">64</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="a0b8e0cc28a8283ca946b4aa5c5384a3b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0b8e0cc28a8283ca946b4aa5c5384a3b">◆ </a></span>supportsStreaming</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::InputMedia::supportsStreaming = false</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Pass True, if the uploaded video is suitable for streaming </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00084">84</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="a8080040900519b706a367ecfd7b28226"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8080040900519b706a367ecfd7b28226">◆ </a></span>type</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> TgBot::InputMedia::type</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Type of the result, It should be one of <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TYPE::PHOTO</a>/TYPE::VIDEO </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00049">49</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> + +</div> +</div> +<a id="afa903b8b20fd1cf71b1f0510a4563a9a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afa903b8b20fd1cf71b1f0510a4563a9a">◆ </a></span>width</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::InputMedia::width = 0</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> width </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00069">69</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.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="_input_media_8h_source.html">InputMedia.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_input_media.html">InputMedia</a></li> + <li class="footer">Generated on Sun May 27 2018 22:44:47 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |