diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_animation.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_animation.html | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_animation.html b/docs/class_tg_bot_1_1_animation.html new file mode 100644 index 0000000..7e9ef3d --- /dev/null +++ b/docs/class_tg_bot_1_1_animation.html @@ -0,0 +1,247 @@ +<!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::Animation 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_animation.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_animation-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Animation Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). + <a href="class_tg_bot_1_1_animation.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_animation_8h_source.html">Animation.h</a>></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:afc55b2a385eeb3209e91bbbd1214c06a"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_animation.html">Animation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#afc55b2a385eeb3209e91bbbd1214c06a">Ptr</a></td></tr> +<tr class="separator:afc55b2a385eeb3209e91bbbd1214c06a"><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:ad47a8d4e733fd4c89df680838ef88bf0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#ad47a8d4e733fd4c89df680838ef88bf0">fileId</a></td></tr> +<tr class="memdesc:ad47a8d4e733fd4c89df680838ef88bf0"><td class="mdescLeft"> </td><td class="mdescRight">Unique file identifier. <a href="#ad47a8d4e733fd4c89df680838ef88bf0">More...</a><br /></td></tr> +<tr class="separator:ad47a8d4e733fd4c89df680838ef88bf0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac8e9bb631206971b80674a71002ed8a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_photo_size.html#a05f58e05528a02e6bc98b67a81e8ae83">PhotoSize::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#ac8e9bb631206971b80674a71002ed8a5">thumb</a></td></tr> +<tr class="memdesc:ac8e9bb631206971b80674a71002ed8a5"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_animation.html" title="You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack fo...">Animation</a> thumbnail as defined by sender. <a href="#ac8e9bb631206971b80674a71002ed8a5">More...</a><br /></td></tr> +<tr class="separator:ac8e9bb631206971b80674a71002ed8a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a005529218689a10133d5c7b0482057df"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#a005529218689a10133d5c7b0482057df">fileName</a></td></tr> +<tr class="memdesc:a005529218689a10133d5c7b0482057df"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Original animation filename as defined by sender. <a href="#a005529218689a10133d5c7b0482057df">More...</a><br /></td></tr> +<tr class="separator:a005529218689a10133d5c7b0482057df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a112e29bf5a35ef1fc78f093cf7ecc48d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#a112e29bf5a35ef1fc78f093cf7ecc48d">mimeType</a></td></tr> +<tr class="memdesc:a112e29bf5a35ef1fc78f093cf7ecc48d"><td class="mdescLeft"> </td><td class="mdescRight">Optional. MIME type of the file as defined by sender. <a href="#a112e29bf5a35ef1fc78f093cf7ecc48d">More...</a><br /></td></tr> +<tr class="separator:a112e29bf5a35ef1fc78f093cf7ecc48d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4046931b2e47deae5ec6dc06d9b231da"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_animation.html#a4046931b2e47deae5ec6dc06d9b231da">fileSize</a></td></tr> +<tr class="memdesc:a4046931b2e47deae5ec6dc06d9b231da"><td class="mdescLeft"> </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. <a href="#a4046931b2e47deae5ec6dc06d9b231da">More...</a><br /></td></tr> +<tr class="separator:a4046931b2e47deae5ec6dc06d9b231da"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). </p> +<p>This object represents an animation file to be displayed in the message containing a game. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00041">41</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="afc55b2a385eeb3209e91bbbd1214c06a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afc55b2a385eeb3209e91bbbd1214c06a">◆ </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_animation.html">Animation</a>> <a class="el" href="class_tg_bot_1_1_animation.html#afc55b2a385eeb3209e91bbbd1214c06a">TgBot::Animation::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00043">43</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="ad47a8d4e733fd4c89df680838ef88bf0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad47a8d4e733fd4c89df680838ef88bf0">◆ </a></span>fileId</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Animation::fileId</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Unique file identifier. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00048">48</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> + +</div> +</div> +<a id="a005529218689a10133d5c7b0482057df"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a005529218689a10133d5c7b0482057df">◆ </a></span>fileName</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Animation::fileName</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Original animation filename as defined by sender. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00058">58</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> + +</div> +</div> +<a id="a4046931b2e47deae5ec6dc06d9b231da"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4046931b2e47deae5ec6dc06d9b231da">◆ </a></span>fileSize</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Animation::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. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00068">68</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> + +</div> +</div> +<a id="a112e29bf5a35ef1fc78f093cf7ecc48d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a112e29bf5a35ef1fc78f093cf7ecc48d">◆ </a></span>mimeType</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Animation::mimeType</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. MIME type of the file as defined by sender. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00063">63</a> of file <a class="el" href="_animation_8h_source.html">Animation.h</a>.</p> + +</div> +</div> +<a id="ac8e9bb631206971b80674a71002ed8a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac8e9bb631206971b80674a71002ed8a5">◆ </a></span>thumb</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_photo_size.html#a05f58e05528a02e6bc98b67a81e8ae83">PhotoSize::Ptr</a> TgBot::Animation::thumb</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. <a class="el" href="class_tg_bot_1_1_animation.html" title="You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack fo...">Animation</a> thumbnail as defined by sender. </p> + +<p class="definition">Definition at line <a class="el" href="_animation_8h_source.html#l00053">53</a> of file <a class="el" href="_animation_8h_source.html">Animation.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="_animation_8h_source.html">Animation.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_animation.html">Animation</a></li> + <li class="footer">Generated on Tue Jun 5 2018 19:07:15 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> |