diff options
Diffstat (limited to 'include/tgbot/Api.h')
| -rw-r--r-- | include/tgbot/Api.h | 734 |
1 files changed, 463 insertions, 271 deletions
diff --git a/include/tgbot/Api.h b/include/tgbot/Api.h index 78fb4fa..9dd2f5e 100644 --- a/include/tgbot/Api.h +++ b/include/tgbot/Api.h @@ -1,9 +1,11 @@ #ifndef TGBOT_API_H #define TGBOT_API_H +#include "tgbot/TgException.h" #include "tgbot/TgTypeParser.h" #include "tgbot/net/HttpClient.h" #include "tgbot/net/HttpReqArg.h" +#include "tgbot/tools/StringTools.h" #include "tgbot/types/User.h" #include "tgbot/types/Message.h" #include "tgbot/types/MessageId.h" @@ -30,6 +32,7 @@ #include <cstdint> #include <memory> #include <string> +#include <utility> #include <vector> namespace TgBot { @@ -51,7 +54,7 @@ public: Api(std::string token, const HttpClient& httpClient, const std::string& url); /** - * @brief Use this method to receive incoming updates using long polling. + * @brief Use this method to receive incoming updates using long polling (https://en.wikipedia.org/wiki/Push_technology#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. @@ -61,7 +64,7 @@ public: * @param timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. * @param allowedUpdates Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chatMember (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the Api::getUpdates, so unwanted updates may be received for a short period of time. * - * @return An Array of Update objects is returned. + * @return Returns an Array of Update objects. */ std::vector<Update::Ptr> getUpdates(std::int32_t offset = 0, std::int32_t limit = 100, @@ -88,8 +91,8 @@ public: * * @param url HTTPS URL to send updates to. Use an empty string to remove webhook integration * @param certificate Optional. Upload your public key certificate so that the root certificate in use can be checked. See https://core.telegram.org/bots/self-signed for details. - * @param maxConnection Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. - * @param allowedUpdates Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chatMember (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. + * @param maxConnections Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. + * @param allowedUpdates Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chatMember (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the Api::setWebhook, so unwanted updates may be received for a short period of time. * @param ipAddress Optional. The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS * @param dropPendingUpdates Optional. Pass True to drop all pending updates * @param secretToken Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. @@ -98,18 +101,18 @@ public: */ bool setWebhook(const std::string& url, InputFile::Ptr certificate = nullptr, - std::int32_t maxConnection = 40, + std::int32_t maxConnections = 40, const StringArrayPtr& allowedUpdates = nullptr, const std::string& ipAddress = "", bool dropPendingUpdates = false, const std::string& secretToken = "") const; /** - * @brief Use this method to remove webhook integration if you decide to switch back to @ref Api::getUpdates. + * @brief Use this method to remove webhook integration if you decide to switch back to Api::getUpdates. * * @param dropPendingUpdates Optional. Pass True to drop all pending updates * - * @return True on success. + * @return Returns True on success. */ bool deleteWebhook(bool dropPendingUpdates = false) const; @@ -117,19 +120,44 @@ public: * @brief Use this method to get current webhook status. * * Requires no parameters. - * If the bot is using getUpdates, will return an object with the url field empty. + * If the bot is using Api::getUpdates, will return an object with the url field empty. * - * @return On success, returns a WebhookInfo object. + * @return On success, returns a WebhookInfo object. If the bot is using getUpdates, will return a nullptr. */ WebhookInfo::Ptr getWebhookInfo() const; /** - * @brief A simple method for testing your bot's auth token. - * @return Basic information about the bot in form of a User object. + * @brief A simple method for testing your bot's authentication token. + * + * Requires no parameters. + * + * @return Returns basic information about the bot in form of a User object. */ User::Ptr getMe() const; /** + * @brief Use this method to log out from the cloud Bot API server before launching the bot locally. + * + * You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. + * After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. + * Requires no parameters. + * + * @return Returns True on success. + */ + bool logOut() const; + + /** + * @brief Use this method to close the bot instance before moving it from one local server to another. + * + * You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. + * The method will return error 429 in the first 10 minutes after the bot is launched. + * Requires no parameters. + * + * @return Returns True on success. + */ + bool close() const; + + /** * @brief Use this method to send text messages. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) @@ -140,13 +168,13 @@ public: * @param parseMode Optional. Mode for parsing entities in the message text. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param entities Optional. A JSON-serialized list of special entities that appear in message text, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendMessage(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendMessage(boost::variant<std::int64_t, std::string> chatId, const std::string& text, bool disableWebPagePreview = false, std::int32_t replyToMessageId = 0, @@ -170,8 +198,8 @@ public: * * @return On success, the sent Message is returned. */ - Message::Ptr forwardMessage(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<std::int64_t, const std::string&> fromChatId, + Message::Ptr forwardMessage(boost::variant<std::int64_t, std::string> chatId, + boost::variant<std::int64_t, std::string> fromChatId, std::int32_t messageId, bool disableNotification = false, bool protectContent = false) const; @@ -180,6 +208,7 @@ public: * @brief Use this method to copy messages of any kind. * * Service messages and invoice messages can't be copied. + * A quiz poll can be copied only if the value of the field correctOptionId is known to the bot. * The method is analogous to the method Api::forwardMessage, but the copied message doesn't have a link to the original message. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) @@ -190,14 +219,14 @@ public: * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parseMode * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param replyToMessageId Optional. If the message is a reply, ID of the original message - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return Returns the MessageId of the sent message on success. */ - MessageId::Ptr copyMessage(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<std::int64_t, const std::string&> fromChatId, + MessageId::Ptr copyMessage(boost::variant<std::int64_t, std::string> chatId, + boost::variant<std::int64_t, std::string> fromChatId, std::int32_t messageId, const std::string& caption = "", const std::string& parseMode = "", @@ -219,13 +248,13 @@ public: * @param parseMode Optional. Mode for parsing entities in the photo caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendPhoto(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> photo, + Message::Ptr sendPhoto(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> photo, const std::string& caption = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), @@ -255,18 +284,18 @@ public: * @param parseMode Optional. Mode for parsing entities in the audio caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendAudio(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> audio, + Message::Ptr sendAudio(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> audio, const std::string& caption = "", std::int32_t duration = 0, const std::string& performer = "", const std::string& title = "", - boost::variant<InputFile::Ptr, const std::string&> thumb = "", + boost::variant<InputFile::Ptr, std::string> thumb = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", @@ -290,14 +319,14 @@ public: * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode * @param disableContentTypeDetection Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendDocument(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> document, - boost::variant<InputFile::Ptr, const std::string&> thumb = "", + Message::Ptr sendDocument(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> document, + boost::variant<InputFile::Ptr, std::string> thumb = "", const std::string& caption = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), @@ -309,13 +338,13 @@ public: bool protectContent = false) const; /** - * @brief Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). + * @brief Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). * * Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param video Video to send. Pass a fileId as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. https://core.telegram.org/bots/api#sending-files - * @param supportsStreaming Optional. Pass True, if the uploaded video is suitable for streaming + * @param supportsStreaming Optional. Pass True if the uploaded video is suitable for streaming * @param duration Optional. Duration of sent video in seconds * @param width Optional. Video width * @param height Optional. Video height @@ -326,18 +355,18 @@ public: * @param parseMode Optional. Mode for parsing entities in the video caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendVideo(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> video, + Message::Ptr sendVideo(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> video, bool supportsStreaming = false, std::int32_t duration = 0, std::int32_t width = 0, std::int32_t height = 0, - boost::variant<InputFile::Ptr, const std::string&> thumb = "", + boost::variant<InputFile::Ptr, std::string> thumb = "", const std::string& caption = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), @@ -364,17 +393,17 @@ public: * @param parseMode Optional. Mode for parsing entities in the animation caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendAnimation(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> animation, + Message::Ptr sendAnimation(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> animation, std::int32_t duration = 0, std::int32_t width = 0, std::int32_t height = 0, - boost::variant<InputFile::Ptr, const std::string&> thumb = "", + boost::variant<InputFile::Ptr, std::string> thumb = "", const std::string& caption = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), @@ -399,13 +428,13 @@ public: * @param parseMode Optional. Mode for parsing entities in the voice message caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param captionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parseMode - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendVoice(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> voice, + Message::Ptr sendVoice(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> voice, const std::string& caption = "", std::int32_t duration = 0, std::int32_t replyToMessageId = 0, @@ -419,28 +448,28 @@ public: /** * @brief Use this method to send video messages. * - * As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. + * As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) - * @param videoNote Video note to send. Pass a fileId as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. Sending video notes by a URL is currently unsupported. https://core.telegram.org/bots/api#sending-files + * @param videoNote Video note to send. Pass a fileId as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. https://core.telegram.org/bots/api#sending-files. Sending video notes by a URL is currently unsupported * @param replyToMessageId Optional. If the message is a reply, ID of the original message * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param duration Optional. Duration of sent video in seconds * @param length Optional. Video width and height, i.e. diameter of the video message * @param thumb Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. https://core.telegram.org/bots/api#sending-files * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendVideoNote(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> videoNote, + Message::Ptr sendVideoNote(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> videoNote, std::int64_t replyToMessageId = 0, bool disableNotification = false, std::int32_t duration = 0, std::int32_t length = 0, - boost::variant<InputFile::Ptr, const std::string&> thumb = "", + boost::variant<InputFile::Ptr, std::string> thumb = "", GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool allowSendingWithoutReply = false, bool protectContent = false) const; @@ -448,18 +477,18 @@ public: /** * @brief Use this method to send a group of photos, videos, documents or audios as an album. * - * Documents and audio files can be only group in an album with messages of the same type. + * Documents and audio files can be only grouped in an album with messages of the same type. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param media A JSON-serialized array describing messages to be sent, must include 2-10 items * @param disableNotification Optional. Sends messages silently. Users will receive a notification with no sound. * @param replyToMessageId Optional. If the messages are a reply, ID of the original message - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent messages from forwarding and saving * * @return On success, an array of Messages that were sent is returned. */ - std::vector<Message::Ptr> sendMediaGroup(boost::variant<std::int64_t, const std::string&> chatId, + std::vector<Message::Ptr> sendMediaGroup(boost::variant<std::int64_t, std::string> chatId, const std::vector<InputMedia::Ptr>& media, bool disableNotification = false, std::int32_t replyToMessageId = 0, @@ -479,12 +508,12 @@ public: * @param horizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500 * @param heading Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. * @param proximityAlertRadius Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendLocation(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendLocation(boost::variant<std::int64_t, std::string> chatId, float latitude, float longitude, std::int32_t livePeriod = 0, @@ -499,6 +528,7 @@ public: /** * @brief Use this method to edit live location messages. + * * A location can be edited until its livePeriod expires or editing is explicitly disabled by a call to Api::stopMessageLiveLocation. * * @param latitude Latitude of new location @@ -509,29 +539,33 @@ public: * @param replyMarkup Optional. A JSON-serialized object for a new inline keyboard. * @param horizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500 * @param heading Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. - * @param proximityAlertRadius Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + * @param proximityAlertRadius Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. * - * @return On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. + * @return On success, the edited Message is returned. */ Message::Ptr editMessageLiveLocation(float latitude, float longitude, - std::int64_t chatId = 0, + boost::variant<std::int64_t, std::string> chatId = "", std::int32_t messageId = 0, - std::int32_t inlineMessageId = 0, + const std::string& inlineMessageId = "", InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>(), float horizontalAccuracy = 0, std::int32_t heading = 0, std::int32_t proximityAlertRadius = 0) const; /** - * @brief Use this method to edit live location messages sent by the bot or via the bot (for inline bots). - * @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat of the target channel. - * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the sent message. - * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message. + * @brief Use this method to stop updating a live location message before livePeriod expires. + * + * @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the message with live location to stop + * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message * @param replyMarkup Optional. A JSON-serialized object for a new inline keyboard. - * @return On success, if the edited message was sent by the bot, the edited Message is returned, otherwise nullptr is returned. + * + * @return On success, the edited Message is returned. */ - Message::Ptr stopMessageLiveLocation(std::int64_t chatId = 0, std::int32_t messageId = 0, std::int32_t inlineMessageId = 0, + Message::Ptr stopMessageLiveLocation(boost::variant<std::int64_t, std::string> chatId = "", + std::int32_t messageId = 0, + const std::string& inlineMessageId = "", InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const; /** @@ -549,12 +583,12 @@ public: * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. * @param googlePlaceId Optional. Google Places identifier of the venue * @param googlePlaceType Optional. Google Places type of the venue. (See https://developers.google.com/places/web-service/supported_types) - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendVenue(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendVenue(boost::variant<std::int64_t, std::string> chatId, float latitude, float longitude, const std::string& title, @@ -580,12 +614,12 @@ public: * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. * @param replyToMessageId Optional. If the message is a reply, ID of the original message * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendContact(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendContact(boost::variant<std::int64_t, std::string> chatId, const std::string& phoneNumber, const std::string& firstName, const std::string& lastName = "", @@ -615,12 +649,12 @@ public: * @param openPeriod Optional. Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with closeDate. * @param closeDate Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with openPeriod. * @param isClosed Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendPoll(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendPoll(boost::variant<std::int64_t, std::string> chatId, const std::string& question, const std::vector<std::string>& options, bool disableNotification = false, @@ -629,7 +663,7 @@ public: bool isAnonymous = true, const std::string& type = "", bool allowsMultipleAnswers = false, - std::int32_t correctOptionId = 0, + std::int32_t correctOptionId = -1, const std::string& explanation = "", const std::string& explanationParseMode = "", const std::vector<MessageEntity::Ptr>& explanationEntities = std::vector<MessageEntity::Ptr>(), @@ -647,12 +681,12 @@ public: * @param replyToMessageId Optional. If the message is a reply, ID of the original message * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. * @param emoji Optional. Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲” - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding * * @return On success, the sent Message is returned. */ - Message::Ptr sendDice(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendDice(boost::variant<std::int64_t, std::string> chatId, bool disableNotification = false, std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), @@ -680,64 +714,74 @@ public: /** * @brief Use this method to get a list of profile pictures for a user. - * @param userId Unique identifier of the target user. + * + * @param userId Unique identifier of the target user * @param offset Optional. Sequential number of the first photo to be returned. By default, all photos are returned. - * @param limit Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100. - * @return A UserProfilePhotos object. + * @param limit Optional. Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. + * + * @return Returns a UserProfilePhotos object. */ - UserProfilePhotos::Ptr getUserProfilePhotos(std::int64_t userId, std::int32_t offset = 0, std::int32_t limit = 100) const; + UserProfilePhotos::Ptr getUserProfilePhotos(std::int64_t userId, + std::int32_t offset = 0, + std::int32_t limit = 100) const; /** - * @brief 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. - * @param fileId File identifier to get info about - * @return A File object. + * @brief Use this method to get basic information about a file and prepare it for downloading. + * + * For the moment, bots can download files of up to 20MB in size. + * The file can then be downloaded via Api::downloadFile, where filePath is taken from the response. + * It is guaranteed that the filePath will be valid for at least 1 hour. + * When the link expires, a new one can be requested by calling Api::getFile again. + * + * This function may not preserve the original file name and MIME type. + * You should save the file's MIME type and name (if available) when the File object is received. + * + * @param fileId File identifier to get information about + * + * @return On success, a File object is returned. */ File::Ptr getFile(const std::string& fileId) const; /** - * @brief Downloads file from Telegram and saves it in memory. - * @param filePath Telegram file path. - * @param args Additional api parameters. - * @return File contents in a string. - */ - std::string downloadFile(const std::string& filePath, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const; - - /** - * @brief Use this method to kick a user from a group, a supergroup or a channel. + * @brief Use this method to ban a user in a group, a supergroup or a channel. + * * In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. - * The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * * @param chatId Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) * @param userId Unique identifier of the target user * @param untilDate Optional. Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. * @param revokeMessages Optional. Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. * - * @return True on success. + * @return Returns True on success. */ - bool banChatMember(std::int64_t chatId, + bool banChatMember(boost::variant<std::int64_t, std::string> chatId, std::int64_t userId, - std::uint64_t untilDate = 0, + std::int32_t untilDate = 0, bool revokeMessages = true) const; /** - * @brief Use this method to unban a previously kicked user in a supergroup or channel. + * @brief Use this method to unban a previously banned user in a supergroup or channel. * * The user will not return to the group or channel automatically, but will be able to join via link, etc. * The bot must be an administrator for this to work. * By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. * So if the user is a member of the chat they will also be removed from the chat. - * If you don't want this, use the parameter only_if_banned. + * If you don't want this, use the parameter onlyIfBanned. * - * @param chatId Unique identifier for the target group or username of the target supergroup or channel (in the format @username) + * @param chatId Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) * @param userId Unique identifier of the target user - * @param onlyIfBanned Optional. True = Do nothing if the user is not banned + * @param onlyIfBanned Optional. Pass True to do nothing if the user is not banned * - * @return True on success + * @return Returns True on success. */ - bool unbanChatMember(std::int64_t chatId, std::int64_t userId, bool onlyIfBanned = false) const; + bool unbanChatMember(boost::variant<std::int64_t, std::string> chatId, + std::int64_t userId, + bool onlyIfBanned = false) const; /** * @brief Use this method to restrict a user in a supergroup. + * * The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. * Pass True for all permissions to lift restrictions from a user. * @@ -746,12 +790,12 @@ public: * @param permissions A JSON-serialized object for new user permissions * @param untilDate Optional. Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever * - * @return True on success + * @return Returns True on success. */ - bool restrictChatMember(std::int64_t chatId, + bool restrictChatMember(boost::variant<std::int64_t, std::string> chatId, std::int64_t userId, ChatPermissions::Ptr permissions, - std::uint64_t untilDate = 0) const; + std::int64_t untilDate = 0) const; /** * @brief Use this method to promote or demote a user in a supergroup or a channel. @@ -775,7 +819,7 @@ public: * * @return Returns True on success. */ - bool promoteChatMember(boost::variant<std::int64_t, const std::string&> chatId, + bool promoteChatMember(boost::variant<std::int64_t, std::string> chatId, std::int64_t userId, bool canChangeInfo = false, bool canPostMessages = false, @@ -796,25 +840,29 @@ public: * @param userId Unique identifier of the target user * @param customTitle New custom title for the administrator; 0-16 characters, emoji are not allowed * - * @return True on success + * @return Returns True on success. */ - bool setChatAdministratorCustomTitle(std::int64_t chatId, std::int64_t userId, const std::string& customTitle) const; + bool setChatAdministratorCustomTitle(boost::variant<std::int64_t, std::string> chatId, + std::int64_t userId, + const std::string& customTitle) const; /** * @brief Use this method to ban a channel chat in a supergroup or a channel. + * * Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. * The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param senderChatId Unique identifier of the target sender chat * - * @return True on success. + * @return Returns True on success. */ - bool banChatSenderChat(std::int64_t chatId, + bool banChatSenderChat(boost::variant<std::int64_t, std::string> chatId, std::int64_t senderChatId) const; /** * @brief Use this method to unban a previously banned channel chat in a supergroup or channel. + * * The bot must be an administrator for this to work and must have the appropriate administrator rights. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) @@ -822,38 +870,53 @@ public: * * @return Returns True on success. */ - bool unbanChatSenderChat(std::int64_t chatId, + bool unbanChatSenderChat(boost::variant<std::int64_t, std::string> chatId, std::int64_t senderChatId) const; /** - * @brief Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success. - * @param chatId Unique identifier for the target chat of the target supergroup. - * @param permissions New default chat permissions. - * @return True on success + * @brief Use this method to set default chat permissions for all members. + * + * The bot must be an administrator in the group or a supergroup for this to work and must have the canRestrictMembers administrator rights. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + * @param permissions A JSON-serialized object for new default chat permissions + * + * @return Returns True on success. */ - bool setChatPermissions(std::int64_t chatId, ChatPermissions::Ptr permissions) const; + bool setChatPermissions(boost::variant<std::int64_t, std::string> chatId, + ChatPermissions::Ptr permissions) const; /** - * @brief Use this method to generate a new invite link for a chat; any previously generated link is revoked. - * @param chatId Unique identifier for the target chat. - * @return The new invite link as String on success. + * @brief Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. + * + * Each administrator in a chat generates their own invite links. + * Bots can't use invite links generated by other administrators. + * If you want your bot to work with invite links, it will need to generate its own link using Api::exportChatInviteLink or by calling the Api::getChat method. + * If your bot needs to generate a new primary invite link replacing its previous one, use Api::exportChatInviteLink again. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * + * @return Returns the new invite link as String on success. */ - std::string exportChatInviteLink(std::int64_t chatId) const; + std::string exportChatInviteLink(boost::variant<std::int64_t, std::string> chatId) const; /** * @brief Use this method to create an additional invite link for a chat. - * The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * The link can be revoked using the method Api::revokeChatInviteLink. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param expireDate Optional. Point in time (Unix timestamp) when the link will expire - * @param memberLimit Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 + * @param memberLimit Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 * @param name Optional. Invite link name; 0-32 characters * @param createsJoinRequest Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, memberLimit can't be specified * - * @return the new invite link as ChatInviteLink object. + * @return Returns the new invite link as ChatInviteLink object. */ - ChatInviteLink::Ptr createChatInviteLink(std::int64_t chatId, + ChatInviteLink::Ptr createChatInviteLink(boost::variant<std::int64_t, std::string> chatId, std::int32_t expireDate = 0, std::int32_t memberLimit = 0, const std::string& name = "", @@ -861,7 +924,8 @@ public: /** * @brief Use this method to edit a non-primary invite link created by the bot. - * The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param inviteLink The invite link to edit @@ -870,9 +934,9 @@ public: * @param name Optional. Invite link name; 0-32 characters * @param createsJoinRequest Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, memberLimit can't be specified * - * @return the edited invite link as a ChatInviteLink object. + * @return Returns the edited invite link as a ChatInviteLink object. */ - ChatInviteLink::Ptr editChatInviteLink(std::int64_t chatId, + ChatInviteLink::Ptr editChatInviteLink(boost::variant<std::int64_t, std::string> chatId, const std::string& inviteLink, std::int32_t expireDate = 0, std::int32_t memberLimit = 0, @@ -881,31 +945,34 @@ public: /** * @brief Use this method to revoke an invite link created by the bot. + * * If the primary link is revoked, a new link is automatically generated. - * The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * - * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param chatId Unique identifier of the target chat or username of the target channel (in the format @channelusername) * @param inviteLink The invite link to revoke * - * @return the revoked invite link as ChatInviteLink object. + * @return Returns the revoked invite link as ChatInviteLink object. */ - ChatInviteLink::Ptr revokeChatInviteLink(std::int64_t chatId, + ChatInviteLink::Ptr revokeChatInviteLink(boost::variant<std::int64_t, std::string> chatId, const std::string& inviteLink) const; /** * @brief Use this method to approve a chat join request. + * * The bot must be an administrator in the chat for this to work and must have the canInviteUsers administrator right. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param userId Unique identifier of the target user * - * @return True on success. + * @return Returns True on success. */ - bool approveChatJoinRequest(std::int64_t chatId, + bool approveChatJoinRequest(boost::variant<std::int64_t, std::string> chatId, std::int64_t userId) const; /** * @brief Use this method to decline a chat join request. + * * The bot must be an administrator in the chat for this to work and must have the canInviteUsers administrator right. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) @@ -913,154 +980,207 @@ public: * * @return True on success. */ - bool declineChatJoinRequest(std::int64_t chatId, + bool declineChatJoinRequest(boost::variant<std::int64_t, std::string> chatId, std::int64_t userId) const; /** * @brief Use this method to set a new profile photo for the chat. * * Photos can't be changed for private chats. + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * - * @param chatId Unique identifier for the target chat. - * @param photo New chat photo. - * @return True on success + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param photo New chat photo, uploaded using multipart/form-data + * + * @return Returns True on success. */ - bool setChatPhoto(std::int64_t chatId, InputFile::Ptr photo) const; + bool setChatPhoto(boost::variant<std::int64_t, std::string> chatId, + InputFile::Ptr photo) const; /** * @brief Use this method to delete a chat photo. * * Photos can't be changed for private chats. + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * - * @param chatId Unique identifier for the target chat. - * @return True on success + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * + * @return Returns True on success. */ - bool deleteChatPhoto(std::int64_t chatId) const; + bool deleteChatPhoto(boost::variant<std::int64_t, std::string> chatId) const; /** * @brief Use this method to change the title of a chat. * * Titles can't be changed for private chats. + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. * - * @param chatId Unique identifier for the target chat. - * @param title New chat title, 1-255 characters. - * @return True on success + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param title New chat title, 1-255 characters + * + * @return Returns True on success. */ - bool setChatTitle(std::int64_t chatId, const std::string& title) const; + bool setChatTitle(boost::variant<std::int64_t, std::string> chatId, + const std::string& title) const; /** - * @brief Use this method to change the description of a supergroup or a channel. - * @param chatId Unique identifier for the target chat. - * @param description New chat description, 1-255 characters. - * @return True on success + * @brief Use this method to change the description of a group, a supergroup or a channel. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param description New chat description, 0-255 characters + * + * @return Returns True on success. */ - bool setChatDescription(std::int64_t chatId, const std::string& description) const; + bool setChatDescription(boost::variant<std::int64_t, std::string> chatId, + const std::string& description = "") const; /** - * @brief Use this method to pin a message in a group, a supergroup, or a channel. - * @param chatId Unique identifier for the target chat or username of the target channel. - * @param messageId Identifier of a message to pin. - * @param disableNotification Optional. Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels. - * @return True on success + * @brief Use this method to add a message to the list of pinned messages in a chat. + * + * If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Identifier of a message to pin + * @param disableNotification Optional. Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. + * + * @return Returns True on success. */ - bool pinChatMessage(std::int64_t chatId, std::int32_t messageId, bool disableNotification = false) const; + bool pinChatMessage(boost::variant<std::int64_t, std::string> chatId, + std::int32_t messageId, + bool disableNotification = false) const; /** * @brief Use this method to remove a message from the list of pinned messages in a chat. - * If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. + * + * If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param messageId Optional. Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. * - * @return True on success. + * @return Returns True on success. */ - bool unpinChatMessage(std::int64_t chatId, std::int32_t messageId = 0) const; + bool unpinChatMessage(boost::variant<std::int64_t, std::string> chatId, + std::int32_t messageId = 0) const; /** * @brief Use this method to clear the list of pinned messages in a chat. - * If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. + * + * If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'canPinMessages' administrator right in a supergroup or 'canEditMessages' administrator right in a channel. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * - * @return True on success. + * @return Returns True on success. */ - bool unpinAllChatMessages(std::int64_t chatId) const; + bool unpinAllChatMessages(boost::variant<std::int64_t, std::string> chatId) const; /** * @brief Use this method for your bot to leave a group, supergroup or channel. - * @param chatId Unique identifier for the target chat of the target supergroup or channel. - * @return True on success + * + * @param chatId Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + * + * @return Returns True on success. */ - bool leaveChat(std::int64_t chatId) const; + bool leaveChat(boost::variant<std::int64_t, std::string> chatId) const; /** * @brief 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.). * * @param chatId Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) * - * @return @ref Chat object on success. + * @return Returns a Chat object on success. */ - Chat::Ptr getChat(std::int64_t chatId) const; + Chat::Ptr getChat(boost::variant<std::int64_t, std::string> chatId) const; /** - * @brief Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember 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. - * @param chatId Unique identifier for the target chat of the target supergroup or channel. - * @return ChatMember object. + * @brief Use this method to get a list of administrators in a chat, which aren't bots. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + * + * @return Returns an Array of ChatMember objects. */ - std::vector<ChatMember::Ptr> getChatAdministrators(std::int64_t chatId) const; + std::vector<ChatMember::Ptr> getChatAdministrators(boost::variant<std::int64_t, std::string> chatId) const; /** * @brief Use this method to get the number of members in a chat. * * @param chatId Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) * - * @return Int on success. + * @return Returns Int on success. */ - std::int32_t getChatMemberCount(std::int64_t chatId) const; + std::int32_t getChatMemberCount(boost::variant<std::int64_t, std::string> chatId) const; /** - * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success. - * @param chatId Unique identifier for the target chat of the target supergroup or channel. + * @brief Use this method to get information about a member of a chat. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) * @param userId Unique identifier of the target user - * @return ChatMember object. + * + * @return Returns a ChatMember object on success. */ - ChatMember::Ptr getChatMember(std::int64_t chatId, std::int64_t userId) const; + ChatMember::Ptr getChatMember(boost::variant<std::int64_t, std::string> chatId, + std::int64_t userId) const; /** - * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success. - * @param chatId Unique identifier for the target chat of the target supergroup or channel. - * @param stickerSetName Name of the sticker set to be set as the group sticker set. + * @brief Use this method to set a new group sticker set for a supergroup. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. + * Use the field canSetStickerSet optionally returned in Api::getChat requests to check if the bot can use this method. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + * @param stickerSetName Name of the sticker set to be set as the group sticker set + * * @return Returns True on success. */ - bool setChatStickerSet(std::int64_t chatId, const std::string& stickerSetName) const; + bool setChatStickerSet(boost::variant<std::int64_t, std::string> chatId, + const std::string& stickerSetName) const; /** - * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success. - * @param chatId Unique identifier for the target chat of the target supergroup or channel. + * @brief Use this method to delete a group sticker set from a supergroup. + * + * The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. + * Use the field canSetSticker_set optionally returned in Api::getChat requests to check if the bot can use this method. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + * * @return Returns True on success. */ - bool deleteChatStickerSet(std::int64_t chatId) const; + bool deleteChatStickerSet(boost::variant<std::int64_t, std::string> chatId) const; /** - * @brief 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. + * @brief 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. + * + * Alternatively, the user can be redirected to the specified Game URL. + * For this option to work, you must first create a game for your bot via @BotFather and accept the terms. + * Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. + * * @param callbackQueryId Unique identifier for the query to be answered - * @param text Optional Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters - * @param showAlert 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. - * @param url Optional URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button - * @param cacheTime 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. - * @return True on success + * @param text Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters + * @param showAlert 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. + * @param url Optional. URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from an InlineKeyboardButton button. + * @param cacheTime 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. + * + * @return On success, True is returned. */ - bool answerCallbackQuery(const std::string& callbackQueryId, const std::string& text = "", bool showAlert = false, const std::string& url = "", std::int32_t cacheTime = 0) const; + bool answerCallbackQuery(const std::string& callbackQueryId, + const std::string& text = "", + bool showAlert = false, + const std::string& url = "", + std::int32_t cacheTime = 0) const; /** * @brief Use this method to change the list of the bot's commands. + * * See https://core.telegram.org/bots#commands for more details about bot commands. * * @param commands A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. * @param scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. * @param languageCode Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands * - * @return True on success. + * @return Returns True on success. */ bool setMyCommands(const std::vector<BotCommand::Ptr>& commands, BotCommandScope::Ptr scope = nullptr, @@ -1068,12 +1188,13 @@ public: /** * @brief Use this method to delete the list of the bot's commands for the given scope and user language. + * * After deletion, higher level commands will be shown to affected users. * * @param scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. * @param languageCode Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands * - * @return True on success. + * @return Returns True on success. */ bool deleteMyCommands(BotCommandScope::Ptr scope = nullptr, const std::string& languageCode = "") const; @@ -1084,7 +1205,7 @@ public: * @param scope Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. * @param languageCode Optional. A two-letter ISO 639-1 language code or an empty string * - * @return Array of BotCommand on success. If commands aren't set, an empty list is returned. + * @return Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned. */ std::vector<BotCommand::Ptr> getMyCommands(BotCommandScope::Ptr scope = nullptr, const std::string& languageCode = "") const; @@ -1093,7 +1214,7 @@ public: * @brief Use this method to change the bot's menu button in a private chat, or the default menu button. * * @param chatId Optional. Unique identifier for the target private chat. If not specified, default bot's menu button will be changed - * @param menuButton Optional. A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault + * @param menuButton Optional. A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault * * @return Returns True on success. */ @@ -1143,10 +1264,10 @@ public: * @param replyMarkup Optional. A JSON-serialized object for an inline keyboard. * @param entities Optional. List of special entities that appear in message text, which can be specified instead of parseMode * - * @return On success, the edited Message is returned. + * @return On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. */ Message::Ptr editMessageText(const std::string& text, - std::int64_t chatId = 0, + boost::variant<std::int64_t, std::string> chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "", const std::string& parseMode = "", @@ -1165,9 +1286,9 @@ public: * @param parseMode Optional. Mode for parsing entities in the message caption. See https://core.telegram.org/bots/api#formatting-options for more details. * @param captionEntities Optional. List of special entities that appear in the caption, which can be specified instead of parseMode * - * @return On success, the edited Message is returned. + * @return On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. */ - Message::Ptr editMessageCaption(std::int64_t chatId = 0, + Message::Ptr editMessageCaption(boost::variant<std::int64_t, std::string> chatId = 0, std::int32_t messageId = 0, const std::string& caption = "", const std::string& inlineMessageId = "", @@ -1176,67 +1297,87 @@ public: const std::vector<MessageEntity::Ptr>& captionEntities = std::vector<MessageEntity::Ptr>()) const; /** - * @brief Use this method to edit audio, document, photo, or video messages. - * + * @brief Use this method to edit animation, audio, document, photo, or video messages. * - * If a message is a part of a message album, then it can be edited only to a photo or a video. - * Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. - * Use previously uploaded file via its fileId or specify a URL. + * If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. + * When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its fileId or specify a URL. * - * @param media A JSON-serialized object for a new media content of the message. - * @param chatId Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel. - * @param messageId Optional Required if inline_message_id is not specified. Identifier of the sent message - * @param inlineMessageId Optional Required if chat_id and message_id are not specified. Identifier of the inline message - * @param replyMarkup Optional A JSON-serialized object for an inline keyboard. - * @return On success, if the edited message was sent by the bot, the edited Message is returned, otherwise nullptr is returned. + * @param media A JSON-serialized object for a new media content of the message + * @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the message to edit + * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message + * @param replyMarkup Optional. A JSON-serialized object for a new inline keyboard. + * + * @return On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. */ - Message::Ptr editMessageMedia(InputMedia::Ptr media, std::int64_t chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "", + Message::Ptr editMessageMedia(InputMedia::Ptr media, + boost::variant<std::int64_t, std::string> chatId = 0, + std::int32_t messageId = 0, + const std::string& inlineMessageId = "", GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; /** - * @brief Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). - * @param chatId Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel. - * @param messageId Optional Required if inline_message_id is not specified. Identifier of the sent message - * @param inlineMessageId Optional Required if chat_id and message_id are not specified. Identifier of the inline message - * @param replyMarkup Optional A JSON-serialized object for an inline keyboard. - * @return Message object on success, otherwise nullptr + * @brief Use this method to edit only the reply markup of messages. + * + * @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the message to edit + * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message + * @param replyMarkup Optional. A JSON-serialized object for an inline keyboard. + * + * @return On success, if the edited message is not an inline message, the edited Message is returned, otherwise nullptr is returned. */ - Message::Ptr editMessageReplyMarkup(std::int64_t chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "", + Message::Ptr editMessageReplyMarkup(boost::variant<std::int64_t, std::string> chatId = 0, + std::int32_t messageId = 0, + const std::string& inlineMessageId = "", GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; /** * @brief Use this method to stop a poll which was sent by the bot. - * @param chatId Unique identifier for the target chat or username of the target channel. - * @param messageId Identifier of the original message with the poll. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Identifier of the original message with the poll * @param replyMarkup Optional. A JSON-serialized object for a new message inline keyboard. * - * @return On success, the stopped Poll with the final results is returned. + * @return On success, the stopped Poll is returned. */ - - Poll::Ptr stopPoll(std::int64_t chatId, std::int64_t messageId, InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const; + Poll::Ptr stopPoll(boost::variant<std::int64_t, std::string> chatId, + std::int64_t messageId, + InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const; /** - * @brief Use this method to delete messages sent by bot (or by other users if bot is admin). - * @param chatId Unique identifier for the target chat or username of the target channel. - * @param messageId Unique identifier for the target message. + * @brief Use this method to delete a message, including service messages, with the following limitations: + * + * - A message can only be deleted if it was sent less than 48 hours ago. + * - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. + * - Bots can delete outgoing messages in private chats, groups, and supergroups. + * - Bots can delete incoming messages in private chats. + * - Bots granted canPostMessages permissions can delete outgoing messages in channels. + * - If the bot is an administrator of a group, it can delete any message there. + * - If the bot has canDeleteMessages permission in a supergroup or a channel, it can delete any message there. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param messageId Identifier of the message to delete + * + * @return Returns True on success. */ - void deleteMessage(std::int64_t chatId, std::int32_t messageId) const; + bool deleteMessage(boost::variant<std::int64_t, std::string> chatId, + std::int32_t messageId) const; /** - * @brief Use this method to send static .WEBP or animated .TGS stickers. + * @brief Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. * * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param sticker Sticker to send. Pass a fileId as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. https://core.telegram.org/bots/api#sending-files * @param replyToMessageId Optional. If the message is a reply, ID of the original message * @param replyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. */ - Message::Ptr sendSticker(boost::variant<std::int64_t, const std::string&> chatId, - boost::variant<InputFile::Ptr, const std::string&> sticker, + Message::Ptr sendSticker(boost::variant<std::int64_t, std::string> chatId, + boost::variant<InputFile::Ptr, std::string> sticker, std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false, @@ -1262,12 +1403,15 @@ public: std::vector<Sticker::Ptr> getCustomEmojiStickers(const std::vector<std::string>& customEmojiIds) const; /** - * @brief Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). - * @param userId User identifier of sticker file owner. - * @param pngSticker Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. + * @brief Use this method to upload a .PNG file with a sticker for later use in Api::createNewStickerSet and Api::addStickerToSet methods (can be used multiple times). + * + * @param userId User identifier of sticker file owner + * @param pngSticker PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. https://core.telegram.org/bots/api#sending-files + * * @return Returns the uploaded File on success. */ - File::Ptr uploadStickerFile(std::int64_t userId, InputFile::Ptr pngSticker) const; + File::Ptr uploadStickerFile(std::int64_t userId, + InputFile::Ptr pngSticker) const; /** * @brief Use this method to create a new sticker set owned by a user. @@ -1292,7 +1436,7 @@ public: const std::string& title, const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr, - boost::variant<InputFile::Ptr, const std::string&> pngSticker = "", + boost::variant<InputFile::Ptr, std::string> pngSticker = "", InputFile::Ptr tgsSticker = nullptr, InputFile::Ptr webmSticker = nullptr, const std::string& stickerType = "") const; @@ -1300,7 +1444,7 @@ public: /** * @brief Use this method to add a new sticker to a set created by the bot. * - * You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. + * You must use exactly one of the fields pngSticker, tgsSticker, or webmSticker. * Animated stickers can be added to animated sticker sets and only to them. * Animated sticker sets can have up to 50 stickers. * Static sticker sets can have up to 120 stickers. @@ -1319,7 +1463,7 @@ public: const std::string& name, const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr, - boost::variant<InputFile::Ptr, const std::string&> pngSticker = "", + boost::variant<InputFile::Ptr, std::string> pngSticker = "", InputFile::Ptr tgsSticker = nullptr, InputFile::Ptr webmSticker = nullptr) const; @@ -1329,45 +1473,58 @@ public: * @param sticker File identifier of the sticker * @param position New sticker position in the set, zero-based * - * @return True on success. + * @return Returns True on success. */ bool setStickerPositionInSet(const std::string& sticker, - std::uint32_t position) const; + std::int32_t position) const; /** * @brief Use this method to delete a sticker from a set created by the bot. * * @param sticker File identifier of the sticker * - * @return True on success. + * @return Returns True on success. */ bool deleteStickerFromSet(const std::string& sticker) const; /** - * @brief Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. + * @brief Use this method to set the thumbnail of a sticker set. + * + * Animated thumbnails can be set for animated sticker sets only. + * Video thumbnails can be set only for video sticker sets only. * * @param name Sticker set name * @param userId User identifier of the sticker set owner - * @param thumb Optional. A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements. Pass a fileId as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Animated sticker set thumbnail can't be uploaded via HTTP URL. + * @param thumb Optional. A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a fileId as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. https://core.telegram.org/bots/api#sending-files. Animated sticker set thumbnails can't be uploaded via HTTP URL. * * @return Returns True on success. */ - bool setStickerSetThumb(const std::string& name, std::int64_t userId, boost::variant<InputFile::Ptr, std::string> thumb = "") const; + bool setStickerSetThumb(const std::string& name, + std::int64_t userId, + boost::variant<InputFile::Ptr, std::string> thumb = "") const; /** * @brief Use this method to send answers to an inline query. - * No mode that 50 results per query are allowed. - * @param inlineQueryId Unique identifier for the answered query. - * @param results Array of results for the inline query. - * @param cacheTime The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. - * @param isPersonal 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. - * @param nextOffset 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. - * @param switchPmText 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 - * @param switchPmParameter Parameter for the start message sent to the bot when user presses the switch button - * @return True on success + * + * No more than 50 results per query are allowed. + * + * @param inlineQueryId Unique identifier for the answered query + * @param results A JSON-serialized array of results for the inline query + * @param cacheTime Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. + * @param isPersonal Optional. 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 + * @param nextOffset Optional. 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. + * @param switchPmText Optional. 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 switchPmParameter + * @param switchPmParameter Optional. Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer an InlineKeyboardMarkup button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. + * + * @return On success, True is returned. */ - bool answerInlineQuery(const std::string& inlineQueryId, const std::vector<InlineQueryResult::Ptr>& results, - std::int32_t cacheTime = 300, bool isPersonal = false, const std::string& nextOffset = "", const std::string& switchPmText = "", const std::string& switchPmParameter = "") const; + bool answerInlineQuery(const std::string& inlineQueryId, + const std::vector<InlineQueryResult::Ptr>& results, + std::int32_t cacheTime = 300, + bool isPersonal = false, + const std::string& nextOffset = "", + const std::string& switchPmText = "", + const std::string& switchPmParameter = "") const; /** * @brief Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. @@ -1413,7 +1570,7 @@ public: * * @return On success, the sent Message is returned. */ - Message::Ptr sendInvoice(boost::variant<std::int64_t, const std::string&> chatId, + Message::Ptr sendInvoice(boost::variant<std::int64_t, std::string> chatId, const std::string& title, const std::string& description, const std::string& payload, @@ -1491,15 +1648,19 @@ public: /** * @brief Use this method to reply to shipping queries. * - * If you sent an invoice requesting a shipping address and the parameter isFlexible was specified, the Bot API will send an Update with a shipping_query field to the bot. + * If you sent an invoice requesting a shipping address and the parameter isFlexible was specified, the Bot API will send an Update with a shippingQuery field to the bot. * - * @param shippingQueryId Unique identifier for the query to be answered. - * @param ok Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) + * @param shippingQueryId Unique identifier for the query to be answered + * @param ok Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) * @param shippingOptions Optional. Required if ok is True. A JSON-serialized array of available shipping options. * @param errorMessage Optional. Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. + * * @return On success, True is returned. */ - bool answerShippingQuery(const std::string& shippingQueryId, bool ok, const std::vector<ShippingOption::Ptr>& shippingOptions = std::vector<ShippingOption::Ptr>(), const std::string& errorMessage = "") const; + bool answerShippingQuery(const std::string& shippingQueryId, + bool ok, + const std::vector<ShippingOption::Ptr>& shippingOptions = std::vector<ShippingOption::Ptr>(), + const std::string& errorMessage = "") const; /** * @brief Use this method to respond to such pre-checkout queries. @@ -1510,9 +1671,12 @@ public: * @param preCheckoutQueryId Unique identifier for the query to be answered * @param ok Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. * @param errorMessage Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. + * * @return On success, True is returned. */ - bool answerPreCheckoutQuery(const std::string& preCheckoutQueryId, bool ok, const std::string& errorMessage = "") const; + bool answerPreCheckoutQuery(const std::string& preCheckoutQueryId, + bool ok, + const std::string& errorMessage = "") const; /** * @brief Informs a user that some of the Telegram Passport elements they provided contains errors. @@ -1525,19 +1689,20 @@ public: * @param userId User identifier * @param errors A JSON-serialized array describing the errors * - * @return True on success. + * @return Returns True on success. */ - bool setPassportDataErrors(std::int64_t userId, const std::vector<PassportElementError::Ptr>& errors) const; + bool setPassportDataErrors(std::int64_t userId, + const std::vector<PassportElementError::Ptr>& errors) const; /** * @brief Use this method to send a game. * * @param chatId Unique identifier for the target chat - * @param gameShortName Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. + * @param gameShortName Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. * @param replyToMessageId Optional. If the message is a reply, ID of the original message * @param replyMarkup Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play gameTitle' button will be shown. If not empty, the first button must launch the game. * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. - * @param allowSendingWithoutReply Optional. Pass True, if the message should be sent even if the specified replied-to message is not found + * @param allowSendingWithoutReply Optional. Pass True if the message should be sent even if the specified replied-to message is not found * @param protectContent Optional. Protects the contents of the sent message from forwarding and saving * * @return On success, the sent Message is returned. @@ -1551,28 +1716,35 @@ public: bool protectContent = false) const; /** - * @brief Use this method to set the score of the specified user in a game. + * @brief Use this method to set the score of the specified user in a game message. * * Returns an error, if the new score is not greater than the user's current score in the chat and force is False. * - * @param userId User identifier. - * @param score New score, must be non-negative. - * @param force Optional. Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. - * @param disableEditMessage Optional. Pass True, if the game message should not be automatically edited to include the current scoreboard. + * @param userId User identifier + * @param score New score, must be non-negative + * @param force Optional. Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters + * @param disableEditMessage Optional. Pass True if the game message should not be automatically edited to include the current scoreboard * @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the sent message * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message - * @return On success, if the message was sent by the bot, returns the edited Message, otherwise returns nullptr. + * + * @return On success, if the message is not an inline message, the Message is returned, otherwise nullptr is returned. */ - Message::Ptr setGameScore(std::int64_t userId, std::int32_t score, bool force = false, bool disableEditMessage = false, - std::int64_t chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "") const; + Message::Ptr setGameScore(std::int64_t userId, + std::int32_t score, + bool force = false, + bool disableEditMessage = false, + std::int64_t chatId = 0, + std::int32_t messageId = 0, + const std::string& inlineMessageId = "") const; /** * @brief Use this method to get data for high score tables. + * * Will return the score of the specified user and several of their neighbors in a game. * * This method will currently return scores for the target user, plus two of their closest neighbors on each side. - * Will also return the top three users if the user and his neighbors are not among them. + * Will also return the top three users if the user and their neighbors are not among them. * Please note that this behavior is subject to change. * * @param userId Target user id @@ -1580,12 +1752,32 @@ public: * @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the sent message * @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message * - * @return On success, returns an Array of GameHighScore objects. + * @return Returns an Array of GameHighScore objects. */ std::vector<GameHighScore::Ptr> getGameHighScores(std::int64_t userId, std::int64_t chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "") const; + + /** + * @brief Download a file from Telegram and save it in memory. + * + * @param filePath Telegram file path from Api::getFile + * @param args Additional api parameters + * + * @return File content in a string. + */ + std::string downloadFile(const std::string& filePath, + const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const; + + /** + * @brief Check if user has blocked the bot + * + * @param chatId Unique identifier for the target chat + * + * @return Returns True if bot is blocked by user + */ + bool blockedByUser(std::int64_t chatId) const; private: boost::property_tree::ptree sendRequest(const std::string& method, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const; |