diff options
author | llnulldisk <48621230+llnulldisk@users.noreply.github.com> | 2022-08-30 19:34:12 +0200 |
---|---|---|
committer | llnulldisk <48621230+llnulldisk@users.noreply.github.com> | 2022-08-30 19:34:12 +0200 |
commit | 4aa6af3180aef70f9a4320a2f6d818f68f5bb669 (patch) | |
tree | 14879274b4640594954a6c4c7acfb2277f62c512 /include | |
parent | eb1de0a6148c88510be63ac57f1c03fddb6cb395 (diff) |
Sort api methods
Diffstat (limited to 'include')
-rw-r--r-- | include/tgbot/Api.h | 815 |
1 files changed, 410 insertions, 405 deletions
diff --git a/include/tgbot/Api.h b/include/tgbot/Api.h index e5a17f5..755998b 100644 --- a/include/tgbot/Api.h +++ b/include/tgbot/Api.h @@ -49,6 +49,51 @@ public: Api(std::string token, const HttpClient& httpClient, const std::string& url); /** + * @brief Use this method to receive incoming updates using long polling. + * + * This method will not work if an outgoing webhook is set up. + * In order to avoid getting duplicate updates, recalculate offset after each server response. + * + * @param offset Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. + * @param limit Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. + * @param timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. + * @param allowed_updates Optional. List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. + * @return An Array of Update objects + */ + std::vector<Update::Ptr> getUpdates(std::int32_t offset = 0, std::int32_t limit = 100, std::int32_t timeout = 0, const StringArrayPtr& allowedUpdates = nullptr) const; + + /** + * @brief Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. + * + * If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. + * You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. + * We currently do not support self-signed certificates. + * Ports currently supported for Webhooks: 443, 80, 88, 8443. + * + * @param url Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration. + */ + void setWebhook(const std::string& url = "", InputFile::Ptr certificate = nullptr, std::int32_t maxConnection = 40, const StringArrayPtr& allowedUpdates = nullptr) const; + + /** + * @brief Use this method to remove webhook integration if you decide to switch back to getUpdates. + * + * Requires no parameters. + * + * @return Returns True on success. + */ + bool deleteWebhook() const; + + /** + * @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. + * + * @return On success, returns a WebhookInfo object. + */ + 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. */ @@ -56,7 +101,7 @@ public: /** * @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) * @param text Text of the message to be sent * @param parseMode Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. @@ -64,7 +109,7 @@ 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 reply keyboard or to force a reply from the user. - * + * * @return On success, the sent @ref Message is returned. */ Message::Ptr sendMessage(boost::variant<std::int64_t, const std::string&> chatId, const std::string& text, const std::string& parseMode = "", @@ -125,7 +170,7 @@ public: * @param disableNotification Optional. Sends the message silenty. * @return On success, the sent message is returned. */ - Message::Ptr sendAudio(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> audio, const std::string &caption = "", std::int32_t duration = 0, + Message::Ptr sendAudio(std::int64_t 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, std::string> thumb = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const; @@ -141,171 +186,10 @@ public: * @param disableNotification Optional. Sends the message silenty. * @return On success, the sent message is returned. */ - Message::Ptr sendDocument(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> document, boost::variant<InputFile::Ptr, std::string> thumb = "", const std::string &caption = "", std::int32_t replyToMessageId = 0, + Message::Ptr sendDocument(std::int64_t 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>(), const std::string& parseMode = "", bool disableNotification = false) const; /** - * @brief Use this method to send invoices. - * @param chatId Unique identifier for the target private chat. - * @param title Product name, 1-32 characters. - * @param description Product description, 1-255 characters. - * @param payload Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. - * @param providerToken Payments provider token, obtained via Botfather. - * @param startParameter Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter. - * @param currency Three-letter ISO 4217 currency code. - * @param prices Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) - * @param providerData Optional. JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. - * @param photoUrl Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. - * @param photoSize Optional. Photo size - * @param photoWidth Optional. Photo width - * @param photoHeight Optional. Photo height - * @param needName Optional. Pass True, if you require the user's full name to complete the order. - * @param needPhoneNumber Optional. Pass True, if you require the user's phone number to complete the order. - * @param needEmail Optional. Pass True, if you require the user's email address to complete the order. - * @param needShippingAddress Optional. Pass True, if you require the user's shipping address to complete the order. - * @param sendPhoneNumberToProvider Optional. Pass True, if user's phone number should be sent to provider. - * @param sendEmailToProvider Optional. Pass True, if user's email address should be sent to provider - * @param isFlexible Optional. Pass True, if the final price depends on the shipping method. - * @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 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. - * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. - * @return On success, the sent Message is returned. - */ - Message::Ptr sendInvoice(std::int64_t chatId, const std::string& title, const std::string& description, const std::string& payload, - const std::string& providerToken, const std::string& startParameter, const std::string& currency, const std::vector<LabeledPrice::Ptr>& prices, - const std::string& providerData = "", const std::string& photoUrl = "", std::int32_t photoSize = 0, - std::int32_t photoWidth = 0, std::int32_t photoHeight = 0, bool needName = false, - bool needPhoneNumber = false, bool needEmail = false, bool needShippingAddress = false, - bool sendPhoneNumberToProvider = false, bool sendEmailToProvider = false, bool isFlexible = false, - std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const; - - /** - * @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. - * - * @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 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; - - /** - * @brief Use this method to respond to such pre-checkout queries. - * - * Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field preCheckoutQuery. - * Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. - * - * @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; - - /** - * @brief Use this method to send .webp stickers. - * @param chatId Unique identifier for the target chat. - * @param sticker Sticker to send. - * @param replyToMessageId Optional. If the message is a reply, ID of the original message. - * @param replyMarkup Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. - * @param disableNotification Optional. Sends the message silenty. - * @return On success, the sent message is returned. - */ - Message::Ptr sendSticker(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> sticker, std::int32_t replyToMessageId = 0, - GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const; - - /** - * @brief Use this method to get a sticker set. - * @param chatId Name of the sticker set. - * @return On success, a StickerSet object is returned. - */ - StickerSet::Ptr getStickerSet(const std::string& name) 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. - * @return Returns the uploaded File on success. - */ - 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. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields pngSticker or tgsSticker. - * - * @param userId User identifier of created sticker set owner - * @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters. - * @param title Sticker set title, 1-64 characters - * @param emojis One or more emoji corresponding to the sticker - * @param pngSticker Optional. 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. Pass a file_id 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. - * @param tgsSticker Optional. TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements - * @param containsMasks Optional. Pass True, if a set of mask stickers should be created - * @param maskPosition Optional. A JSON-serialized object for position where the mask should be placed on faces - * - * @return Returns True on success. - */ - bool createNewStickerSet(std::int64_t userId, const std::string& name, const std::string& title, - const std::string& emojis, boost::variant<InputFile::Ptr, std::string> pngSticker = "", boost::variant<InputFile::Ptr, std::string> tgsSticker = "", - bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) const; - - /** - * @brief Deprecated. Use @ref Api::createNewStickerSet - * @deprecated since Bot API 4.7. This remains unchanged for backward compatibility. - */ - bool createNewStickerSet(std::int64_t userId, const std::string& name, const std::string& title, - boost::variant<InputFile::Ptr, std::string> pngSticker, const std::string& emojis, bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) const; - - /** - * @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 or tgs_sticker. 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. - * - * @param userId User identifier of sticker set owner - * @param name Sticker set name - * @param emojis One or more emoji corresponding to the sticker - * @param pngSticker Optional. 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. Pass a file_id 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. - * @param tgsSticker Optional. TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements - * @param maskPosition Optional. A JSON-serialized object for position where the mask should be placed on faces - * - * @return Returns True on success. - */ - bool addStickerToSet(std::int64_t userId, const std::string& name, const std::string& emojis, - boost::variant<InputFile::Ptr, std::string> pngSticker = "", boost::variant<InputFile::Ptr, std::string> tgsSticker = "", MaskPosition::Ptr maskPosition = nullptr) const; - - /** - * @brief Deprecated. Use @ref Api::addStickerToSet - * @deprecated since Bot API 4.7. This remains unchanged for backward compatibility. - */ - bool addStickerToSet(std::int64_t userId, const std::string& name, boost::variant<InputFile::Ptr, std::string> pngSticker, - const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr) const; - - /** - * @brief Use this method to move a sticker in a set created by the bot to a specific position. - * @param stickers File identifier of the sticker. - * @param position New sticker position in the set, zero-based. - * @return Returns True on success. - */ - bool setStickerPositionInSet(const std::string& sticker, std::uint32_t position) const; - - /** - * @brief Use this method to delete a sticker from a set created by the bot. - * @param stickers File identifier of the sticker. - * @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. - * - * @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 file_id 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. - * - * @return Returns True on success. - */ - bool setStickerSetThumb(const std::string& name, std::int64_t userId, boost::variant<InputFile::Ptr, std::string> thumb = "") const; - - /** * @brief Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). * @param chatId Unique identifier for the target chat. * @param video Video to send. @@ -321,7 +205,6 @@ public: * @param disableNotification Optional. Sends the message silenty. * @return On success, the sent message is returned. */ - Message::Ptr sendVideo(std::int64_t 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, std::string> thumb = "", const std::string& caption = "", std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const; @@ -343,8 +226,24 @@ public: * @param disableNotification Optional. Sends the message silenty. * @return On success, the sent Message is returned. */ - Message::Ptr sendAnimation(std::int64_t 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, std::string> thumb = "", const std::string &caption = "", - std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const; + Message::Ptr sendAnimation(std::int64_t 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, std::string> thumb = "", const std::string& caption = "", + std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const; + + /** + * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. + * @param chatId Unique identifier for the target chat. + * @param voice Audio file to send. + * @param caption Voice message caption, 0-200 characters + * @param duration Duration of send audio in seconds. + * @param replyToMessageId Optional. If the message is a reply, ID of the original message. + * @param replyMarkup Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. + * @param parseMode Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. + * @param disableNotification Optional. Sends the message silenty. + * @return On success, the sent message is returned. + */ + Message::Ptr sendVoice(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> voice, const std::string& caption = "", int duration = 0, std::int32_t replyToMessageId = 0, + GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const; + /** * @brief Use this method to send video messages. On success, the sent Message is returned. * @param chatId Unique identifier for the target chat. @@ -372,33 +271,6 @@ public: bool disableNotification = false, std::int32_t replyToMessageId = 0) const; /** - * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. - * @param chatId Unique identifier for the target chat. - * @param voice Audio file to send. - * @param caption Voice message caption, 0-200 characters - * @param duration Duration of send audio in seconds. - * @param replyToMessageId Optional. If the message is a reply, ID of the original message. - * @param replyMarkup Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. - * @param parseMode Optional. Set it to "Markdown" or "HTML" if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. - * @param disableNotification Optional. Sends the message silenty. - * @return On success, the sent message is returned. - */ - Message::Ptr sendVoice(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> voice, const std::string& caption = "", int duration = 0, std::int32_t replyToMessageId = 0, - GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) 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 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 game_title’ button will be shown. If not empty, the first button must launch the game. - * @param disableNotification Optional. Sends the message silenty. - * @return On success, the sent message is returned. - */ - Message::Ptr sendGame(std::int64_t chatId, const std::string& gameShortName, std::int32_t replyToMessageId = 0, - InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>(), bool disableNotification = false) const; - - /** * @brief Use this method to send point on the map. * @param chatId Unique identifier for the target chat. * @param latitude Latitude of location. @@ -436,7 +308,6 @@ public: Message::Ptr stopMessageLiveLocation(std::int64_t chatId = 0, std::int32_t messageId = 0, std::int32_t inlineMessageId = 0, InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const; - /** * @brief Use this method to send information about a venue. On success, the sent Message is returned. * @param chatId Unique identifier for the target chat. @@ -467,7 +338,49 @@ public: * @return On success, the sent message is returned. */ Message::Ptr sendContact(std::int64_t chatId, const std::string& phoneNumber, const std::string& firstName, const std::string& lastName = "", const std::string& vcard = "", bool disableNotification = false, - std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; + std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; + + /** + * @brief Use this method to send a native poll. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @param question Poll question, 1-255 characters + * @param options A JSON-serialized list of answer options, 2-10 strings 1-100 characters each + * @param isAnonymous Optional. True, if the poll needs to be anonymous, defaults to True + * @param type Optional. Poll type, “quiz” or “regular”, defaults to “regular” + * @param allowsMultipleAnswers Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False + * @param correctOptionId Optional. 0-based identifier of the correct answer option, required for polls in quiz mode + * @param isClosed Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. + * @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 reply keyboard or to force a reply from the user. + * + * @return On success, the sent @ref Message is returned. + */ + Message::Ptr sendPoll(std::int64_t chatId, const std::string& question, const std::vector<std::string>& options, + bool isAnonymous = true, const std::string& type = "", bool allowsMultipleAnswers = false, + std::int32_t correctOptionId = 0, bool isClosed = false, bool disableNotification = false, + std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; + + /** + * @brief Deprecated. Use @ref Api::sendPoll + * @deprecated since Bot API 4.6. This remains unchanged for backward compatibility. + */ + Message::Ptr sendPoll(std::int64_t chatId, const std::string& question, const std::vector<std::string>& options, + bool disableNotification = false, std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; + + /** + * @brief Use this method to send a dice, which will have a random value from 1 to 6. + * + * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) + * @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 reply keyboard or to force a reply from the user. + * + * @return On success, the sent @ref Message is returned. + */ + Message::Ptr sendDice(std::int64_t chatId, bool disableNotification = false, std::int32_t replyToMessageId = 0, + GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; /** * @brief Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). @@ -494,7 +407,144 @@ public: * @param fileId File identifier to get info about * @return A File object. */ - File::Ptr getFile(const std::string &fileId) const; + 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 or a supergroup. + * @param chatId Unique identifier for the target group. + * @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. + * @return True on success + */ + bool kickChatMember(std::int64_t chatId, std::int64_t userId, std::uint64_t untilDate = 0) const; + + /** + * @brief Use this method to unban a previously kicked user in a supergroup. + * @param chatId Unique identifier for the target group. + * @param userId Unique identifier of the target user. + * @return True on success + */ + bool unbanChatMember(std::int64_t chatId, std::int64_t userId) const; + + /** + * @brief Use this method to restrict a user in a supergroup. + * @param chatId Unique identifier for the target chat of the target supergroup. + * @param userId Unique identifier of the target user. + * @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. + * @param canSendMessages Optional. Pass True, if the user can send text messages, contacts, locations and venues. + * @param canSendMediaMessages Optional. Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages. + * @param canSendOtherMessages Optional. Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages. + * @param canAddWebPagePreviews Optional. Pass True, if the user may add web page previews to their messages, implies can_send_media_messages. + * @return True on success + */ + bool restrictChatMember(std::int64_t chatId, std::int64_t userId, ChatPermissions::Ptr permissions, std::uint64_t untilDate = 0) const; + + /** + * @brief Use this method to promote or demote a user in a supergroup or a channel. + * @param chatId Unique identifier for the target chat of the target supergroup or channal. + * @param userId Unique identifier of the target user. + * @param canChangeInfo Optional. Pass True, if the administrator can change chat title, photo and other settings. + * @param canPostMessages Optional. Pass True, if the administrator can create channel posts, channels only. + * @param canEditMessages Optional. Pass True, if the administrator can edit messages of other users and can pin messages, channels only. + * @param canDeleteMessages Optional. Pass True, if the administrator can delete messages of other users. + * @param canInviteUsers Optional. Pass True, if the administrator can invite new users to the chat. + * @param canRestrictMembers Optional. Pass True, if the administrator can restrict, ban or unban chat members. + * @param canPinMessages Optional. Pass True, if the administrator can pin messages, supergroups only. + * @param canPromoteMembers Optional. Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him). + * @return True on success + */ + bool promoteChatMember(std::int64_t chatId, std::int64_t userId, bool canChangeInfo = false, bool canPostMessages = false, + bool canEditMessages = false, bool canDeleteMessages = false, bool canInviteUsers = false, bool canPinMessages = false, bool canPromoteMembers = false) const; + + /** + * @brief Use this method to set a custom title for an administrator in a supergroup promoted by the bot. + * + * @param chatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + * @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 + */ + bool setChatAdministratorCustomTitle(std::int64_t chatId, std::int64_t userId, const std::string& customTitle) 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 + */ + bool setChatPermissions(std::int64_t 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. + */ + std::string exportChatInviteLink(std::int64_t chatId) const; + + /** + * @brief Use this method to set a new profile photo for the chat. + * + * Photos can't be changed for private chats. + * + * @param chatId Unique identifier for the target chat. + * @param photo New chat photo. + * @return True on success + */ + bool setChatPhoto(std::int64_t chatId, InputFile::Ptr photo) const; + + /** + * @brief Use this method to delete a chat photo. + * + * Photos can't be changed for private chats. + * + * @param chatId Unique identifier for the target chat. + * @return True on success + */ + bool deleteChatPhoto(std::int64_t chatId) const; + + /** + * @brief Use this method to change the title of a chat. + * + * Titles can't be changed for private chats. + * + * @param chatId Unique identifier for the target chat. + * @param title New chat title, 1-255 characters. + * @return True on success + */ + bool setChatTitle(std::int64_t 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 + */ + bool setChatDescription(std::int64_t 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 + */ + bool pinChatMessage(std::int64_t chatId, std::int32_t messageId, bool disableNotification = false) const; + + /** + * @brief Use this method to unpin a message in a group, a supergroup, or a channel. + * @param chatId Unique identifier for the target chat or username of the target channel. + * @return True on success + */ + bool unpinChatMessage(std::int64_t chatId) const; /** * @brief Use this method for your bot to leave a group, supergroup or channel. @@ -547,7 +597,6 @@ public: */ bool deleteChatStickerSet(std::int64_t 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. * @param callbackQueryId Unique identifier for the query to be answered @@ -557,7 +606,20 @@ public: * @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 */ - 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. + * @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. + * @return True on success. + */ + bool setMyCommands(const std::vector<BotCommand::Ptr>& commands) const; + + /** + * @brief Use this method to get the current list of the bot's commands. + * @return Array of @ref BotCommand on success. + */ + std::vector<BotCommand::Ptr> getMyCommands() const; /** * @brief Use this method to edit text and game messages sent by the bot or via the bot (for inline bots) @@ -570,7 +632,7 @@ public: * @param replyMarkup Optional A JSON-serialized object for an inline keyboard. * @return Message object on success, otherwise nullptr */ - Message::Ptr editMessageText(const std::string& text, std::int64_t chatId=0, std::int32_t messageId=0, const std::string& inlineMessageId="", + Message::Ptr editMessageText(const std::string& text, std::int64_t chatId = 0, std::int32_t messageId = 0, const std::string& inlineMessageId = "", const std::string& parseMode = "", bool disableWebPagePreview = false, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; /** @@ -615,6 +677,17 @@ public: 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 replyMarkup Optional. A JSON-serialized object for a new message inline keyboard. + * + * @return On success, the stopped Poll with the final results is returned. + */ + + Poll::Ptr stopPoll(std::int64_t 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. @@ -622,193 +695,192 @@ public: void deleteMessage(std::int64_t chatId, std::int32_t messageId) const; /** - * @brief Use this method to receive incoming updates using long polling. - * - * This method will not work if an outgoing webhook is set up. - * In order to avoid getting duplicate updates, recalculate offset after each server response. - * - * @param offset Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. - * @param limit Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. - * @param timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. - * @param allowed_updates Optional. List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. - * @return An Array of Update objects + * @brief Use this method to send .webp stickers. + * @param chatId Unique identifier for the target chat. + * @param sticker Sticker to send. + * @param replyToMessageId Optional. If the message is a reply, ID of the original message. + * @param replyMarkup Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. + * @param disableNotification Optional. Sends the message silenty. + * @return On success, the sent message is returned. */ - std::vector<Update::Ptr> getUpdates(std::int32_t offset = 0, std::int32_t limit = 100, std::int32_t timeout = 0, const StringArrayPtr &allowedUpdates = nullptr) const; + Message::Ptr sendSticker(std::int64_t chatId, boost::variant<InputFile::Ptr, std::string> sticker, std::int32_t replyToMessageId = 0, + GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const; /** - * @brief Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. - * - * If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. - * You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. - * We currently do not support self-signed certificates. - * Ports currently supported for Webhooks: 443, 80, 88, 8443. - * - * @param url Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration. + * @brief Use this method to get a sticker set. + * @param chatId Name of the sticker set. + * @return On success, a StickerSet object is returned. */ - void setWebhook(const std::string& url = "", InputFile::Ptr certificate = nullptr, std::int32_t maxConnection = 40, const StringArrayPtr &allowedUpdates = nullptr) const; + StickerSet::Ptr getStickerSet(const std::string& name) const; /** - * @brief Use this method to remove webhook integration if you decide to switch back to getUpdates. - * - * Requires no parameters. - * - * @return Returns True on success. + * @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. + * @return Returns the uploaded File on success. */ - bool deleteWebhook() const; + File::Ptr uploadStickerFile(std::int64_t userId, InputFile::Ptr pngSticker) const; /** - * @brief Use this method to get current webhook status. + * @brief Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields pngSticker or tgsSticker. * - * Requires no parameters. - * If the bot is using getUpdates, will return an object with the url field empty. + * @param userId User identifier of created sticker set owner + * @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters. + * @param title Sticker set title, 1-64 characters + * @param emojis One or more emoji corresponding to the sticker + * @param pngSticker Optional. 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. Pass a file_id 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. + * @param tgsSticker Optional. TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements + * @param containsMasks Optional. Pass True, if a set of mask stickers should be created + * @param maskPosition Optional. A JSON-serialized object for position where the mask should be placed on faces * - * @return On success, returns a WebhookInfo object. + * @return Returns True on success. */ - WebhookInfo::Ptr getWebhookInfo() const; + bool createNewStickerSet(std::int64_t userId, const std::string& name, const std::string& title, + const std::string& emojis, boost::variant<InputFile::Ptr, std::string> pngSticker = "", boost::variant<InputFile::Ptr, std::string> tgsSticker = "", + bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) 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 + * @brief Deprecated. Use @ref Api::createNewStickerSet + * @deprecated since Bot API 4.7. This remains unchanged for backward compatibility. */ - 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 createNewStickerSet(std::int64_t userId, const std::string& name, const std::string& title, + boost::variant<InputFile::Ptr, std::string> pngSticker, const std::string& emojis, bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) const; /** - * @brief Use this method to kick a user from a group or a supergroup. - * @param chatId Unique identifier for the target group. - * @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. - * @return True on success + * @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 or tgs_sticker. 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. + * + * @param userId User identifier of sticker set owner + * @param name Sticker set name + * @param emojis One or more emoji corresponding to the sticker + * @param pngSticker Optional. 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. Pass a file_id 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. + * @param tgsSticker Optional. TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements + * @param maskPosition Optional. A JSON-serialized object for position where the mask should be placed on faces + * + * @return Returns True on success. */ - bool kickChatMember(std::int64_t chatId, std::int64_t userId, std::uint64_t untilDate = 0) const; + bool addStickerToSet(std::int64_t userId, const std::string& name, const std::string& emojis, + boost::variant<InputFile::Ptr, std::string> pngSticker = "", boost::variant<InputFile::Ptr, std::string> tgsSticker = "", MaskPosition::Ptr maskPosition = nullptr) const; /** - * @brief Use this method to unban a previously kicked user in a supergroup. - * @param chatId Unique identifier for the target group. - * @param userId Unique identifier of the target user. - * @return True on success + * @brief Deprecated. Use @ref Api::addStickerToSet + * @deprecated since Bot API 4.7. This remains unchanged for backward compatibility. */ - bool unbanChatMember(std::int64_t chatId, std::int64_t userId) const; + bool addStickerToSet(std::int64_t userId, const std::string& name, boost::variant<InputFile::Ptr, std::string> pngSticker, + const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr) const; /** - * @brief Use this method to restrict a user in a supergroup. - * @param chatId Unique identifier for the target chat of the target supergroup. - * @param userId Unique identifier of the target user. - * @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. - * @param canSendMessages Optional. Pass True, if the user can send text messages, contacts, locations and venues. - * @param canSendMediaMessages Optional. Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages. - * @param canSendOtherMessages Optional. Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages. - * @param canAddWebPagePreviews Optional. Pass True, if the user may add web page previews to their messages, implies can_send_media_messages. - * @return True on success + * @brief Use this method to move a sticker in a set created by the bot to a specific position. + * @param stickers File identifier of the sticker. + * @param position New sticker position in the set, zero-based. + * @return Returns True on success. */ - bool restrictChatMember(std::int64_t chatId, std::int64_t userId, ChatPermissions::Ptr permissions, std::uint64_t untilDate = 0) const; + bool setStickerPositionInSet(const std::string& sticker, std::uint32_t position) const; /** - * @brief Use this method to promote or demote a user in a supergroup or a channel. - * @param chatId Unique identifier for the target chat of the target supergroup or channal. - * @param userId Unique identifier of the target user. - * @param canChangeInfo Optional. Pass True, if the administrator can change chat title, photo and other settings. - * @param canPostMessages Optional. Pass True, if the administrator can create channel posts, channels only. - * @param canEditMessages Optional. Pass True, if the administrator can edit messages of other users and can pin messages, channels only. - * @param canDeleteMessages Optional. Pass True, if the administrator can delete messages of other users. - * @param canInviteUsers Optional. Pass True, if the administrator can invite new users to the chat. - * @param canRestrictMembers Optional. Pass True, if the administrator can restrict, ban or unban chat members. - * @param canPinMessages Optional. Pass True, if the administrator can pin messages, supergroups only. - * @param canPromoteMembers Optional. Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him). - * @return True on success + * @brief Use this method to delete a sticker from a set created by the bot. + * @param stickers File identifier of the sticker. + * @return Returns True on success. */ - bool promoteChatMember(std::int64_t chatId, std::int64_t userId, bool canChangeInfo = false, bool canPostMessages = false, - bool canEditMessages = false, bool canDeleteMessages = false, bool canInviteUsers = false, bool canPinMessages = false, bool canPromoteMembers = false) const; + bool deleteStickerFromSet(const std::string& sticker) const; /** - * @brief Use this method to set a custom title for an administrator in a supergroup promoted by the bot. - * - * @param chatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - * @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 + * @brief Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated 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 file_id 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. + * + * @return Returns True on success. */ - bool setChatAdministratorCustomTitle(std::int64_t chatId, std::int64_t userId, const std::string& customTitle) const; + bool setStickerSetThumb(const std::string& name, std::int64_t userId, boost::variant<InputFile::Ptr, std::string> thumb = "") 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. + * @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 */ - bool setChatPermissions(std::int64_t 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. - */ - std::string exportChatInviteLink(std::int64_t chatId) 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 a new profile photo for the chat. - * - * Photos can't be changed for private chats. - * - * @param chatId Unique identifier for the target chat. - * @param photo New chat photo. - * @return True on success + * @brief Use this method to send invoices. + * @param chatId Unique identifier for the target private chat. + * @param title Product name, 1-32 characters. + * @param description Product description, 1-255 characters. + * @param payload Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. + * @param providerToken Payments provider token, obtained via Botfather. + * @param startParameter Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter. + * @param currency Three-letter ISO 4217 currency code. + * @param prices Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) + * @param providerData Optional. JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. + * @param photoUrl Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. + * @param photoSize Optional. Photo size + * @param photoWidth Optional. Photo width + * @param photoHeight Optional. Photo height + * @param needName Optional. Pass True, if you require the user's full name to complete the order. + * @param needPhoneNumber Optional. Pass True, if you require the user's phone number to complete the order. + * @param needEmail Optional. Pass True, if you require the user's email address to complete the order. + * @param needShippingAddress Optional. Pass True, if you require the user's shipping address to complete the order. + * @param sendPhoneNumberToProvider Optional. Pass True, if user's phone number should be sent to provider. + * @param sendEmailToProvider Optional. Pass True, if user's email address should be sent to provider + * @param isFlexible Optional. Pass True, if the final price depends on the shipping method. + * @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 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. + * @param disableNotification Optional. Sends the message silently. Users will receive a notification with no sound. + * @return On success, the sent Message is returned. */ - bool setChatPhoto(std::int64_t chatId, InputFile::Ptr photo) const; + Message::Ptr sendInvoice(std::int64_t chatId, const std::string& title, const std::string& description, const std::string& payload, + const std::string& providerToken, const std::string& startParameter, const std::string& currency, const std::vector<LabeledPrice::Ptr>& prices, + const std::string& providerData = "", const std::string& photoUrl = "", std::int32_t photoSize = 0, + std::int32_t photoWidth = 0, std::int32_t photoHeight = 0, bool needName = false, + bool needPhoneNumber = false, bool needEmail = false, bool needShippingAddress = false, + bool sendPhoneNumberToProvider = false, bool sendEmailToProvider = false, bool isFlexible = false, + std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const; /** - * @brief Use this method to delete a chat photo. + * @brief Use this method to reply to shipping queries. * - * Photos can't be changed for private chats. + * 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. * - * @param chatId Unique identifier for the target chat. - * @return True on success + * @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 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 deleteChatPhoto(std::int64_t chatId) 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 change the title of a chat. + * @brief Use this method to respond to such pre-checkout queries. * - * Titles can't be changed for private chats. + * Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field preCheckoutQuery. + * Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. * - * @param chatId Unique identifier for the target chat. - * @param title New chat title, 1-255 characters. - * @return True on success + * @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 setChatTitle(std::int64_t chatId, const std::string& title) const; + bool answerPreCheckoutQuery(const std::string& preCheckoutQueryId, bool ok, const std::string& errorMessage = "") const; /** - * @brief Use this method to change the description of a supergroup or a channel. + * @brief Use this method to send a game. * @param chatId Unique identifier for the target chat. - * @param description New chat description, 1-255 characters. - * @return True on success - */ - bool setChatDescription(std::int64_t 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 - */ - bool pinChatMessage(std::int64_t chatId, std::int32_t messageId, bool disableNotification = false) const; - - /** - * @brief Use this method to unpin a message in a group, a supergroup, or a channel. - * @param chatId Unique identifier for the target chat or username of the target channel. - * @return True on success + * @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 game_title’ button will be shown. If not empty, the first button must launch the game. + * @param disableNotification Optional. Sends the message silenty. + * @return On success, the sent message is returned. */ - bool unpinChatMessage(std::int64_t chatId) const; + Message::Ptr sendGame(std::int64_t chatId, const std::string& gameShortName, std::int32_t replyToMessageId = 0, + InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>(), bool disableNotification = false) const; /** * @brief Use this method to set the score of the specified user in a game. @@ -840,73 +912,7 @@ public: */ std::vector<GameHighScore::Ptr> getGameHighScores(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 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 send a native poll. - * - * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) - * @param question Poll question, 1-255 characters - * @param options A JSON-serialized list of answer options, 2-10 strings 1-100 characters each - * @param isAnonymous Optional. True, if the poll needs to be anonymous, defaults to True - * @param type Optional. Poll type, “quiz” or “regular”, defaults to “regular” - * @param allowsMultipleAnswers Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False - * @param correctOptionId Optional. 0-based identifier of the correct answer option, required for polls in quiz mode - * @param isClosed Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. - * @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 reply keyboard or to force a reply from the user. - * - * @return On success, the sent @ref Message is returned. - */ - Message::Ptr sendPoll(std::int64_t chatId, const std::string& question, const std::vector<std::string>& options, - bool isAnonymous = true, const std::string& type = "", bool allowsMultipleAnswers = false, - std::int32_t correctOptionId = 0, bool isClosed = false, bool disableNotification = false, - std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; - - /** - * @brief Deprecated. Use @ref Api::sendPoll - * @deprecated since Bot API 4.6. This remains unchanged for backward compatibility. - */ - Message::Ptr sendPoll(std::int64_t chatId, const std::string& question, const std::vector<std::string>& options, - bool disableNotification = false, std::int32_t replyToMessageId = 0, GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const; - - /** - * @brief Use this method to send a dice, which will have a random value from 1 to 6. - * - * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) - * @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 reply keyboard or to force a reply from the user. - * - * @return On success, the sent @ref Message is returned. - */ - Message::Ptr sendDice(std::int64_t chatId, bool disableNotification = false, std::int32_t replyToMessageId = 0, - 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 replyMarkup Optional. A JSON-serialized object for a new message inline keyboard. - * - * @return On success, the stopped Poll with the final results is returned. - */ - - Poll::Ptr stopPoll(std::int64_t chatId, std::int64_t messageId, InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const; - - - bool setMyCommands(const std::vector<BotCommand::Ptr>& commands) const; - - std::vector<BotCommand::Ptr> getMyCommands() const; - + private: boost::property_tree::ptree sendRequest(const std::string& method, const std::vector<HttpReqArg>& args = std::vector<HttpReqArg>()) const; @@ -915,7 +921,6 @@ private: const TgTypeParser _tgTypeParser; const std::string _url; }; - } #endif //TGBOT_CPP_API_H |