From 778f0c54bce8186ace310c70bdd797aa0d759869 Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 15 May 2017 00:25:15 +0300 Subject: Update docs --- docs/_api_8h.html | 2 +- docs/_api_8h_source.html | 5 +- docs/_audio_8h.html | 2 +- docs/_audio_8h_source.html | 2 +- docs/_bot_8h.html | 2 +- docs/_bot_8h_source.html | 2 +- docs/_callback_query_8h.html | 2 +- docs/_callback_query_8h_source.html | 2 +- docs/_chat_8h.html | 2 +- docs/_chat_8h_source.html | 2 +- docs/_chat_member_8h.html | 2 +- docs/_chat_member_8h_source.html | 2 +- docs/_chosen_inline_result_8h.html | 2 +- docs/_chosen_inline_result_8h_source.html | 2 +- docs/_contact_8h.html | 2 +- docs/_contact_8h_source.html | 2 +- docs/_document_8h.html | 2 +- docs/_document_8h_source.html | 2 +- docs/_event_broadcaster_8h.html | 2 +- docs/_event_broadcaster_8h_source.html | 2 +- docs/_event_handler_8h.html | 2 +- docs/_event_handler_8h_source.html | 2 +- docs/_file_8h.html | 2 +- docs/_file_8h_source.html | 2 +- docs/_file_tools_8h.html | 2 +- docs/_file_tools_8h_source.html | 2 +- docs/_force_reply_8h.html | 2 +- docs/_force_reply_8h_source.html | 2 +- docs/_generic_reply_8h.html | 2 +- docs/_generic_reply_8h_source.html | 2 +- docs/_http_client_8h.html | 2 +- docs/_http_client_8h_source.html | 2 +- docs/_http_parser_8h.html | 2 +- docs/_http_parser_8h_source.html | 2 +- docs/_http_req_arg_8h.html | 2 +- docs/_http_req_arg_8h_source.html | 2 +- docs/_http_server_8h.html | 2 +- docs/_http_server_8h_source.html | 2 +- docs/_inline_keyboard_button_8h.html | 2 +- docs/_inline_keyboard_button_8h_source.html | 2 +- docs/_inline_keyboard_markup_8h.html | 2 +- docs/_inline_keyboard_markup_8h_source.html | 2 +- docs/_inline_query_8h.html | 2 +- docs/_inline_query_8h_source.html | 2 +- docs/_inline_query_result_8h.html | 2 +- docs/_inline_query_result_8h_source.html | 2 +- docs/_inline_query_result_article_8h.html | 2 +- docs/_inline_query_result_article_8h_source.html | 2 +- docs/_inline_query_result_audio_8h.html | 2 +- docs/_inline_query_result_audio_8h_source.html | 2 +- docs/_inline_query_result_cached_audio_8h.html | 2 +- ...inline_query_result_cached_audio_8h_source.html | 2 +- docs/_inline_query_result_cached_document_8h.html | 2 +- ...ine_query_result_cached_document_8h_source.html | 2 +- docs/_inline_query_result_cached_gif_8h.html | 2 +- .../_inline_query_result_cached_gif_8h_source.html | 2 +- docs/_inline_query_result_cached_mpeg4_gif_8h.html | 2 +- ...ne_query_result_cached_mpeg4_gif_8h_source.html | 2 +- docs/_inline_query_result_cached_photo_8h.html | 2 +- ...inline_query_result_cached_photo_8h_source.html | 2 +- docs/_inline_query_result_cached_sticker_8h.html | 2 +- ...line_query_result_cached_sticker_8h_source.html | 2 +- docs/_inline_query_result_cached_video_8h.html | 2 +- ...inline_query_result_cached_video_8h_source.html | 2 +- docs/_inline_query_result_cached_voice_8h.html | 2 +- ...inline_query_result_cached_voice_8h_source.html | 2 +- docs/_inline_query_result_contact_8h.html | 2 +- docs/_inline_query_result_contact_8h_source.html | 2 +- docs/_inline_query_result_document_8h.html | 2 +- docs/_inline_query_result_document_8h_source.html | 2 +- docs/_inline_query_result_game_8h.html | 2 +- docs/_inline_query_result_game_8h_source.html | 2 +- docs/_inline_query_result_gif_8h.html | 2 +- docs/_inline_query_result_gif_8h_source.html | 2 +- docs/_inline_query_result_location_8h.html | 2 +- docs/_inline_query_result_location_8h_source.html | 2 +- docs/_inline_query_result_mpeg4_gif_8h.html | 2 +- docs/_inline_query_result_mpeg4_gif_8h_source.html | 2 +- docs/_inline_query_result_photo_8h.html | 2 +- docs/_inline_query_result_photo_8h_source.html | 2 +- docs/_inline_query_result_venue_8h.html | 2 +- docs/_inline_query_result_venue_8h_source.html | 2 +- docs/_inline_query_result_video_8h.html | 2 +- docs/_inline_query_result_video_8h_source.html | 2 +- docs/_inline_query_result_voice_8h.html | 2 +- docs/_inline_query_result_voice_8h_source.html | 2 +- docs/_input_contact_message_content_8h.html | 2 +- docs/_input_contact_message_content_8h_source.html | 2 +- docs/_input_file_8h.html | 2 +- docs/_input_file_8h_source.html | 2 +- docs/_input_location_message_content_8h.html | 2 +- .../_input_location_message_content_8h_source.html | 2 +- docs/_input_message_content_8h.html | 2 +- docs/_input_message_content_8h_source.html | 2 +- docs/_input_text_message_content_8h.html | 2 +- docs/_input_text_message_content_8h_source.html | 2 +- docs/_input_venue_message_content_8h.html | 2 +- docs/_input_venue_message_content_8h_source.html | 2 +- docs/_keyboard_button_8h.html | 2 +- docs/_keyboard_button_8h_source.html | 2 +- docs/_location_8h.html | 2 +- docs/_location_8h_source.html | 2 +- docs/_message_8h.html | 2 +- docs/_message_8h_source.html | 2 +- docs/_message_entity_8h.html | 2 +- docs/_message_entity_8h_source.html | 2 +- docs/_photo_size_8h.html | 2 +- docs/_photo_size_8h_source.html | 2 +- docs/_reply_keyboard_markup_8h.html | 2 +- docs/_reply_keyboard_markup_8h_source.html | 2 +- docs/_reply_keyboard_remove_8h.html | 2 +- docs/_reply_keyboard_remove_8h_source.html | 2 +- docs/_response_parameters_8h.html | 2 +- docs/_response_parameters_8h_source.html | 2 +- docs/_sticker_8h.html | 2 +- docs/_sticker_8h_source.html | 2 +- docs/_string_tools_8h.html | 2 +- docs/_string_tools_8h_source.html | 2 +- docs/_tg_exception_8h.html | 2 +- docs/_tg_exception_8h_source.html | 2 +- docs/_tg_long_poll_8h.html | 2 +- docs/_tg_long_poll_8h_source.html | 2 +- docs/_tg_type_parser_8h.html | 2 +- docs/_tg_type_parser_8h_source.html | 2 +- docs/_tg_webhook_local_server_8h.html | 2 +- docs/_tg_webhook_local_server_8h_source.html | 2 +- docs/_tg_webhook_server_8h.html | 2 +- docs/_tg_webhook_server_8h_source.html | 2 +- docs/_tg_webhook_tcp_server_8h.html | 2 +- docs/_tg_webhook_tcp_server_8h_source.html | 2 +- docs/_update_8h.html | 2 +- docs/_update_8h_source.html | 2 +- docs/_url_8h.html | 2 +- docs/_url_8h_source.html | 2 +- docs/_user_8h.html | 2 +- docs/_user_8h_source.html | 2 +- docs/_user_profile_photos_8h.html | 2 +- docs/_user_profile_photos_8h_source.html | 2 +- docs/_venue_8h.html | 2 +- docs/_venue_8h_source.html | 2 +- docs/_video_8h.html | 2 +- docs/_video_8h_source.html | 2 +- docs/_voice_8h.html | 2 +- docs/_voice_8h_source.html | 2 +- docs/_webhook_info_8h.html | 2 +- docs/_webhook_info_8h_source.html | 2 +- docs/annotated.html | 2 +- docs/class_tg_bot_1_1_api-members.html | 75 +++++++++++---------- docs/class_tg_bot_1_1_api.html | 39 ++++++++++- docs/class_tg_bot_1_1_api.js | 1 + docs/class_tg_bot_1_1_audio-members.html | 2 +- docs/class_tg_bot_1_1_audio.html | 2 +- docs/class_tg_bot_1_1_bot-members.html | 2 +- docs/class_tg_bot_1_1_bot.html | 2 +- docs/class_tg_bot_1_1_callback_query-members.html | 2 +- docs/class_tg_bot_1_1_callback_query.html | 2 +- docs/class_tg_bot_1_1_chat-members.html | 2 +- docs/class_tg_bot_1_1_chat.html | 2 +- docs/class_tg_bot_1_1_chat_member-members.html | 2 +- docs/class_tg_bot_1_1_chat_member.html | 2 +- ...ss_tg_bot_1_1_chosen_inline_result-members.html | 2 +- docs/class_tg_bot_1_1_chosen_inline_result.html | 2 +- docs/class_tg_bot_1_1_contact-members.html | 2 +- docs/class_tg_bot_1_1_contact.html | 2 +- docs/class_tg_bot_1_1_document-members.html | 2 +- docs/class_tg_bot_1_1_document.html | 2 +- ...class_tg_bot_1_1_event_broadcaster-members.html | 2 +- docs/class_tg_bot_1_1_event_broadcaster.html | 2 +- docs/class_tg_bot_1_1_event_handler-members.html | 2 +- docs/class_tg_bot_1_1_event_handler.html | 2 +- docs/class_tg_bot_1_1_file-members.html | 2 +- docs/class_tg_bot_1_1_file.html | 2 +- docs/class_tg_bot_1_1_force_reply-members.html | 2 +- docs/class_tg_bot_1_1_force_reply.html | 2 +- docs/class_tg_bot_1_1_generic_reply-members.html | 2 +- docs/class_tg_bot_1_1_generic_reply.html | 2 +- docs/class_tg_bot_1_1_http_client-members.html | 2 +- docs/class_tg_bot_1_1_http_client.html | 2 +- docs/class_tg_bot_1_1_http_parser-members.html | 2 +- docs/class_tg_bot_1_1_http_parser.html | 2 +- docs/class_tg_bot_1_1_http_req_arg-members.html | 2 +- docs/class_tg_bot_1_1_http_req_arg.html | 2 +- docs/class_tg_bot_1_1_http_server-members.html | 2 +- docs/class_tg_bot_1_1_http_server.html | 2 +- ...bot_1_1_http_server_1_1_connection-members.html | 2 +- ...lass_tg_bot_1_1_http_server_1_1_connection.html | 2 +- ..._tg_bot_1_1_inline_keyboard_button-members.html | 2 +- docs/class_tg_bot_1_1_inline_keyboard_button.html | 2 +- ..._tg_bot_1_1_inline_keyboard_markup-members.html | 2 +- docs/class_tg_bot_1_1_inline_keyboard_markup.html | 2 +- docs/class_tg_bot_1_1_inline_query-members.html | 2 +- docs/class_tg_bot_1_1_inline_query.html | 2 +- ...ass_tg_bot_1_1_inline_query_result-members.html | 2 +- docs/class_tg_bot_1_1_inline_query_result.html | 2 +- ...ot_1_1_inline_query_result_article-members.html | 2 +- ...ass_tg_bot_1_1_inline_query_result_article.html | 2 +- ..._bot_1_1_inline_query_result_audio-members.html | 2 +- ...class_tg_bot_1_1_inline_query_result_audio.html | 2 +- ...1_inline_query_result_cached_audio-members.html | 2 +- ...g_bot_1_1_inline_query_result_cached_audio.html | 2 +- ...nline_query_result_cached_document-members.html | 2 +- ...ot_1_1_inline_query_result_cached_document.html | 2 +- ...1_1_inline_query_result_cached_gif-members.html | 2 +- ..._tg_bot_1_1_inline_query_result_cached_gif.html | 2 +- ...line_query_result_cached_mpeg4_gif-members.html | 2 +- ...t_1_1_inline_query_result_cached_mpeg4_gif.html | 2 +- ...1_inline_query_result_cached_photo-members.html | 2 +- ...g_bot_1_1_inline_query_result_cached_photo.html | 2 +- ...inline_query_result_cached_sticker-members.html | 2 +- ...bot_1_1_inline_query_result_cached_sticker.html | 2 +- ...1_inline_query_result_cached_video-members.html | 2 +- ...g_bot_1_1_inline_query_result_cached_video.html | 2 +- ...1_inline_query_result_cached_voice-members.html | 2 +- ...g_bot_1_1_inline_query_result_cached_voice.html | 2 +- ...ot_1_1_inline_query_result_contact-members.html | 2 +- ...ass_tg_bot_1_1_inline_query_result_contact.html | 2 +- ...t_1_1_inline_query_result_document-members.html | 2 +- ...ss_tg_bot_1_1_inline_query_result_document.html | 2 +- ...g_bot_1_1_inline_query_result_game-members.html | 2 +- .../class_tg_bot_1_1_inline_query_result_game.html | 2 +- ...tg_bot_1_1_inline_query_result_gif-members.html | 2 +- docs/class_tg_bot_1_1_inline_query_result_gif.html | 2 +- ...t_1_1_inline_query_result_location-members.html | 2 +- ...ss_tg_bot_1_1_inline_query_result_location.html | 2 +- ..._1_1_inline_query_result_mpeg4_gif-members.html | 2 +- ...s_tg_bot_1_1_inline_query_result_mpeg4_gif.html | 2 +- ..._bot_1_1_inline_query_result_photo-members.html | 2 +- ...class_tg_bot_1_1_inline_query_result_photo.html | 2 +- ..._bot_1_1_inline_query_result_venue-members.html | 2 +- ...class_tg_bot_1_1_inline_query_result_venue.html | 2 +- ..._bot_1_1_inline_query_result_video-members.html | 2 +- ...class_tg_bot_1_1_inline_query_result_video.html | 2 +- ..._bot_1_1_inline_query_result_voice-members.html | 2 +- ...class_tg_bot_1_1_inline_query_result_voice.html | 2 +- ..._1_1_input_contact_message_content-members.html | 2 +- ...s_tg_bot_1_1_input_contact_message_content.html | 2 +- docs/class_tg_bot_1_1_input_file-members.html | 2 +- docs/class_tg_bot_1_1_input_file.html | 2 +- ...1_1_input_location_message_content-members.html | 2 +- ..._tg_bot_1_1_input_location_message_content.html | 2 +- ...s_tg_bot_1_1_input_message_content-members.html | 2 +- docs/class_tg_bot_1_1_input_message_content.html | 2 +- ...bot_1_1_input_text_message_content-members.html | 2 +- ...lass_tg_bot_1_1_input_text_message_content.html | 2 +- ...ot_1_1_input_venue_message_content-members.html | 2 +- ...ass_tg_bot_1_1_input_venue_message_content.html | 2 +- docs/class_tg_bot_1_1_keyboard_button-members.html | 2 +- docs/class_tg_bot_1_1_keyboard_button.html | 2 +- docs/class_tg_bot_1_1_location-members.html | 2 +- docs/class_tg_bot_1_1_location.html | 2 +- docs/class_tg_bot_1_1_message-members.html | 2 +- docs/class_tg_bot_1_1_message.html | 2 +- docs/class_tg_bot_1_1_message_entity-members.html | 2 +- docs/class_tg_bot_1_1_message_entity.html | 2 +- docs/class_tg_bot_1_1_photo_size-members.html | 2 +- docs/class_tg_bot_1_1_photo_size.html | 2 +- ...s_tg_bot_1_1_reply_keyboard_markup-members.html | 2 +- docs/class_tg_bot_1_1_reply_keyboard_markup.html | 2 +- ...s_tg_bot_1_1_reply_keyboard_remove-members.html | 2 +- docs/class_tg_bot_1_1_reply_keyboard_remove.html | 2 +- ...ass_tg_bot_1_1_response_parameters-members.html | 2 +- docs/class_tg_bot_1_1_response_parameters.html | 2 +- docs/class_tg_bot_1_1_sticker-members.html | 2 +- docs/class_tg_bot_1_1_sticker.html | 2 +- docs/class_tg_bot_1_1_tg_exception-members.html | 2 +- docs/class_tg_bot_1_1_tg_exception.html | 2 +- docs/class_tg_bot_1_1_tg_long_poll-members.html | 2 +- docs/class_tg_bot_1_1_tg_long_poll.html | 2 +- docs/class_tg_bot_1_1_tg_type_parser-members.html | 2 +- docs/class_tg_bot_1_1_tg_type_parser.html | 2 +- ...class_tg_bot_1_1_tg_webhook_server-members.html | 2 +- docs/class_tg_bot_1_1_tg_webhook_server.html | 2 +- ...s_tg_bot_1_1_tg_webhook_tcp_server-members.html | 2 +- docs/class_tg_bot_1_1_tg_webhook_tcp_server.html | 2 +- docs/class_tg_bot_1_1_update-members.html | 2 +- docs/class_tg_bot_1_1_update.html | 2 +- docs/class_tg_bot_1_1_url-members.html | 2 +- docs/class_tg_bot_1_1_url.html | 2 +- docs/class_tg_bot_1_1_user-members.html | 2 +- docs/class_tg_bot_1_1_user.html | 2 +- ...ass_tg_bot_1_1_user_profile_photos-members.html | 2 +- docs/class_tg_bot_1_1_user_profile_photos.html | 2 +- docs/class_tg_bot_1_1_venue-members.html | 2 +- docs/class_tg_bot_1_1_venue.html | 2 +- docs/class_tg_bot_1_1_video-members.html | 2 +- docs/class_tg_bot_1_1_video.html | 2 +- docs/class_tg_bot_1_1_voice-members.html | 2 +- docs/class_tg_bot_1_1_voice.html | 2 +- docs/class_tg_bot_1_1_webhook_info-members.html | 2 +- docs/class_tg_bot_1_1_webhook_info.html | 2 +- docs/classes.html | 2 +- docs/dir_25b26b9fa3b0bd1537052b03f43dd617.html | 2 +- docs/dir_933963de0e9d7c93f6217fb7d7e6c3ad.html | 2 +- docs/dir_d3a0916884c776a83ed0f419714df887.html | 2 +- docs/dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- docs/dir_edd914e3fbf8e89da3c33d1968dd487e.html | 2 +- docs/files.html | 2 +- docs/functions.html | 2 +- docs/functions_0x7e.html | 2 +- docs/functions_a.html | 2 +- docs/functions_b.html | 2 +- docs/functions_c.html | 2 +- docs/functions_d.html | 5 +- docs/functions_e.html | 2 +- docs/functions_enum.html | 2 +- docs/functions_f.html | 2 +- docs/functions_func.html | 2 +- docs/functions_func_0x7e.html | 2 +- docs/functions_func_b.html | 2 +- docs/functions_func_c.html | 2 +- docs/functions_func_d.html | 5 +- docs/functions_func_e.html | 2 +- docs/functions_func_f.html | 2 +- docs/functions_func_g.html | 2 +- docs/functions_func_h.html | 2 +- docs/functions_func_i.html | 2 +- docs/functions_func_k.html | 2 +- docs/functions_func_l.html | 2 +- docs/functions_func_m.html | 2 +- docs/functions_func_o.html | 2 +- docs/functions_func_p.html | 2 +- docs/functions_func_s.html | 2 +- docs/functions_func_t.html | 2 +- docs/functions_func_u.html | 2 +- docs/functions_g.html | 2 +- docs/functions_h.html | 2 +- docs/functions_i.html | 2 +- docs/functions_j.html | 2 +- docs/functions_k.html | 2 +- docs/functions_l.html | 2 +- docs/functions_m.html | 2 +- docs/functions_n.html | 2 +- docs/functions_o.html | 2 +- docs/functions_p.html | 2 +- docs/functions_q.html | 2 +- docs/functions_r.html | 2 +- docs/functions_rela.html | 2 +- docs/functions_s.html | 2 +- docs/functions_t.html | 8 +-- docs/functions_type.html | 2 +- docs/functions_u.html | 2 +- docs/functions_v.html | 2 +- docs/functions_vars.html | 2 +- docs/functions_vars_a.html | 2 +- docs/functions_vars_c.html | 2 +- docs/functions_vars_d.html | 2 +- docs/functions_vars_e.html | 2 +- docs/functions_vars_f.html | 2 +- docs/functions_vars_g.html | 2 +- docs/functions_vars_h.html | 2 +- docs/functions_vars_i.html | 2 +- docs/functions_vars_k.html | 2 +- docs/functions_vars_l.html | 2 +- docs/functions_vars_m.html | 2 +- docs/functions_vars_n.html | 2 +- docs/functions_vars_o.html | 2 +- docs/functions_vars_p.html | 2 +- docs/functions_vars_q.html | 2 +- docs/functions_vars_r.html | 2 +- docs/functions_vars_s.html | 2 +- docs/functions_vars_t.html | 2 +- docs/functions_vars_u.html | 2 +- docs/functions_vars_v.html | 2 +- docs/functions_vars_w.html | 2 +- docs/functions_w.html | 2 +- docs/group__general.html | 2 +- docs/group__general.js | 1 + docs/group__net.html | 2 +- docs/group__tools.html | 2 +- docs/group__types.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 2 +- docs/modules.html | 2 +- docs/namespace_file_tools.html | 2 +- docs/namespace_string_tools.html | 2 +- docs/namespace_tg_bot.html | 2 +- docs/namespacemembers.html | 2 +- docs/namespacemembers_func.html | 2 +- docs/namespaces.html | 2 +- docs/navtreedata.js | 6 +- docs/navtreeindex0.js | 78 +++++++++++----------- docs/navtreeindex1.js | 4 +- docs/navtreeindex2.js | 4 +- docs/navtreeindex3.js | 9 +-- docs/search/all_14.js | 2 +- docs/search/all_15.js | 2 +- docs/search/all_4.js | 1 + docs/search/all_d.js | 2 +- docs/search/functions_3.js | 1 + docs/search/variables_12.js | 2 +- docs/tgbot_8h.html | 2 +- docs/tgbot_8h_source.html | 2 +- 392 files changed, 522 insertions(+), 474 deletions(-) (limited to 'docs') diff --git a/docs/_api_8h.html b/docs/_api_8h.html index e51b73d..0ccbcf8 100644 --- a/docs/_api_8h.html +++ b/docs/_api_8h.html @@ -120,7 +120,7 @@ Namespaces
-Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Oleg Morozenkov
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 
23 #ifndef TGBOT_CPP_API_H
24 #define TGBOT_CPP_API_H
25 
26 #include <string>
27 #include <vector>
28 
29 #include <boost/property_tree/ptree.hpp>
30 
31 #include "tgbot/net/HttpReqArg.h"
32 #include "tgbot/types/User.h"
33 #include "tgbot/types/Message.h"
34 #include "tgbot/types/GenericReply.h"
35 #include "tgbot/types/InputFile.h"
36 #include "tgbot/types/UserProfilePhotos.h"
37 #include "tgbot/types/Update.h"
38 #include "tgbot/types/InlineQueryResult.h"
39 #include "tgbot/types/Venue.h"
40 #include "tgbot/types/WebhookInfo.h"
41 #include "tgbot/types/ChatMember.h"
42 #include "tgbot/types/File.h"
43 
44 namespace TgBot {
45 
46 class Bot;
47 
52 class Api {
53 
54 typedef std::shared_ptr<std::vector<std::string>> StringArrayPtr;
55 
56 friend class Bot;
57 
58 public:
59  Api(const std::string& token);
60 
65  User::Ptr getMe() const;
66 
78  Message::Ptr sendMessage(int64_t chatId, const std::string& text, bool disableWebPagePreview = false, int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), const std::string& parseMode = "", bool disableNotification = false) const;
79 
88  Message::Ptr forwardMessage(int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification = false) const;
89 
100  Message::Ptr sendPhoto(int64_t chatId, const InputFile::Ptr photo, const std::string& caption = "", int32_t replyToMessageId = 0,
101  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
102 
113  Message::Ptr sendPhoto(int64_t chatId, const std::string& photoId, const std::string& caption = "", int32_t replyToMessageId = 0,
114  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
115 
129  Message::Ptr sendAudio(int64_t chatId, const InputFile::Ptr audio, const std::string &caption = "", int32_t duration = 0,
130  const std::string& performer = "", const std::string& title = "", int32_t replyToMessageId = 0,
131  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
132 
146  Message::Ptr sendAudio(int64_t chatId, const std::string& audioId, const std::string &caption = "", int32_t duration = 0,
147  const std::string& performer = "", const std::string& title = "", int32_t replyToMessageId = 0,
148  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
149 
160  Message::Ptr sendDocument(int64_t chatId, const InputFile::Ptr document, const std::string &caption = "", int32_t replyToMessageId = 0,
161  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
162 
173  Message::Ptr sendDocument(int64_t chatId, const std::string& documentId, const std::string &caption = "", int32_t replyToMessageId = 0,
174  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
175 
185  Message::Ptr sendSticker(int64_t chatId, const InputFile::Ptr sticker, int32_t replyToMessageId = 0,
186  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
187 
197  Message::Ptr sendSticker(int64_t chatId, const std::string& stickerId, int32_t replyToMessageId = 0,
198  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
199 
213  Message::Ptr sendVideo(int64_t chatId, const InputFile::Ptr video, int32_t duration = 0, int32_t width = 0, int32_t height = 0, const std::string &caption = "",
214  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
215 
229  Message::Ptr sendVideo(int64_t chatId, const std::string& videoId, int32_t duration = 0, int32_t width = 0, int32_t height = 0, const std::string &caption = "",
230  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
231 
243  Message::Ptr sendVoice(int64_t chatId, const InputFile::Ptr voice, const std::string &caption = "", int duration = 0, int32_t replyToMessageId = 0,
244  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
245 
257  Message::Ptr sendVoice(int64_t chatId, const std::string& voiceId, const std::string &caption = "", int duration = 0, int32_t replyToMessageId = 0,
258  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
259 
270  Message::Ptr sendLocation(int64_t chatId, float latitude, float longitude, int32_t replyToMessageId = 0,
271  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
272 
286  Message::Ptr sendVenue(int64_t chatId, float latitude, float longitude, std::string title, std::string address, std::string foursquareId = "",
287  bool disableNotification = false, int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
288 
300  Message::Ptr sendContact(int64_t chatId, std::string phoneNumber, std::string firstName, std::string lastName = "", bool disableNotification = false,
301  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
302 
310  void sendChatAction(int64_t chatId, const std::string& action) const;
311 
319  UserProfilePhotos::Ptr getUserProfilePhotos(int32_t userId, int32_t offset = 0, int32_t limit = 100) const;
320 
326  File::Ptr getFile(const std::string &fileId) const;
327 
333  bool leaveChat(int64_t chatId) const;
334 
340  Chat::Ptr getChat(int64_t chatId) const;
341 
347  std::vector<ChatMember::Ptr> getChatAdministrators(int64_t chatId) const;
348 
354  int32_t getChatMembersCount(int64_t chatId) const;
355 
362  ChatMember::Ptr getChatMember(int64_t chatId, int32_t userId) const;
363 
373  bool answerCallbackQuery(const std::string & callbackQueryId, const std::string & text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const;
374 
386  Message::Ptr editMessageText(const std::string& text, int64_t chatId=0, int32_t messageId=0, const std::string& inlineMessageId="",
387  const std::string& parseMode = "", bool disableWebPagePreview = false, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
388 
398  Message::Ptr editMessageCaption(int64_t chatId = 0, int32_t messageId = 0, const std::string& caption = "",
399  const std::string& inlineMessageId = "", const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
400 
409  Message::Ptr editMessageReplyMarkup(int64_t chatId = 0, int32_t messageId = 0, const std::string& inlineMessageId = "",
410  const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
411 
422  std::vector<Update::Ptr> getUpdates(int32_t offset = 0, int32_t limit = 100, int32_t timeout = 0, const StringArrayPtr &allowedUpdates = nullptr) const;
423 
432  void setWebhook(const std::string& url = "", const InputFile::Ptr certificate = nullptr, int32_t maxConnection = 40, const StringArrayPtr &allowedUpdates = nullptr) const;
433 
438  bool deleteWebhook() const;
439 
445  WebhookInfo::Ptr getWebhookInfo() const;
446 
459  bool answerInlineQuery(const std::string& inlineQueryId, const std::vector<InlineQueryResult::Ptr>& results,
460  int32_t cacheTime=300, bool isPersonal=false, const std::string& nextOffset="", const std::string& switchPmText="", const std::string& switchPmParameter="") const;
461 
468  bool kickChatMember(int64_t chatId, int32_t userId) const;
469 
476  bool unbanChatMember(int64_t chatId, int32_t userId) const;
477 
484  std::string downloadFile(const std::string& filePath, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const;
485 
486 private:
487  boost::property_tree::ptree sendRequest(const std::string& method, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const;
488 
489  const std::string _token;
490 };
491 
492 }
493 
494 #endif //TGBOT_CPP_API_H
TgBot::Api::getChat
Chat::Ptr getChat(int64_t chatId) const
+Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Oleg Morozenkov
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 
23 #ifndef TGBOT_CPP_API_H
24 #define TGBOT_CPP_API_H
25 
26 #include <string>
27 #include <vector>
28 
29 #include <boost/property_tree/ptree.hpp>
30 
31 #include "tgbot/net/HttpReqArg.h"
32 #include "tgbot/types/User.h"
33 #include "tgbot/types/Message.h"
34 #include "tgbot/types/GenericReply.h"
35 #include "tgbot/types/InputFile.h"
36 #include "tgbot/types/UserProfilePhotos.h"
37 #include "tgbot/types/Update.h"
38 #include "tgbot/types/InlineQueryResult.h"
39 #include "tgbot/types/Venue.h"
40 #include "tgbot/types/WebhookInfo.h"
41 #include "tgbot/types/ChatMember.h"
42 #include "tgbot/types/File.h"
43 
44 namespace TgBot {
45 
46 class Bot;
47 
52 class Api {
53 
54 typedef std::shared_ptr<std::vector<std::string>> StringArrayPtr;
55 
56 friend class Bot;
57 
58 public:
59  Api(const std::string& token);
60 
65  User::Ptr getMe() const;
66 
78  Message::Ptr sendMessage(int64_t chatId, const std::string& text, bool disableWebPagePreview = false, int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), const std::string& parseMode = "", bool disableNotification = false) const;
79 
88  Message::Ptr forwardMessage(int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification = false) const;
89 
100  Message::Ptr sendPhoto(int64_t chatId, const InputFile::Ptr photo, const std::string& caption = "", int32_t replyToMessageId = 0,
101  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
102 
113  Message::Ptr sendPhoto(int64_t chatId, const std::string& photoId, const std::string& caption = "", int32_t replyToMessageId = 0,
114  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
115 
129  Message::Ptr sendAudio(int64_t chatId, const InputFile::Ptr audio, const std::string &caption = "", int32_t duration = 0,
130  const std::string& performer = "", const std::string& title = "", int32_t replyToMessageId = 0,
131  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
132 
146  Message::Ptr sendAudio(int64_t chatId, const std::string& audioId, const std::string &caption = "", int32_t duration = 0,
147  const std::string& performer = "", const std::string& title = "", int32_t replyToMessageId = 0,
148  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
149 
160  Message::Ptr sendDocument(int64_t chatId, const InputFile::Ptr document, const std::string &caption = "", int32_t replyToMessageId = 0,
161  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
162 
173  Message::Ptr sendDocument(int64_t chatId, const std::string& documentId, const std::string &caption = "", int32_t replyToMessageId = 0,
174  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
175 
185  Message::Ptr sendSticker(int64_t chatId, const InputFile::Ptr sticker, int32_t replyToMessageId = 0,
186  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
187 
197  Message::Ptr sendSticker(int64_t chatId, const std::string& stickerId, int32_t replyToMessageId = 0,
198  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
199 
213  Message::Ptr sendVideo(int64_t chatId, const InputFile::Ptr video, int32_t duration = 0, int32_t width = 0, int32_t height = 0, const std::string &caption = "",
214  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
215 
229  Message::Ptr sendVideo(int64_t chatId, const std::string& videoId, int32_t duration = 0, int32_t width = 0, int32_t height = 0, const std::string &caption = "",
230  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
231 
243  Message::Ptr sendVoice(int64_t chatId, const InputFile::Ptr voice, const std::string &caption = "", int duration = 0, int32_t replyToMessageId = 0,
244  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
245 
257  Message::Ptr sendVoice(int64_t chatId, const std::string& voiceId, const std::string &caption = "", int duration = 0, int32_t replyToMessageId = 0,
258  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
259 
270  Message::Ptr sendLocation(int64_t chatId, float latitude, float longitude, int32_t replyToMessageId = 0,
271  const GenericReply::Ptr replyMarkup = GenericReply::Ptr(), bool disableNotification = false) const;
272 
286  Message::Ptr sendVenue(int64_t chatId, float latitude, float longitude, std::string title, std::string address, std::string foursquareId = "",
287  bool disableNotification = false, int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
288 
300  Message::Ptr sendContact(int64_t chatId, std::string phoneNumber, std::string firstName, std::string lastName = "", bool disableNotification = false,
301  int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
302 
310  void sendChatAction(int64_t chatId, const std::string& action) const;
311 
319  UserProfilePhotos::Ptr getUserProfilePhotos(int32_t userId, int32_t offset = 0, int32_t limit = 100) const;
320 
326  File::Ptr getFile(const std::string &fileId) const;
327 
333  bool leaveChat(int64_t chatId) const;
334 
340  Chat::Ptr getChat(int64_t chatId) const;
341 
347  std::vector<ChatMember::Ptr> getChatAdministrators(int64_t chatId) const;
348 
354  int32_t getChatMembersCount(int64_t chatId) const;
355 
362  ChatMember::Ptr getChatMember(int64_t chatId, int32_t userId) const;
363 
373  bool answerCallbackQuery(const std::string & callbackQueryId, const std::string & text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const;
374 
386  Message::Ptr editMessageText(const std::string& text, int64_t chatId=0, int32_t messageId=0, const std::string& inlineMessageId="",
387  const std::string& parseMode = "", bool disableWebPagePreview = false, const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
388 
398  Message::Ptr editMessageCaption(int64_t chatId = 0, int32_t messageId = 0, const std::string& caption = "",
399  const std::string& inlineMessageId = "", const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
400 
409  Message::Ptr editMessageReplyMarkup(int64_t chatId = 0, int32_t messageId = 0, const std::string& inlineMessageId = "",
410  const GenericReply::Ptr replyMarkup = GenericReply::Ptr()) const;
411 
417  void deleteMessage(int64_t chatId, int32_t messageId) const;
418 
429  std::vector<Update::Ptr> getUpdates(int32_t offset = 0, int32_t limit = 100, int32_t timeout = 0, const StringArrayPtr &allowedUpdates = nullptr) const;
430 
439  void setWebhook(const std::string& url = "", const InputFile::Ptr certificate = nullptr, int32_t maxConnection = 40, const StringArrayPtr &allowedUpdates = nullptr) const;
440 
445  bool deleteWebhook() const;
446 
452  WebhookInfo::Ptr getWebhookInfo() const;
453 
466  bool answerInlineQuery(const std::string& inlineQueryId, const std::vector<InlineQueryResult::Ptr>& results,
467  int32_t cacheTime=300, bool isPersonal=false, const std::string& nextOffset="", const std::string& switchPmText="", const std::string& switchPmParameter="") const;
468 
475  bool kickChatMember(int64_t chatId, int32_t userId) const;
476 
483  bool unbanChatMember(int64_t chatId, int32_t userId) const;
484 
491  std::string downloadFile(const std::string& filePath, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const;
492 
493 private:
494  boost::property_tree::ptree sendRequest(const std::string& method, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const;
495 
496  const std::string _token;
497 };
498 
499 }
500 
501 #endif //TGBOT_CPP_API_H
TgBot::Api::getChat
Chat::Ptr getChat(int64_t chatId) const
TgBot::Api::sendVenue
Message::Ptr sendVenue(int64_t chatId, float latitude, float longitude, std::string title, std::string address, std::string foursquareId="", bool disableNotification=false, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=GenericReply::Ptr()) const
TgBot::Api::sendLocation
Message::Ptr sendLocation(int64_t chatId, float latitude, float longitude, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const
TgBot::File::Ptr
std::shared_ptr< File > Ptr
Definition: File.h:24
@@ -102,6 +102,7 @@ $(document).ready(function(){initNavTree('_api_8h_source.html','');});
InlineQueryResult.h
TgBot::Api::getMe
User::Ptr getMe() const
TgBot::Api::sendVoice
Message::Ptr sendVoice(int64_t chatId, const InputFile::Ptr voice, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const GenericReply::Ptr replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const
+
TgBot::Api::deleteMessage
void deleteMessage(int64_t chatId, int32_t messageId) const
TgBot::UserProfilePhotos::Ptr
std::shared_ptr< UserProfilePhotos > Ptr
Definition: UserProfilePhotos.h:40
TgBot::Api::editMessageText
Message::Ptr editMessageText(const std::string &text, int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", bool disableWebPagePreview=false, const GenericReply::Ptr replyMarkup=GenericReply::Ptr()) const
TgBot::WebhookInfo::Ptr
std::shared_ptr< WebhookInfo > Ptr
Definition: WebhookInfo.h:20
@@ -146,7 +147,7 @@ $(document).ready(function(){initNavTree('_api_8h_source.html','');});