diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_api.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_api.html | 2201 |
1 files changed, 2201 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_api.html b/docs/class_tg_bot_1_1_api.html new file mode 100644 index 0000000..23be686 --- /dev/null +++ b/docs/class_tg_bot_1_1_api.html @@ -0,0 +1,2201 @@ +<!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::Api 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_api.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-methods">Public Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="class_tg_bot_1_1_api-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Api Class Reference<div class="ingroups"><a class="el" href="group__general.html">General</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_api_8h_source.html">Api.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ac0e4615a8944c07e7db3811ee84f2a94"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#ac0e4615a8944c07e7db3811ee84f2a94">Api</a> (const std::string &token)</td></tr> +<tr class="separator:ac0e4615a8944c07e7db3811ee84f2a94"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a566fcf52400de18737110edd7ab01535"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">User::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a566fcf52400de18737110edd7ab01535">getMe</a> () const</td></tr> +<tr class="separator:a566fcf52400de18737110edd7ab01535"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8d7ace74013fbe6803c1a4d8cda579e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a8d7ace74013fbe6803c1a4d8cda579e4">sendMessage</a> (int64_t chatId, const std::string &text, bool disableWebPagePreview=false, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), const std::string &parseMode="", bool disableNotification=false) const</td></tr> +<tr class="separator:a8d7ace74013fbe6803c1a4d8cda579e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf5818100f3529706d8aa888f3922594"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#acf5818100f3529706d8aa888f3922594">forwardMessage</a> (int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification=false) const</td></tr> +<tr class="separator:acf5818100f3529706d8aa888f3922594"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa78cb2f3053726f421d1cb8363d581f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#aa78cb2f3053726f421d1cb8363d581f5">sendPhoto</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &photo, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:aa78cb2f3053726f421d1cb8363d581f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a274bef0b2af3641c959b4ddbe03c012f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a274bef0b2af3641c959b4ddbe03c012f">sendPhoto</a> (int64_t chatId, const std::string &photoId, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a274bef0b2af3641c959b4ddbe03c012f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a95c614ace41968c47ce2236cd85d5c82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a95c614ace41968c47ce2236cd85d5c82">sendAudio</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &audio, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a95c614ace41968c47ce2236cd85d5c82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aadb18626cc502c6b16402eb04dd624db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#aadb18626cc502c6b16402eb04dd624db">sendAudio</a> (int64_t chatId, const std::string &audioId, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:aadb18626cc502c6b16402eb04dd624db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a771b4c3597217d5cbcdf1191693b3419"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a771b4c3597217d5cbcdf1191693b3419">sendDocument</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &document, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a771b4c3597217d5cbcdf1191693b3419"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acffc0358fc453207694e5517a92f5580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#acffc0358fc453207694e5517a92f5580">sendDocument</a> (int64_t chatId, const std::string &documentId, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:acffc0358fc453207694e5517a92f5580"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a334fd1983a78079b2ed3c9b107cf586f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a334fd1983a78079b2ed3c9b107cf586f">sendSticker</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &sticker, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a334fd1983a78079b2ed3c9b107cf586f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aefbe8faba25015d006fcbf0c8e1c5343"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#aefbe8faba25015d006fcbf0c8e1c5343">sendSticker</a> (int64_t chatId, const std::string &stickerId, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:aefbe8faba25015d006fcbf0c8e1c5343"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab9d31ba2b43f5e7df31c3fb023f48f95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#ab9d31ba2b43f5e7df31c3fb023f48f95">sendVideo</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &video, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:ab9d31ba2b43f5e7df31c3fb023f48f95"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7b1158a58e0c61f54ddbfddfae915d23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a7b1158a58e0c61f54ddbfddfae915d23">sendVideo</a> (int64_t chatId, const std::string &videoId, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a7b1158a58e0c61f54ddbfddfae915d23"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a96b602c6d2f0b5c140e6e64436244358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a96b602c6d2f0b5c140e6e64436244358">sendVoice</a> (int64_t chatId, const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &voice, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a96b602c6d2f0b5c140e6e64436244358"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a48be8349eed8be07e12ffbf0a2c47974"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a48be8349eed8be07e12ffbf0a2c47974">sendVoice</a> (int64_t chatId, const std::string &voiceId, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a48be8349eed8be07e12ffbf0a2c47974"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b72378c248c11739b4a2d86a3afd485"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a9b72378c248c11739b4a2d86a3afd485">sendLocation</a> (int64_t chatId, float latitude, float longitude, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>(), bool disableNotification=false) const</td></tr> +<tr class="separator:a9b72378c248c11739b4a2d86a3afd485"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4f88e34dec1960cb74514a632781b193"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a4f88e34dec1960cb74514a632781b193">sendVenue</a> (int64_t chatId, float latitude, float longitude, std::string title, std::string address, std::string foursquareId="", bool disableNotification=false, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()) const</td></tr> +<tr class="separator:a4f88e34dec1960cb74514a632781b193"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae40457b964cc05443c5e8aa0c5300f51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#ae40457b964cc05443c5e8aa0c5300f51">sendContact</a> (int64_t chatId, std::string phoneNumber, std::string firstName, std::string lastName="", bool disableNotification=false, int32_t replyToMessageId=0, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()) const</td></tr> +<tr class="separator:ae40457b964cc05443c5e8aa0c5300f51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a77fe17ad287f702bb021fc92575a0e2d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a77fe17ad287f702bb021fc92575a0e2d">sendChatAction</a> (int64_t chatId, const std::string &action) const</td></tr> +<tr class="separator:a77fe17ad287f702bb021fc92575a0e2d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa605f96bd5de1a3a432e14a160bac210"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_user_profile_photos.html#a734352c5b115ea29e639f01462187d55">UserProfilePhotos::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#aa605f96bd5de1a3a432e14a160bac210">getUserProfilePhotos</a> (int32_t userId, int32_t offset=0, int32_t limit=100) const</td></tr> +<tr class="separator:aa605f96bd5de1a3a432e14a160bac210"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abff10c92fa22a812d5bc17a068413709"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_file.html#ac47e9c73b9d762eef2322c0932c5a934">File::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#abff10c92fa22a812d5bc17a068413709">getFile</a> (int32_t fileId) const</td></tr> +<tr class="separator:abff10c92fa22a812d5bc17a068413709"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a28d6bda0f615ff1c7063905eb61b5cde"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a28d6bda0f615ff1c7063905eb61b5cde">leaveChat</a> (int64_t chatId) const</td></tr> +<tr class="separator:a28d6bda0f615ff1c7063905eb61b5cde"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad042b4d7f03f45eb59acb68085faaa23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_chat.html#a9818e295b599a08b77abefb38de75e48">Chat::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#ad042b4d7f03f45eb59acb68085faaa23">getChat</a> (int64_t chatId) const</td></tr> +<tr class="separator:ad042b4d7f03f45eb59acb68085faaa23"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2fd133b562c8bcad74d4b76e4fdbc5b8"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_tg_bot_1_1_chat_member.html#a7c14c867a129ac28396b680c79dc495d">ChatMember::Ptr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a2fd133b562c8bcad74d4b76e4fdbc5b8">getChatAdministrators</a> (int64_t chatId) const</td></tr> +<tr class="separator:a2fd133b562c8bcad74d4b76e4fdbc5b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a018da546747f0d34a5fa3bdb6a715a07"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a018da546747f0d34a5fa3bdb6a715a07">getChatMembersCount</a> (int64_t chatId) const</td></tr> +<tr class="separator:a018da546747f0d34a5fa3bdb6a715a07"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a648190cc90ed13172bc2327344d0e7f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_chat_member.html#a7c14c867a129ac28396b680c79dc495d">ChatMember::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a648190cc90ed13172bc2327344d0e7f6">getChatMember</a> (int64_t chatId, int32_t userId) const</td></tr> +<tr class="separator:a648190cc90ed13172bc2327344d0e7f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f73414941d8bb67ff3721a674274bf8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a2f73414941d8bb67ff3721a674274bf8">answerCallbackQuery</a> (const std::string &callbackQueryId, const std::string &text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const</td></tr> +<tr class="separator:a2f73414941d8bb67ff3721a674274bf8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4d6a7d6a90e82689de922b99ffe7b279"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a4d6a7d6a90e82689de922b99ffe7b279">editMessageText</a> (const std::string &text, int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", bool disableWebPagePreview=false, const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()) const</td></tr> +<tr class="separator:a4d6a7d6a90e82689de922b99ffe7b279"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7d8a296982d5c226cd2044c7cd3eff08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a7d8a296982d5c226cd2044c7cd3eff08">editMessageCaption</a> (int64_t chatId=0, int32_t messageId=0, const std::string &caption="", const std::string &inlineMessageId="", const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()) const</td></tr> +<tr class="separator:a7d8a296982d5c226cd2044c7cd3eff08"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1a9c38841dd135a6910f011f51f5a446"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a1a9c38841dd135a6910f011f51f5a446">editMessageReplyMarkup</a> (int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> &replyMarkup=<a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()) const</td></tr> +<tr class="separator:a1a9c38841dd135a6910f011f51f5a446"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd10abcfaf859c63cab0526b8c9179c9"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_tg_bot_1_1_update.html#abace63cf3605fe7a480a3bb839a672a8">Update::Ptr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#abd10abcfaf859c63cab0526b8c9179c9">getUpdates</a> (int32_t offset=0, int32_t limit=100, int32_t timeout=0, const StringArrayPtr &allowedUpdates=nullptr) const</td></tr> +<tr class="separator:abd10abcfaf859c63cab0526b8c9179c9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad961e1b605e9d6707c362ee046b9cfda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#ad961e1b605e9d6707c362ee046b9cfda">setWebhook</a> (const std::string &url="", const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> &certificate=nullptr, int32_t maxConnection=40, const StringArrayPtr &allowedUpdates=nullptr) const</td></tr> +<tr class="separator:ad961e1b605e9d6707c362ee046b9cfda"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8fbfde4234553c478987746c43b08e62"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a8fbfde4234553c478987746c43b08e62">deleteWebhook</a> () const</td></tr> +<tr class="separator:a8fbfde4234553c478987746c43b08e62"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a43bf35783ec4f9a03e46925e36fda24c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a2280093713d1304207d8bba2204648d6">WebhookInfo::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a43bf35783ec4f9a03e46925e36fda24c">getWebhookInfo</a> () const</td></tr> +<tr class="separator:a43bf35783ec4f9a03e46925e36fda24c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a430f9e036859250345d2125b7688a1f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a430f9e036859250345d2125b7688a1f9">answerInlineQuery</a> (const std::string &inlineQueryId, const std::vector< <a class="el" href="class_tg_bot_1_1_inline_query_result.html#af567dd95c4dae7c4a895e561a97ed4c5">InlineQueryResult::Ptr</a> > &results, int32_t cacheTime=300, bool isPersonal=false, const std::string &nextOffset="", const std::string &switchPmText="", const std::string &switchPmParameter="") const</td></tr> +<tr class="separator:a430f9e036859250345d2125b7688a1f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07c9bb7aa68a66bec54dd9bcf97875d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a07c9bb7aa68a66bec54dd9bcf97875d7">kickChatMember</a> (int64_t chatId, int32_t userId) const</td></tr> +<tr class="separator:a07c9bb7aa68a66bec54dd9bcf97875d7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a44ea670c4eecdf100f60be3c90911eec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#a44ea670c4eecdf100f60be3c90911eec">unbanChatMember</a> (int64_t chatId, int32_t userId) const</td></tr> +<tr class="separator:a44ea670c4eecdf100f60be3c90911eec"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:afb5d57ac6b56fe83e7894e3b686c3339"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_api.html#afb5d57ac6b56fe83e7894e3b686c3339">Bot</a></td></tr> +<tr class="separator:afb5d57ac6b56fe83e7894e3b686c3339"><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 class executes telegram api methods. Telegram docs: <a href="https://core.telegram.org/bots/api#available-methods">https://core.telegram.org/bots/api#available-methods</a> </p> + +<p class="definition">Definition at line <a class="el" href="_api_8h_source.html#l00052">52</a> of file <a class="el" href="_api_8h_source.html">Api.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ac0e4615a8944c07e7db3811ee84f2a94"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac0e4615a8944c07e7db3811ee84f2a94">◆ </a></span>Api()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TgBot::Api::Api </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>token</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a2f73414941d8bb67ff3721a674274bf8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2f73414941d8bb67ff3721a674274bf8">◆ </a></span>answerCallbackQuery()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::answerCallbackQuery </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>callbackQueryId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>text</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>showAlert</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>url</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>cacheTime</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">callbackQueryId</td><td>Unique identifier for the query to be answered </td></tr> + <tr><td class="paramname">text</td><td>Optional Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters </td></tr> + <tr><td class="paramname">showAlert</td><td>Optional If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. </td></tr> + <tr><td class="paramname">url</td><td>Optional URL that will be opened by the user's client. If you have created a Game and accepted the conditions via , specify the URL that opens your game – note that this will only work if the query comes from a callback_game button </td></tr> + <tr><td class="paramname">cacheTime</td><td>Optional The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl> + +</div> +</div> +<a id="a430f9e036859250345d2125b7688a1f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a430f9e036859250345d2125b7688a1f9">◆ </a></span>answerInlineQuery()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::answerInlineQuery </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>inlineQueryId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::vector< <a class="el" href="class_tg_bot_1_1_inline_query_result.html#af567dd95c4dae7c4a895e561a97ed4c5">InlineQueryResult::Ptr</a> > & </td> + <td class="paramname"><em>results</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>cacheTime</em> = <code>300</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>isPersonal</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>nextOffset</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>switchPmText</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>switchPmParameter</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send answers to an inline query. No mode that 50 results per query are allowed. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">inlineQueryId</td><td>Unique identifier for the answered query. </td></tr> + <tr><td class="paramname">results</td><td>Array of results for the inline query. </td></tr> + <tr><td class="paramname">cacheTime</td><td>The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. </td></tr> + <tr><td class="paramname">isPersonal</td><td>Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. </td></tr> + <tr><td class="paramname">nextOffset</td><td>Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. </td></tr> + <tr><td class="paramname">switchPmText</td><td>If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter </td></tr> + <tr><td class="paramname">switchPmParameter</td><td>Parameter for the start message sent to the bot when user presses the switch button </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl> + +</div> +</div> +<a id="a8fbfde4234553c478987746c43b08e62"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8fbfde4234553c478987746c43b08e62">◆ </a></span>deleteWebhook()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::deleteWebhook </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters. </p> + +</div> +</div> +<a id="a7d8a296982d5c226cd2044c7cd3eff08"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7d8a296982d5c226cd2044c7cd3eff08">◆ </a></span>editMessageCaption()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::editMessageCaption </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>messageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>inlineMessageId</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Optional Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format ) </td></tr> + <tr><td class="paramname">messageId</td><td>Optional Required if inline_message_id is not specified. Identifier of the sent message </td></tr> + <tr><td class="paramname">caption</td><td>Optional New caption of the message </td></tr> + <tr><td class="paramname">inlineMessageId</td><td>Optional Required if chat_id and message_id are not specified. Identifier of the inline message </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional A JSON-serialized object for an inline keyboard. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_message.html">Message</a> object on success, otherwise nullptr </dd></dl> + +</div> +</div> +<a id="a1a9c38841dd135a6910f011f51f5a446"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1a9c38841dd135a6910f011f51f5a446">◆ </a></span>editMessageReplyMarkup()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::editMessageReplyMarkup </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>messageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>inlineMessageId</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Optional Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format ) </td></tr> + <tr><td class="paramname">messageId</td><td>Optional Required if inline_message_id is not specified. Identifier of the sent message </td></tr> + <tr><td class="paramname">inlineMessageId</td><td>Optional Required if chat_id and message_id are not specified. Identifier of the inline message </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional A JSON-serialized object for an inline keyboard. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_message.html">Message</a> object on success, otherwise nullptr </dd></dl> + +</div> +</div> +<a id="a4d6a7d6a90e82689de922b99ffe7b279"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4d6a7d6a90e82689de922b99ffe7b279">◆ </a></span>editMessageText()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::editMessageText </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>text</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>messageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>inlineMessageId</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>parseMode</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableWebPagePreview</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to edit text and game messages sent by the bot or via the bot (for inline bots) </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">text</td><td>New text of the message </td></tr> + <tr><td class="paramname">chatId</td><td>Optional Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format ) </td></tr> + <tr><td class="paramname">messageId</td><td>Optional Required if inline_message_id is not specified. Identifier of the sent message </td></tr> + <tr><td class="paramname">inlineMessageId</td><td>Optional Required if chat_id and message_id are not specified. Identifier of the inline message </td></tr> + <tr><td class="paramname">parseMode</td><td>Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. </td></tr> + <tr><td class="paramname">disableWebPagePreview</td><td>Optional Disables link previews for links in this message </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional A JSON-serialized object for an inline keyboard. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_message.html">Message</a> object on success, otherwise nullptr </dd></dl> + +</div> +</div> +<a id="acf5818100f3529706d8aa888f3922594"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acf5818100f3529706d8aa888f3922594">◆ </a></span>forwardMessage()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::forwardMessage </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>fromChatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>messageId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to forward messages of any kind. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">fromChatId</td><td>Unique identifier for the chat where the original message was sent — <a class="el" href="class_tg_bot_1_1_user.html">User</a> or GroupChat id. </td></tr> + <tr><td class="paramname">messageId</td><td>Unique message identifier. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="ad042b4d7f03f45eb59acb68085faaa23"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad042b4d7f03f45eb59acb68085faaa23">◆ </a></span>getChat()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_chat.html#a9818e295b599a08b77abefb38de75e48">Chat::Ptr</a> TgBot::Api::getChat </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a <a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> object on success. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat or username of the target supergroup or channel (in the format ) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_chat.html">Chat</a> object. </dd></dl> + +</div> +</div> +<a id="a2fd133b562c8bcad74d4b76e4fdbc5b8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2fd133b562c8bcad74d4b76e4fdbc5b8">◆ </a></span>getChatAdministrators()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="class_tg_bot_1_1_chat_member.html#a7c14c867a129ac28396b680c79dc495d">ChatMember::Ptr</a>> TgBot::Api::getChatAdministrators </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get a list of administrators in a chat. On success, returns an Array of <a class="el" href="class_tg_bot_1_1_chat_member.html">ChatMember</a> objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat or username of the target supergroup or channel (in the format ) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_chat_member.html">ChatMember</a> object. </dd></dl> + +</div> +</div> +<a id="a648190cc90ed13172bc2327344d0e7f6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a648190cc90ed13172bc2327344d0e7f6">◆ </a></span>getChatMember()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_chat_member.html#a7c14c867a129ac28396b680c79dc495d">ChatMember::Ptr</a> TgBot::Api::getChatMember </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>userId</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get information about a member of a chat. Returns a <a class="el" href="class_tg_bot_1_1_chat_member.html">ChatMember</a> object on success. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat or username of the target supergroup or channel (in the format ) </td></tr> + <tr><td class="paramname">userId</td><td>Unique identifier of the target user </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tg_bot_1_1_chat_member.html">ChatMember</a> object. </dd></dl> + +</div> +</div> +<a id="a018da546747f0d34a5fa3bdb6a715a07"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a018da546747f0d34a5fa3bdb6a715a07">◆ </a></span>getChatMembersCount()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Api::getChatMembersCount </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get the number of members in a chat. Returns Int on success. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat or username of the target supergroup or channel (in the format ) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Int. </dd></dl> + +</div> +</div> +<a id="abff10c92fa22a812d5bc17a068413709"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abff10c92fa22a812d5bc17a068413709">◆ </a></span>getFile()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_file.html#ac47e9c73b9d762eef2322c0932c5a934">File::Ptr</a> TgBot::Api::getFile </td> + <td>(</td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>fileId</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">fileId</td><td><a class="el" href="class_tg_bot_1_1_file.html">File</a> identifier to get info about </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="class_tg_bot_1_1_file.html">File</a> object. </dd></dl> + +</div> +</div> +<a id="a566fcf52400de18737110edd7ab01535"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a566fcf52400de18737110edd7ab01535">◆ </a></span>getMe()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_user.html#ae6ea24aef677abaaf0fd7d60adf5be79">User::Ptr</a> TgBot::Api::getMe </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>A simple method for testing your bot's auth token. </p><dl class="section return"><dt>Returns</dt><dd>Basic information about the bot in form of a <a class="el" href="class_tg_bot_1_1_user.html">User</a> object. </dd></dl> + +</div> +</div> +<a id="abd10abcfaf859c63cab0526b8c9179c9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abd10abcfaf859c63cab0526b8c9179c9">◆ </a></span>getUpdates()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="class_tg_bot_1_1_update.html#abace63cf3605fe7a480a3bb839a672a8">Update::Ptr</a>> TgBot::Api::getUpdates </td> + <td>(</td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>offset</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>limit</em> = <code>100</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>timeout</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const StringArrayPtr & </td> + <td class="paramname"><em>allowedUpdates</em> = <code>nullptr</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to receive incoming updates using long polling. This method will not work if an outgoing webhook is set up. In order to avoid getting duplicate updates, recalculate offset after each server response. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">offset</td><td>Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. </td></tr> + <tr><td class="paramname">limit</td><td>Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. </td></tr> + <tr><td class="paramname">timeout</td><td>Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. </td></tr> + <tr><td class="paramname">allowed_updates</td><td>Optional. List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See <a class="el" href="class_tg_bot_1_1_update.html">Update</a> for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An Array of <a class="el" href="class_tg_bot_1_1_update.html">Update</a> objects </dd></dl> + +</div> +</div> +<a id="aa605f96bd5de1a3a432e14a160bac210"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa605f96bd5de1a3a432e14a160bac210">◆ </a></span>getUserProfilePhotos()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_user_profile_photos.html#a734352c5b115ea29e639f01462187d55">UserProfilePhotos::Ptr</a> TgBot::Api::getUserProfilePhotos </td> + <td>(</td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>userId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>offset</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>limit</em> = <code>100</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get a list of profile pictures for a user. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">userId</td><td>Unique identifier of the target user. </td></tr> + <tr><td class="paramname">offset</td><td>Optional. Sequential number of the first photo to be returned. By default, all photos are returned. </td></tr> + <tr><td class="paramname">limit</td><td>Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="class_tg_bot_1_1_user_profile_photos.html">UserProfilePhotos</a> object. </dd></dl> + +</div> +</div> +<a id="a43bf35783ec4f9a03e46925e36fda24c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a43bf35783ec4f9a03e46925e36fda24c">◆ </a></span>getWebhookInfo()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a2280093713d1304207d8bba2204648d6">WebhookInfo::Ptr</a> TgBot::Api::getWebhookInfo </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to get current webhook status. Requires no parameters. On success, returns a <a class="el" href="class_tg_bot_1_1_webhook_info.html">WebhookInfo</a> object. If the bot is using getUpdates, will return an object with the url field empty. </p> + +</div> +</div> +<a id="a07c9bb7aa68a66bec54dd9bcf97875d7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a07c9bb7aa68a66bec54dd9bcf97875d7">◆ </a></span>kickChatMember()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::kickChatMember </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>userId</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to kick a user from a group or a supergroup. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target group. </td></tr> + <tr><td class="paramname">userId</td><td>Unique identifier of the target user. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl> + +</div> +</div> +<a id="a28d6bda0f615ff1c7063905eb61b5cde"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a28d6bda0f615ff1c7063905eb61b5cde">◆ </a></span>leaveChat()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::leaveChat </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method for your bot to leave a group, supergroup or channel. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat or username of the target supergroup or channel (in the format ) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl> + +</div> +</div> +<a id="a95c614ace41968c47ce2236cd85d5c82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a95c614ace41968c47ce2236cd85d5c82">◆ </a></span>sendAudio() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendAudio </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>audio</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>performer</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>title</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as <a class="el" href="class_tg_bot_1_1_document.html">Document</a>). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">audio</td><td><a class="el" href="class_tg_bot_1_1_audio.html">Audio</a> to send. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_audio.html">Audio</a> caption, 0-200 characters </td></tr> + <tr><td class="paramname">duration</td><td>Duration of sent audio in seconds. </td></tr> + <tr><td class="paramname">performer</td><td>Performer </td></tr> + <tr><td class="paramname">title</td><td>Track name </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="aadb18626cc502c6b16402eb04dd624db"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aadb18626cc502c6b16402eb04dd624db">◆ </a></span>sendAudio() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendAudio </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>audioId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>performer</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>title</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as <a class="el" href="class_tg_bot_1_1_document.html">Document</a>). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">audio</td><td>Id of the audio that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_audio.html">Audio</a> caption, 0-200 characters </td></tr> + <tr><td class="paramname">duration</td><td>Duration of sent audio in seconds. </td></tr> + <tr><td class="paramname">performer</td><td>Performer </td></tr> + <tr><td class="paramname">title</td><td>Track name </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a77fe17ad287f702bb021fc92575a0e2d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a77fe17ad287f702bb021fc92575a0e2d">◆ </a></span>sendChatAction()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void TgBot::Api::sendChatAction </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>action</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">action</td><td>Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ae40457b964cc05443c5e8aa0c5300f51"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae40457b964cc05443c5e8aa0c5300f51">◆ </a></span>sendContact()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendContact </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>phoneNumber</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>firstName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>lastName</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send phone contacts. On success, the sent <a class="el" href="class_tg_bot_1_1_message.html">Message</a> is returned. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">phoneNumber</td><td><a class="el" href="class_tg_bot_1_1_contact.html">Contact</a>'s phone number. </td></tr> + <tr><td class="paramname">firstName</td><td><a class="el" href="class_tg_bot_1_1_contact.html">Contact</a>'s first name. </td></tr> + <tr><td class="paramname">lastName</td><td><a class="el" href="class_tg_bot_1_1_contact.html">Contact</a>'s last name. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a771b4c3597217d5cbcdf1191693b3419"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a771b4c3597217d5cbcdf1191693b3419">◆ </a></span>sendDocument() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendDocument </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>document</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send general files. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">document</td><td><a class="el" href="class_tg_bot_1_1_document.html">Document</a> to send. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_document.html">Document</a> caption (may also be used when resending documents by file_id), 0-200 characters </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="acffc0358fc453207694e5517a92f5580"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acffc0358fc453207694e5517a92f5580">◆ </a></span>sendDocument() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendDocument </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>documentId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send general files. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">document</td><td>Id of the document that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_document.html">Document</a> caption (may also be used when resending documents by file_id), 0-200 characters </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a9b72378c248c11739b4a2d86a3afd485"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9b72378c248c11739b4a2d86a3afd485">◆ </a></span>sendLocation()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendLocation </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>latitude</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>longitude</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send point on the map. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">latitude</td><td>Latitude of location. </td></tr> + <tr><td class="paramname">longitude</td><td>Longitude of location. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a8d7ace74013fbe6803c1a4d8cda579e4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8d7ace74013fbe6803c1a4d8cda579e4">◆ </a></span>sendMessage()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendMessage </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>text</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableWebPagePreview</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>parseMode</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send text messages. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">text</td><td>Text of the message to be sent. </td></tr> + <tr><td class="paramname">disableWebPagePreview</td><td>Optional. Disables link previews for links in this message. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">parseMode</td><td>Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="aa78cb2f3053726f421d1cb8363d581f5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa78cb2f3053726f421d1cb8363d581f5">◆ </a></span>sendPhoto() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendPhoto </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>photo</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send photos. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">photo</td><td>Photo to send. </td></tr> + <tr><td class="paramname">caption</td><td>Optional. Photo caption. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a274bef0b2af3641c959b4ddbe03c012f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a274bef0b2af3641c959b4ddbe03c012f">◆ </a></span>sendPhoto() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendPhoto </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>photoId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send photos. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">photo</td><td>Photo to send. Id of the photo that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">caption</td><td>Optional. Photo caption. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a334fd1983a78079b2ed3c9b107cf586f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a334fd1983a78079b2ed3c9b107cf586f">◆ </a></span>sendSticker() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendSticker </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>sticker</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send .webp stickers. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">sticker</td><td><a class="el" href="class_tg_bot_1_1_sticker.html">Sticker</a> to send. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="aefbe8faba25015d006fcbf0c8e1c5343"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aefbe8faba25015d006fcbf0c8e1c5343">◆ </a></span>sendSticker() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendSticker </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>stickerId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send .webp stickers. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">sticker</td><td>Id of the sticker that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a4f88e34dec1960cb74514a632781b193"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4f88e34dec1960cb74514a632781b193">◆ </a></span>sendVenue()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendVenue </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>latitude</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>longitude</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>title</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>foursquareId</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send information about a venue. On success, the sent <a class="el" href="class_tg_bot_1_1_message.html">Message</a> is returned. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">latitude</td><td>Latitude of location. </td></tr> + <tr><td class="paramname">longitude</td><td>Longitude of location. </td></tr> + <tr><td class="paramname">title</td><td>Name of the venue. </td></tr> + <tr><td class="paramname">address</td><td>Address of the venue. </td></tr> + <tr><td class="paramname">foursquare_id</td><td>Foursquare identifier of the venue. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="ab9d31ba2b43f5e7df31c3fb023f48f95"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab9d31ba2b43f5e7df31c3fb023f48f95">◆ </a></span>sendVideo() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendVideo </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>video</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>width</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>height</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as <a class="el" href="class_tg_bot_1_1_document.html">Document</a>). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">video</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> to send. </td></tr> + <tr><td class="paramname">duration</td><td>Duration of sent video in seconds </td></tr> + <tr><td class="paramname">width</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> width </td></tr> + <tr><td class="paramname">height</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> height </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> caption (may also be used when resending videos by file_id), 0-200 characters </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a7b1158a58e0c61f54ddbfddfae915d23"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7b1158a58e0c61f54ddbfddfae915d23">◆ </a></span>sendVideo() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendVideo </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>videoId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>width</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>height</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as <a class="el" href="class_tg_bot_1_1_document.html">Document</a>). </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">video</td><td>Id of the video that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">duration</td><td>Duration of sent video in seconds </td></tr> + <tr><td class="paramname">width</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> width </td></tr> + <tr><td class="paramname">height</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> height </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_video.html">Video</a> caption (may also be used when resending videos by file_id), 0-200 characters </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a96b602c6d2f0b5c140e6e64436244358"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a96b602c6d2f0b5c140e6e64436244358">◆ </a></span>sendVoice() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendVoice </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>voice</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">voice</td><td><a class="el" href="class_tg_bot_1_1_audio.html">Audio</a> file to send. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_voice.html">Voice</a> message caption, 0-200 characters </td></tr> + <tr><td class="paramname">duration</td><td>Duration of send audio in seconds. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="a48be8349eed8be07e12ffbf0a2c47974"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a48be8349eed8be07e12ffbf0a2c47974">◆ </a></span>sendVoice() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Api::sendVoice </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>voiceId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>caption</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>duration</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>replyToMessageId</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a> & </td> + <td class="paramname"><em>replyMarkup</em> = <code><a class="el" href="class_tg_bot_1_1_generic_reply.html#aa7bb5f2c5484cb791e1c60c346bbb06f">GenericReply::Ptr</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>disableNotification</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target chat. </td></tr> + <tr><td class="paramname">voiceId</td><td>Id of the voice that is already on the Telegram servers. </td></tr> + <tr><td class="paramname">caption</td><td><a class="el" href="class_tg_bot_1_1_voice.html">Voice</a> message caption, 0-200 characters </td></tr> + <tr><td class="paramname">duration</td><td>Duration of send audio in seconds. </td></tr> + <tr><td class="paramname">replyToMessageId</td><td>Optional. If the message is a reply, ID of the original message. </td></tr> + <tr><td class="paramname">replyMarkup</td><td>Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. </td></tr> + <tr><td class="paramname">disableNotification</td><td>Optional. Sends the message silenty. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>On success, the sent message is returned. </dd></dl> + +</div> +</div> +<a id="ad961e1b605e9d6707c362ee046b9cfda"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad961e1b605e9d6707c362ee046b9cfda">◆ </a></span>setWebhook()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void TgBot::Api::setWebhook </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>url</em> = <code>""</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_input_file.html#a9b1b7a8f913d9c4d4a389d9a4353d94f">InputFile::Ptr</a> & </td> + <td class="paramname"><em>certificate</em> = <code>nullptr</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>maxConnection</em> = <code>40</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const StringArrayPtr & </td> + <td class="paramname"><em>allowedUpdates</em> = <code>nullptr</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized <a class="el" href="class_tg_bot_1_1_update.html">Update</a>. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. We currently do not support self-signed certificates. Ports currently supported for Webhooks: 443, 80, 88, 8443. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">url</td><td>Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a44ea670c4eecdf100f60be3c90911eec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a44ea670c4eecdf100f60be3c90911eec">◆ </a></span>unbanChatMember()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::Api::unbanChatMember </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>chatId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>userId</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use this method to unban a previously kicked user in a supergroup. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">chatId</td><td>Unique identifier for the target group. </td></tr> + <tr><td class="paramname">userId</td><td>Unique identifier of the target user. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl> + +</div> +</div> +<h2 class="groupheader">Friends And Related Function Documentation</h2> +<a id="afb5d57ac6b56fe83e7894e3b686c3339"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afb5d57ac6b56fe83e7894e3b686c3339">◆ </a></span>Bot</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="class_tg_bot_1_1_bot.html">Bot</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_api_8h_source.html#l00056">56</a> of file <a class="el" href="_api_8h_source.html">Api.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/<a class="el" href="_api_8h_source.html">Api.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_api.html">Api</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46: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> |