diff options
| author | Oleg Morozenkov <reo7sp@users.noreply.github.com> | 2017-01-15 02:33:59 +0300 |
|---|---|---|
| committer | Oleg Morozenkov <reo7sp@users.noreply.github.com> | 2017-01-15 02:33:59 +0300 |
| commit | b22c20c4db8c35eaee99075d055f74697c5805b8 (patch) | |
| tree | b98fed35b212b5fdad9e03699658f769b3295424 /docs/d4/de1 | |
| parent | ae77f1220939915953419f232d4fc6441c88f96c (diff) | |
Docs
Diffstat (limited to 'docs/d4/de1')
| -rw-r--r-- | docs/d4/de1/class_tg_bot_1_1_force_reply.html | 194 | ||||
| -rw-r--r-- | docs/d4/de1/class_tg_bot_1_1_force_reply.js | 6 | ||||
| -rw-r--r-- | docs/d4/de1/class_tg_bot_1_1_force_reply.png | bin | 0 -> 599 bytes |
3 files changed, 200 insertions, 0 deletions
diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.html b/docs/d4/de1/class_tg_bot_1_1_force_reply.html new file mode 100644 index 0000000..4b716cc --- /dev/null +++ b/docs/d4/de1/class_tg_bot_1_1_force_reply.html @@ -0,0 +1,194 @@ +<!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::ForceReply 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('d4/de1/class_tg_bot_1_1_force_reply.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="../../d0/db4/class_tg_bot_1_1_force_reply-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::ForceReply Class Reference<div class="ingroups"><a class="el" href="../../d6/d59/group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="../../d5/dfd/_force_reply_8h_source.html">ForceReply.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for TgBot::ForceReply:</div> +<div class="dyncontent"> + <div class="center"> + <img src="../../d4/de1/class_tg_bot_1_1_force_reply.png" usemap="#TgBot::ForceReply_map" alt=""/> + <map id="TgBot::ForceReply_map" name="TgBot::ForceReply_map"> +<area href="../../d2/d60/class_tg_bot_1_1_generic_reply.html" alt="TgBot::GenericReply" shape="rect" coords="0,0,127,24"/> +</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:a3d17d51e17dfdfd22d263bdeaf603b66"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html">ForceReply</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html#a3d17d51e17dfdfd22d263bdeaf603b66">Ptr</a></td></tr> +<tr class="separator:a3d17d51e17dfdfd22d263bdeaf603b66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_types_class_tg_bot_1_1_generic_reply"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_tg_bot_1_1_generic_reply')"><img src="../../closed.png" alt="-"/> Public Types inherited from <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">TgBot::GenericReply</a></td></tr> +<tr class="memitem:aa7bb5f2c5484cb791e1c60c346bbb06f inherit pub_types_class_tg_bot_1_1_generic_reply"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">GenericReply</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">Ptr</a></td></tr> +<tr class="separator:aa7bb5f2c5484cb791e1c60c346bbb06f inherit pub_types_class_tg_bot_1_1_generic_reply"><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:a8c4637ab74050185a86f5c058cf35de7"><td class="memItemLeft" align="right" valign="top">const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html#a8c4637ab74050185a86f5c058cf35de7">forceReply</a> = true</td></tr> +<tr class="separator:a8c4637ab74050185a86f5c058cf35de7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afbb510a24ebda5409311ff0d385065dc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html#afbb510a24ebda5409311ff0d385065dc">selective</a> = false</td></tr> +<tr class="separator:afbb510a24ebda5409311ff0d385065dc"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_methods_class_tg_bot_1_1_generic_reply"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_tg_bot_1_1_generic_reply')"><img src="../../closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html">TgBot::GenericReply</a></td></tr> +<tr class="memitem:a519019da5ab3cb27fc11bd56cc94123c inherit pub_methods_class_tg_bot_1_1_generic_reply"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d60/class_tg_bot_1_1_generic_reply.html#a519019da5ab3cb27fc11bd56cc94123c">~GenericReply</a> ()</td></tr> +<tr class="separator:a519019da5ab3cb27fc11bd56cc94123c inherit pub_methods_class_tg_bot_1_1_generic_reply"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll: Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish. Guide the user through a step-by-step process. ‘Please send me your question’, ‘Cool, now let’s add the first answer option‘, ’Great. Keep adding answer options, then send /done when you‘re ready’. The last option is definitely more attractive. And if you use <a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html">ForceReply</a> in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user. </p> + +<p class="definition">Definition at line <a class="el" href="../../d5/dfd/_force_reply_8h_source.html#l00040">40</a> of file <a class="el" href="../../d5/dfd/_force_reply_8h_source.html">ForceReply.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a3d17d51e17dfdfd22d263bdeaf603b66"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3d17d51e17dfdfd22d263bdeaf603b66">◆ </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="../../d4/de1/class_tg_bot_1_1_force_reply.html">ForceReply</a>> <a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html#a3d17d51e17dfdfd22d263bdeaf603b66">TgBot::ForceReply::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="../../d5/dfd/_force_reply_8h_source.html#l00043">43</a> of file <a class="el" href="../../d5/dfd/_force_reply_8h_source.html">ForceReply.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a8c4637ab74050185a86f5c058cf35de7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8c4637ab74050185a86f5c058cf35de7">◆ </a></span>forceReply</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const bool TgBot::ForceReply::forceReply = true</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' </p> + +<p class="definition">Definition at line <a class="el" href="../../d5/dfd/_force_reply_8h_source.html#l00048">48</a> of file <a class="el" href="../../d5/dfd/_force_reply_8h_source.html">ForceReply.h</a>.</p> + +</div> +</div> +<a id="afbb510a24ebda5409311ff0d385065dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afbb510a24ebda5409311ff0d385065dc">◆ </a></span>selective</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::ForceReply::selective = false</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are in the text of the <a class="el" href="../../d6/dce/class_tg_bot_1_1_message.html">Message</a> object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. </p> + +<p class="definition">Definition at line <a class="el" href="../../d5/dfd/_force_reply_8h_source.html#l00053">53</a> of file <a class="el" href="../../d5/dfd/_force_reply_8h_source.html">ForceReply.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="../../d5/dfd/_force_reply_8h_source.html">ForceReply.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="../../d8/d9d/namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="../../d4/de1/class_tg_bot_1_1_force_reply.html">ForceReply</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:33:16 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> diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.js b/docs/d4/de1/class_tg_bot_1_1_force_reply.js new file mode 100644 index 0000000..5dacec4 --- /dev/null +++ b/docs/d4/de1/class_tg_bot_1_1_force_reply.js @@ -0,0 +1,6 @@ +var class_tg_bot_1_1_force_reply = +[ + [ "Ptr", "d4/de1/class_tg_bot_1_1_force_reply.html#a3d17d51e17dfdfd22d263bdeaf603b66", null ], + [ "forceReply", "d4/de1/class_tg_bot_1_1_force_reply.html#a8c4637ab74050185a86f5c058cf35de7", null ], + [ "selective", "d4/de1/class_tg_bot_1_1_force_reply.html#afbb510a24ebda5409311ff0d385065dc", null ] +];
\ No newline at end of file diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.png b/docs/d4/de1/class_tg_bot_1_1_force_reply.png Binary files differnew file mode 100644 index 0000000..55f4b9d --- /dev/null +++ b/docs/d4/de1/class_tg_bot_1_1_force_reply.png |
