Webhook docs (#1248)

* Added documentation for polling/webhook modes

* Added changelog

* Added changelog
This commit is contained in:
Alex Root Junior 2023-08-06 16:59:29 +03:00 committed by GitHub
parent 62d4b9014c
commit b311d59fce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
37 changed files with 2595 additions and 692 deletions

View file

@ -0,0 +1,30 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2023, aiogram Team
# This file is distributed under the same license as the aiogram package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/enums/currency.rst:3
msgid "Currency"
msgstr ""
#: aiogram.enums.currency.Currency:1 of
msgid "Currencies supported by Telegram Bot API"
msgstr ""
#: aiogram.enums.currency.Currency:3 of
msgid "Source: https://core.telegram.org/bots/payments#supported-currencies"
msgstr ""

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-10-01 22:51+0300\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.10.3\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/methods/answer_pre_checkout_query.rst:3
msgid "answerPreCheckoutQuery"
@ -65,36 +65,44 @@ msgid ""
" user."
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:14
#: ../../api/methods/answer_pre_checkout_query.rst:15
msgid "Usage"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:17
#: ../../api/methods/answer_pre_checkout_query.rst:18
msgid "As bot method"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:25
#: ../../api/methods/answer_pre_checkout_query.rst:26
msgid "Method as object"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:27
#: ../../api/methods/answer_pre_checkout_query.rst:28
msgid "Imports:"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:29
#: ../../api/methods/answer_pre_checkout_query.rst:30
msgid ""
":code:`from aiogram.methods.answer_pre_checkout_query import "
"AnswerPreCheckoutQuery`"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:30
#: ../../api/methods/answer_pre_checkout_query.rst:31
msgid "alias: :code:`from aiogram.methods import AnswerPreCheckoutQuery`"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:33
#: ../../api/methods/answer_pre_checkout_query.rst:34
msgid "With specific bot"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:40
#: ../../api/methods/answer_pre_checkout_query.rst:41
msgid "As reply into Webhook in handler"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:49
msgid "As shortcut from received object"
msgstr ""
#: ../../api/methods/answer_pre_checkout_query.rst:51
msgid ":meth:`aiogram.types.pre_checkout_query.PreCheckoutQuery.answer`"
msgstr ""

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-10-01 22:51+0300\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.10.3\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/methods/answer_shipping_query.rst:3
msgid "answerShippingQuery"
@ -69,36 +69,44 @@ msgid ""
"this message to the user."
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:14
#: ../../api/methods/answer_shipping_query.rst:15
msgid "Usage"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:17
#: ../../api/methods/answer_shipping_query.rst:18
msgid "As bot method"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:25
#: ../../api/methods/answer_shipping_query.rst:26
msgid "Method as object"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:27
#: ../../api/methods/answer_shipping_query.rst:28
msgid "Imports:"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:29
#: ../../api/methods/answer_shipping_query.rst:30
msgid ""
":code:`from aiogram.methods.answer_shipping_query import "
"AnswerShippingQuery`"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:30
#: ../../api/methods/answer_shipping_query.rst:31
msgid "alias: :code:`from aiogram.methods import AnswerShippingQuery`"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:33
#: ../../api/methods/answer_shipping_query.rst:34
msgid "With specific bot"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:40
#: ../../api/methods/answer_shipping_query.rst:41
msgid "As reply into Webhook in handler"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:49
msgid "As shortcut from received object"
msgstr ""
#: ../../api/methods/answer_shipping_query.rst:51
msgid ":meth:`aiogram.types.shipping_query.ShippingQuery.answer`"
msgstr ""

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-23 00:47+0200\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.10.3\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/methods/edit_message_reply_markup.rst:3
msgid "editMessageReplyMarkup"
@ -70,48 +70,52 @@ msgid ""
"<https://core.telegram.org/bots/features#inline-keyboards>`_."
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:14
#: ../../api/methods/edit_message_reply_markup.rst:15
msgid "Usage"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:17
#: ../../api/methods/edit_message_reply_markup.rst:18
msgid "As bot method"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:25
#: ../../api/methods/edit_message_reply_markup.rst:26
msgid "Method as object"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:27
#: ../../api/methods/edit_message_reply_markup.rst:28
msgid "Imports:"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:29
#: ../../api/methods/edit_message_reply_markup.rst:30
msgid ""
":code:`from aiogram.methods.edit_message_reply_markup import "
"EditMessageReplyMarkup`"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:30
#: ../../api/methods/edit_message_reply_markup.rst:31
msgid "alias: :code:`from aiogram.methods import EditMessageReplyMarkup`"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:33
#: ../../api/methods/edit_message_reply_markup.rst:34
msgid "With specific bot"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:40
#: ../../api/methods/edit_message_reply_markup.rst:41
msgid "As reply into Webhook in handler"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:48
#: ../../api/methods/edit_message_reply_markup.rst:49
msgid "As shortcut from received object"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:50
#: ../../api/methods/edit_message_reply_markup.rst:51
msgid ":meth:`aiogram.types.message.Message.edit_reply_markup`"
msgstr ""
#: ../../api/methods/edit_message_reply_markup.rst:52
msgid ":meth:`aiogram.types.message.Message.delete_reply_markup`"
msgstr ""
#~ msgid ""
#~ "A JSON-serialized object for an "
#~ "`inline keyboard <https://core.telegram.org/bots"

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-03-11 01:52+0200\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.11.0\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/types/message.rst:3
msgid "Message"
@ -437,6 +437,7 @@ msgstr ""
#: aiogram.types.message.Message.answer_video_note:4
#: aiogram.types.message.Message.answer_voice:4
#: aiogram.types.message.Message.delete:4
#: aiogram.types.message.Message.delete_reply_markup:4
#: aiogram.types.message.Message.edit_caption:4
#: aiogram.types.message.Message.edit_live_location:4
#: aiogram.types.message.Message.edit_media:4
@ -554,6 +555,7 @@ msgstr ""
#: aiogram.types.message.Message.answer_video_note
#: aiogram.types.message.Message.answer_voice
#: aiogram.types.message.Message.copy_to
#: aiogram.types.message.Message.delete_reply_markup
#: aiogram.types.message.Message.edit_caption
#: aiogram.types.message.Message.edit_live_location
#: aiogram.types.message.Message.edit_media
@ -836,6 +838,7 @@ msgstr ""
#: aiogram.types.message.Message.answer_video_note
#: aiogram.types.message.Message.answer_voice
#: aiogram.types.message.Message.copy_to aiogram.types.message.Message.delete
#: aiogram.types.message.Message.delete_reply_markup
#: aiogram.types.message.Message.edit_caption
#: aiogram.types.message.Message.edit_live_location
#: aiogram.types.message.Message.edit_media
@ -1941,7 +1944,7 @@ msgid "instance of method :class:`aiogram.methods.send_voice.SendVoice`"
msgstr ""
#: aiogram.types.message.Message.send_copy:1 of
msgid "Send copy of message."
msgid "Send copy of a message."
msgstr ""
#: aiogram.types.message.Message.send_copy:3 of
@ -1952,8 +1955,8 @@ msgstr ""
#: aiogram.types.message.Message.send_copy:8 of
msgid ""
"This method don't use the API method named `copyMessage` and historically"
" implemented before the similar method is added to API"
"This method doesn't use the API method named `copyMessage` and "
"historically implemented before the similar method is added to API"
msgstr ""
#: aiogram.types.message.Message.copy_to:1 of
@ -1969,6 +1972,7 @@ msgstr ""
#: aiogram.types.message.Message.copy_to:5
#: aiogram.types.message.Message.delete:5
#: aiogram.types.message.Message.delete_reply_markup:5
#: aiogram.types.message.Message.edit_caption:5
#: aiogram.types.message.Message.edit_live_location:5
#: aiogram.types.message.Message.edit_media:5
@ -2057,6 +2061,7 @@ msgstr ""
msgid "New text of the message, 1-4096 characters after entities parsing"
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:12
#: aiogram.types.message.Message.edit_caption:11
#: aiogram.types.message.Message.edit_live_location:13
#: aiogram.types.message.Message.edit_media:12
@ -2149,6 +2154,7 @@ msgid ""
":class:`aiogram.methods.edit_message_media.EditMessageMedia`"
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:1
#: aiogram.types.message.Message.edit_reply_markup:1 of
msgid ""
"Shortcut for method "
@ -2156,6 +2162,7 @@ msgid ""
" will automatically fill method attributes:"
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:8
#: aiogram.types.message.Message.edit_reply_markup:7 of
msgid ""
"Use this method to edit only the reply markup of messages. On success, if"
@ -2164,16 +2171,22 @@ msgid ""
":code:`True` is returned."
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:10
#: aiogram.types.message.Message.edit_reply_markup:9 of
msgid "Source: https://core.telegram.org/bots/api#editmessagereplymarkup"
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:13
#: aiogram.types.message.Message.edit_reply_markup:13 of
msgid ""
"instance of method "
":class:`aiogram.methods.edit_message_reply_markup.EditMessageReplyMarkup`"
msgstr ""
#: aiogram.types.message.Message.delete_reply_markup:6 of
msgid ":code:`reply_markup`"
msgstr ""
#: aiogram.types.message.Message.edit_live_location:1 of
msgid ""
"Shortcut for method "
@ -2562,3 +2575,13 @@ msgstr ""
#~ "/form-data. :ref:`More information on "
#~ "Sending Files » <sending-files>`"
#~ msgstr ""
#~ msgid "Send copy of message."
#~ msgstr ""
#~ msgid ""
#~ "This method don't use the API "
#~ "method named `copyMessage` and historically"
#~ " implemented before the similar method "
#~ "is added to API"
#~ msgstr ""

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-10-01 22:51+0300\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.10.3\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/types/pre_checkout_query.rst:3
msgid "PreCheckoutQuery"
@ -71,10 +71,58 @@ msgstr ""
msgid "*Optional*. Order information provided by the user"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:1 of
msgid ""
"Shortcut for method "
":class:`aiogram.methods.answer_pre_checkout_query.AnswerPreCheckoutQuery`"
" will automatically fill method attributes:"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:4 of
msgid ":code:`pre_checkout_query_id`"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:6 of
msgid ""
"Once the user has confirmed their payment and shipping details, the Bot "
"API sends the final confirmation in the form of an "
":class:`aiogram.types.update.Update` with the field *pre_checkout_query*."
" Use this method to respond to such pre-checkout queries. On success, "
":code:`True` is returned. **Note:** The Bot API must receive an answer "
"within 10 seconds after the pre-checkout query was sent."
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:8 of
msgid "Source: https://core.telegram.org/bots/api#answerprecheckoutquery"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer of
msgid "Parameters"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:10 of
msgid ""
"Specify :code:`True` if everything is alright (goods are available, etc.)"
" and the bot is ready to proceed with the order. Use :code:`False` if "
"there are any problems."
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:11 of
msgid ""
"Required if *ok* is :code:`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."
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer of
msgid "Returns"
msgstr ""
#: aiogram.types.pre_checkout_query.PreCheckoutQuery.answer:12 of
msgid ""
"instance of method "
":class:`aiogram.methods.answer_pre_checkout_query.AnswerPreCheckoutQuery`"
msgstr ""

View file

@ -8,14 +8,14 @@ msgid ""
msgstr ""
"Project-Id-Version: aiogram \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-10-01 22:51+0300\n"
"POT-Creation-Date: 2023-08-06 16:52+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.10.3\n"
"Generated-By: Babel 2.12.1\n"
#: ../../api/types/shipping_query.rst:3
msgid "ShippingQuery"
@ -47,10 +47,61 @@ msgstr ""
msgid "User specified shipping address"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:1 of
msgid ""
"Shortcut for method "
":class:`aiogram.methods.answer_shipping_query.AnswerShippingQuery` will "
"automatically fill method attributes:"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:4 of
msgid ":code:`shipping_query_id`"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:6 of
msgid ""
"If you sent an invoice requesting a shipping address and the parameter "
"*is_flexible* was specified, the Bot API will send an "
":class:`aiogram.types.update.Update` with a *shipping_query* field to the"
" bot. Use this method to reply to shipping queries. On success, "
":code:`True` is returned."
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:8 of
msgid "Source: https://core.telegram.org/bots/api#answershippingquery"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer of
msgid "Parameters"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:10 of
msgid ""
"Pass :code:`True` if delivery to the specified address is possible and "
":code:`False` if there are any problems (for example, if delivery to the "
"specified address is not possible)"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:11 of
msgid ""
"Required if *ok* is :code:`True`. A JSON-serialized array of available "
"shipping options."
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:12 of
msgid ""
"Required if *ok* is :code:`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."
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer of
msgid "Returns"
msgstr ""
#: aiogram.types.shipping_query.ShippingQuery.answer:13 of
msgid ""
"instance of method "
":class:`aiogram.methods.answer_shipping_query.AnswerShippingQuery`"
msgstr ""