diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_input_media.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_input_media.html | 61 |
1 files changed, 40 insertions, 21 deletions
diff --git a/docs/class_tg_bot_1_1_input_media.html b/docs/class_tg_bot_1_1_input_media.html index 5113f1d..0ed23bf 100644 --- a/docs/class_tg_bot_1_1_input_media.html +++ b/docs/class_tg_bot_1_1_input_media.html @@ -88,6 +88,9 @@ $(document).ready(function(){initNavTree('class_tg_bot_1_1_input_media.html','') </div><!--header--> <div class="contents"> +<p>This object represents the content of a media message to be sent. + <a href="class_tg_bot_1_1_input_media.html#details">More...</a></p> + <p><code>#include <<a class="el" href="_input_media_8h_source.html">InputMedia.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TgBot::InputMedia:</div> @@ -95,8 +98,8 @@ Inheritance diagram for TgBot::InputMedia:</div> <div class="center"> <img src="class_tg_bot_1_1_input_media.png" usemap="#TgBot::InputMedia_map" alt=""/> <map id="TgBot::InputMedia_map" name="TgBot::InputMedia_map"> -<area href="class_tg_bot_1_1_input_media_photo.html" alt="TgBot::InputMediaPhoto" shape="rect" coords="0,56,145,80"/> -<area href="class_tg_bot_1_1_input_media_video.html" alt="TgBot::InputMediaVideo" shape="rect" coords="155,56,300,80"/> +<area href="class_tg_bot_1_1_input_media_photo.html" title="Represents a photo to be sent. " alt="TgBot::InputMediaPhoto" shape="rect" coords="0,56,145,80"/> +<area href="class_tg_bot_1_1_input_media_video.html" title="Represents a video to be sent. " alt="TgBot::InputMediaVideo" shape="rect" coords="155,56,300,80"/> </map> </div></div> <table class="memberdecls"> @@ -112,26 +115,34 @@ Public Types</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a8080040900519b706a367ecfd7b28226"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73">TYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a8080040900519b706a367ecfd7b28226">type</a></td></tr> +<tr class="memdesc:a8080040900519b706a367ecfd7b28226"><td class="mdescLeft"> </td><td class="mdescRight">Type of the result, It should be one of <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TYPE::PHOTO</a>/TYPE::VIDEO. <a href="#a8080040900519b706a367ecfd7b28226">More...</a><br /></td></tr> <tr class="separator:a8080040900519b706a367ecfd7b28226"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3b06a5b4686339b58c4a95b5734b4b77"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a3b06a5b4686339b58c4a95b5734b4b77">media</a></td></tr> +<tr class="memdesc:a3b06a5b4686339b58c4a95b5734b4b77"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. <a href="#a3b06a5b4686339b58c4a95b5734b4b77">More...</a><br /></td></tr> <tr class="separator:a3b06a5b4686339b58c4a95b5734b4b77"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5fd875b292792f8d699d7bb678e68c90"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a5fd875b292792f8d699d7bb678e68c90">caption</a></td></tr> +<tr class="memdesc:a5fd875b292792f8d699d7bb678e68c90"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Caption of the photo to be sent, 0-200 characters. <a href="#a5fd875b292792f8d699d7bb678e68c90">More...</a><br /></td></tr> <tr class="separator:a5fd875b292792f8d699d7bb678e68c90"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae2761ade0de31f96074d6760661c7edc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#ae2761ade0de31f96074d6760661c7edc">parseMode</a></td></tr> +<tr class="memdesc:ae2761ade0de31f96074d6760661c7edc"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. <a href="#ae2761ade0de31f96074d6760661c7edc">More...</a><br /></td></tr> <tr class="separator:ae2761ade0de31f96074d6760661c7edc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afa903b8b20fd1cf71b1f0510a4563a9a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#afa903b8b20fd1cf71b1f0510a4563a9a">width</a> = 0</td></tr> +<tr class="memdesc:afa903b8b20fd1cf71b1f0510a4563a9a"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> width. <a href="#afa903b8b20fd1cf71b1f0510a4563a9a">More...</a><br /></td></tr> <tr class="separator:afa903b8b20fd1cf71b1f0510a4563a9a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeac8eae9ef4e06fa0c67b98a8a8042f8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#aeac8eae9ef4e06fa0c67b98a8a8042f8">height</a> = 0</td></tr> +<tr class="memdesc:aeac8eae9ef4e06fa0c67b98a8a8042f8"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> height. <a href="#aeac8eae9ef4e06fa0c67b98a8a8042f8">More...</a><br /></td></tr> <tr class="separator:aeac8eae9ef4e06fa0c67b98a8a8042f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aadf7e972c4ea70c771a0da27da4aa7cd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#aadf7e972c4ea70c771a0da27da4aa7cd">duration</a> = 0</td></tr> +<tr class="memdesc:aadf7e972c4ea70c771a0da27da4aa7cd"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> duration. <a href="#aadf7e972c4ea70c771a0da27da4aa7cd">More...</a><br /></td></tr> <tr class="separator:aadf7e972c4ea70c771a0da27da4aa7cd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0b8e0cc28a8283ca946b4aa5c5384a3b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_input_media.html#a0b8e0cc28a8283ca946b4aa5c5384a3b">supportsStreaming</a> = false</td></tr> +<tr class="memdesc:a0b8e0cc28a8283ca946b4aa5c5384a3b"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Pass True, if the uploaded video is suitable for streaming. <a href="#a0b8e0cc28a8283ca946b4aa5c5384a3b">More...</a><br /></td></tr> <tr class="separator:a0b8e0cc28a8283ca946b4aa5c5384a3b"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This object represents the content of a media message to be sent. </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00037">37</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00038">38</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a id="abdc38ae21d5213ead3720db082ef1f9c"></a> <h2 class="memtitle"><span class="permalink"><a href="#abdc38ae21d5213ead3720db082ef1f9c">◆ </a></span>Ptr</h2> @@ -145,7 +156,7 @@ Public Attributes</h2></td></tr> </table> </div><div class="memdoc"> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00039">39</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00040">40</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -174,7 +185,7 @@ Public Attributes</h2></td></tr> <tr><td class="fieldname"><a id="a15b9867f0c1834b2a4d16ac48f25fb73ae60ae31f67ab883c746bb71c7a145c18"></a>VIDEO </td><td class="fielddoc"></td></tr> </table> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00041">41</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00042">42</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -190,9 +201,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. Caption of the photo to be sent, 0-200 characters </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00059">59</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Optional. Caption of the photo to be sent, 0-200 characters. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00060">60</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -207,9 +219,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> duration </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00079">79</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> duration. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00080">80</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -224,9 +237,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> height </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00074">74</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> height. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00075">75</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -241,9 +255,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p><a class="el" href="class_tg_bot_1_1_file.html">File</a> to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00054">54</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p><a class="el" href="class_tg_bot_1_1_file.html" title="This object represents a file ready to be downloaded. ">File</a> to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00055">55</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -258,9 +273,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> + <p>Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00064">64</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00065">65</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -275,9 +291,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. Pass True, if the uploaded video is suitable for streaming </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00084">84</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Optional. Pass True, if the uploaded video is suitable for streaming. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00085">85</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -292,9 +309,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Type of the result, It should be one of <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TYPE::PHOTO</a>/TYPE::VIDEO </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00049">49</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Type of the result, It should be one of <a class="el" href="class_tg_bot_1_1_input_media.html#a15b9867f0c1834b2a4d16ac48f25fb73ac6c7e64f7c3b7e4c031d022f232298bf">TYPE::PHOTO</a>/TYPE::VIDEO. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00050">50</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -309,9 +327,10 @@ Public Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html">Video</a> width </p> -<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00069">69</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> +<p>Optional. <a class="el" href="class_tg_bot_1_1_video.html" title="This object represents a video file. ">Video</a> width. </p> + +<p class="definition">Definition at line <a class="el" href="_input_media_8h_source.html#l00070">70</a> of file <a class="el" href="_input_media_8h_source.html">InputMedia.h</a>.</p> </div> </div> @@ -324,7 +343,7 @@ Public Attributes</h2></td></tr> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_input_media.html">InputMedia</a></li> - <li class="footer">Generated on Mon May 28 2018 13:57:33 for tgbot-cpp by + <li class="footer">Generated on Tue Jun 5 2018 19:07:15 for tgbot-cpp by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> |