Add docs for Dispatcher

This commit is contained in:
Alex Root Junior 2020-06-27 19:46:01 +03:00
parent 8ebbfb1388
commit 7245811c3c
197 changed files with 872 additions and 19 deletions

View file

@ -0,0 +1,11 @@
#########
Animation
#########
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
.. automodule:: aiogram.api.types.animation
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/audio.rst Normal file
View file

@ -0,0 +1,11 @@
#####
Audio
#####
This object represents an audio file to be treated as music by the Telegram clients.
.. automodule:: aiogram.api.types.audio
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########
BotCommand
##########
This object represents a bot command.
.. automodule:: aiogram.api.types.bot_command
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############
CallbackGame
############
A placeholder, currently holds no information. Use BotFather to set up your game.
.. automodule:: aiogram.api.types.callback_game
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
#############
CallbackQuery
#############
This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
.. automodule:: aiogram.api.types.callback_query
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/chat.rst Normal file
View file

@ -0,0 +1,11 @@
####
Chat
####
This object represents a chat.
.. automodule:: aiogram.api.types.chat
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########
ChatMember
##########
This object contains information about one member of a chat.
.. automodule:: aiogram.api.types.chat_member
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############
ChatPermissions
###############
Describes actions that a non-administrator user is allowed to take in a chat.
.. automodule:: aiogram.api.types.chat_permissions
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########
ChatPhoto
#########
This object represents a chat photo.
.. automodule:: aiogram.api.types.chat_photo
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
##################
ChosenInlineResult
##################
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.
.. automodule:: aiogram.api.types.chosen_inline_result
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#######
Contact
#######
This object represents a phone contact.
.. automodule:: aiogram.api.types.contact
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/dice.rst Normal file
View file

@ -0,0 +1,11 @@
####
Dice
####
This object represents an animated emoji that displays a random value.
.. automodule:: aiogram.api.types.dice
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########
Document
########
This object represents a general file (as opposed to photos, voice messages and audio files).
.. automodule:: aiogram.api.types.document
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
####################
EncryptedCredentials
####################
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
.. automodule:: aiogram.api.types.encrypted_credentials
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########################
EncryptedPassportElement
########################
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
.. automodule:: aiogram.api.types.encrypted_passport_element
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

13
docs2/api/types/file.rst Normal file
View file

@ -0,0 +1,13 @@
####
File
####
This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.
Maximum file size to download is 20 MB
.. automodule:: aiogram.api.types.file
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,21 @@
##########
ForceReply
##########
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions — without any extra work for the user.
.. automodule:: aiogram.api.types.force_reply
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/game.rst Normal file
View file

@ -0,0 +1,11 @@
####
Game
####
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
.. automodule:: aiogram.api.types.game
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,15 @@
#############
GameHighScore
#############
This object represents one row of the high scores table for a game.
And that's about all we've got for now.
If you've got any questions, please check out our Bot FAQ
.. automodule:: aiogram.api.types.game_high_score
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

160
docs2/api/types/index.rst Normal file
View file

@ -0,0 +1,160 @@
#####
Types
#####
All types is also wrapped with `pydantic <https://pydantic-docs.helpmanual.io/>`_ and placed in `aiogram.api.types` package.
In this place makes some more differences with official documentations:
- name :attr:`from` was renamed to :attr:`from_user` in due to :attr:`from` is an `keyword in python <https://docs.python.org/3/reference/lexical_analysis.html#keywords>`_
- timestamps has :class:`datetime.datetime` type instead of :class:`int`
- InputFile is used for sending files and is not use `pydantic.BaseModel` as base class
Getting updates
===============
.. toctree::
:maxdepth: 1
update
webhook_info
Available types
===============
.. toctree::
:maxdepth: 1
user
chat
message
message_entity
photo_size
animation
audio
document
video
video_note
voice
contact
dice
poll_option
poll_answer
poll
location
venue
user_profile_photos
file
reply_keyboard_markup
keyboard_button
keyboard_button_poll_type
reply_keyboard_remove
inline_keyboard_markup
inline_keyboard_button
login_url
callback_query
force_reply
chat_photo
chat_member
chat_permissions
bot_command
response_parameters
input_media
input_media_photo
input_media_video
input_media_animation
input_media_audio
input_media_document
input_file
Stickers
========
.. toctree::
:maxdepth: 1
sticker
sticker_set
mask_position
Inline mode
===========
.. toctree::
:maxdepth: 1
inline_query
inline_query_result
inline_query_result_article
inline_query_result_photo
inline_query_result_gif
inline_query_result_mpeg4_gif
inline_query_result_video
inline_query_result_audio
inline_query_result_voice
inline_query_result_document
inline_query_result_location
inline_query_result_venue
inline_query_result_contact
inline_query_result_game
inline_query_result_cached_photo
inline_query_result_cached_gif
inline_query_result_cached_mpeg4_gif
inline_query_result_cached_sticker
inline_query_result_cached_document
inline_query_result_cached_video
inline_query_result_cached_voice
inline_query_result_cached_audio
input_message_content
input_text_message_content
input_location_message_content
input_venue_message_content
input_contact_message_content
chosen_inline_result
Payments
========
.. toctree::
:maxdepth: 1
labeled_price
invoice
shipping_address
order_info
shipping_option
successful_payment
shipping_query
pre_checkout_query
Telegram Passport
=================
.. toctree::
:maxdepth: 1
passport_data
passport_file
encrypted_passport_element
encrypted_credentials
passport_element_error
passport_element_error_data_field
passport_element_error_front_side
passport_element_error_reverse_side
passport_element_error_selfie
passport_element_error_file
passport_element_error_files
passport_element_error_translation_file
passport_element_error_translation_files
passport_element_error_unspecified
Games
=====
.. toctree::
:maxdepth: 1
game
callback_game
game_high_score

View file

@ -0,0 +1,11 @@
####################
InlineKeyboardButton
####################
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
.. automodule:: aiogram.api.types.inline_keyboard_button
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
####################
InlineKeyboardMarkup
####################
This object represents an inline keyboard that appears right next to the message it belongs to.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
.. automodule:: aiogram.api.types.inline_keyboard_markup
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###########
InlineQuery
###########
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
.. automodule:: aiogram.api.types.inline_query
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,51 @@
#################
InlineQueryResult
#################
This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
- InlineQueryResultCachedAudio
- InlineQueryResultCachedDocument
- InlineQueryResultCachedGif
- InlineQueryResultCachedMpeg4Gif
- InlineQueryResultCachedPhoto
- InlineQueryResultCachedSticker
- InlineQueryResultCachedVideo
- InlineQueryResultCachedVoice
- InlineQueryResultArticle
- InlineQueryResultAudio
- InlineQueryResultContact
- InlineQueryResultGame
- InlineQueryResultDocument
- InlineQueryResultGif
- InlineQueryResultLocation
- InlineQueryResultMpeg4Gif
- InlineQueryResultPhoto
- InlineQueryResultVenue
- InlineQueryResultVideo
- InlineQueryResultVoice
.. automodule:: aiogram.api.types.inline_query_result
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########################
InlineQueryResultArticle
########################
Represents a link to an article or web page.
.. automodule:: aiogram.api.types.inline_query_result_article
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
######################
InlineQueryResultAudio
######################
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_audio
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
############################
InlineQueryResultCachedAudio
############################
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_cached_audio
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
###############################
InlineQueryResultCachedDocument
###############################
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_cached_document
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########################
InlineQueryResultCachedGif
##########################
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
.. automodule:: aiogram.api.types.inline_query_result_cached_gif
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############################
InlineQueryResultCachedMpeg4Gif
###############################
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
.. automodule:: aiogram.api.types.inline_query_result_cached_mpeg4_gif
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############################
InlineQueryResultCachedPhoto
############################
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
.. automodule:: aiogram.api.types.inline_query_result_cached_photo
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
##############################
InlineQueryResultCachedSticker
##############################
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_cached_sticker
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############################
InlineQueryResultCachedVideo
############################
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
.. automodule:: aiogram.api.types.inline_query_result_cached_video
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
############################
InlineQueryResultCachedVoice
############################
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_cached_voice
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
########################
InlineQueryResultContact
########################
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_contact
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
#########################
InlineQueryResultDocument
#########################
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_document
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
#####################
InlineQueryResultGame
#####################
Represents a Game.
Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.
.. automodule:: aiogram.api.types.inline_query_result_game
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
####################
InlineQueryResultGif
####################
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
.. automodule:: aiogram.api.types.inline_query_result_gif
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
#########################
InlineQueryResultLocation
#########################
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_location
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########################
InlineQueryResultMpeg4Gif
#########################
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
.. automodule:: aiogram.api.types.inline_query_result_mpeg4_gif
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
######################
InlineQueryResultPhoto
######################
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
.. automodule:: aiogram.api.types.inline_query_result_photo
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
######################
InlineQueryResultVenue
######################
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_venue
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
######################
InlineQueryResultVideo
######################
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
.. automodule:: aiogram.api.types.inline_query_result_video
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
######################
InlineQueryResultVoice
######################
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
.. automodule:: aiogram.api.types.inline_query_result_voice
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########################
InputContactMessageContent
##########################
Represents the content of a contact message to be sent as the result of an inline query.
.. automodule:: aiogram.api.types.input_contact_message_content
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########
InputFile
#########
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
.. automodule:: aiogram.api.types.input_file
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###########################
InputLocationMessageContent
###########################
Represents the content of a location message to be sent as the result of an inline query.
.. automodule:: aiogram.api.types.input_location_message_content
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,21 @@
##########
InputMedia
##########
This object represents the content of a media message to be sent. It should be one of
- InputMediaAnimation
- InputMediaDocument
- InputMediaAudio
- InputMediaPhoto
- InputMediaVideo
.. automodule:: aiogram.api.types.input_media
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###################
InputMediaAnimation
###################
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
.. automodule:: aiogram.api.types.input_media_animation
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############
InputMediaAudio
###############
Represents an audio file to be treated as music to be sent.
.. automodule:: aiogram.api.types.input_media_audio
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##################
InputMediaDocument
##################
Represents a general file to be sent.
.. automodule:: aiogram.api.types.input_media_document
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############
InputMediaPhoto
###############
Represents a photo to be sent.
.. automodule:: aiogram.api.types.input_media_photo
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############
InputMediaVideo
###############
Represents a video to be sent.
.. automodule:: aiogram.api.types.input_media_video
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,19 @@
###################
InputMessageContent
###################
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types:
- InputTextMessageContent
- InputLocationMessageContent
- InputVenueMessageContent
- InputContactMessageContent
.. automodule:: aiogram.api.types.input_message_content
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#######################
InputTextMessageContent
#######################
Represents the content of a text message to be sent as the result of an inline query.
.. automodule:: aiogram.api.types.input_text_message_content
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########################
InputVenueMessageContent
########################
Represents the content of a venue message to be sent as the result of an inline query.
.. automodule:: aiogram.api.types.input_venue_message_content
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#######
Invoice
#######
This object contains basic information about an invoice.
.. automodule:: aiogram.api.types.invoice
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,15 @@
##############
KeyboardButton
##############
This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
.. automodule:: aiogram.api.types.keyboard_button
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
######################
KeyboardButtonPollType
######################
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
.. automodule:: aiogram.api.types.keyboard_button_poll_type
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############
LabeledPrice
############
This object represents a portion of the price for goods or services.
.. automodule:: aiogram.api.types.labeled_price
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########
Location
########
This object represents a point on the map.
.. automodule:: aiogram.api.types.location
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,15 @@
########
LoginUrl
########
This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
Telegram apps support these buttons as of version 5.7.
Sample bot: @discussbot
.. automodule:: aiogram.api.types.login_url
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############
MaskPosition
############
This object describes the position on faces where a mask should be placed by default.
.. automodule:: aiogram.api.types.mask_position
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#######
Message
#######
This object represents a message.
.. automodule:: aiogram.api.types.message
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#############
MessageEntity
#############
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
.. automodule:: aiogram.api.types.message_entity
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########
OrderInfo
#########
This object represents information about an order.
.. automodule:: aiogram.api.types.order_info
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############
PassportData
############
Contains information about Telegram Passport data shared with the bot by the user.
.. automodule:: aiogram.api.types.passport_data
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,29 @@
####################
PassportElementError
####################
This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
- PassportElementErrorDataField
- PassportElementErrorFrontSide
- PassportElementErrorReverseSide
- PassportElementErrorSelfie
- PassportElementErrorFile
- PassportElementErrorFiles
- PassportElementErrorTranslationFile
- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified
.. automodule:: aiogram.api.types.passport_element_error
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#############################
PassportElementErrorDataField
#############################
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
.. automodule:: aiogram.api.types.passport_element_error_data_field
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
########################
PassportElementErrorFile
########################
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
.. automodule:: aiogram.api.types.passport_element_error_file
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########################
PassportElementErrorFiles
#########################
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
.. automodule:: aiogram.api.types.passport_element_error_files
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#############################
PassportElementErrorFrontSide
#############################
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
.. automodule:: aiogram.api.types.passport_element_error_front_side
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############################
PassportElementErrorReverseSide
###############################
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
.. automodule:: aiogram.api.types.passport_element_error_reverse_side
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########################
PassportElementErrorSelfie
##########################
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
.. automodule:: aiogram.api.types.passport_element_error_selfie
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###################################
PassportElementErrorTranslationFile
###################################
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
.. automodule:: aiogram.api.types.passport_element_error_translation_file
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
####################################
PassportElementErrorTranslationFiles
####################################
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
.. automodule:: aiogram.api.types.passport_element_error_translation_files
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############################
PassportElementErrorUnspecified
###############################
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
.. automodule:: aiogram.api.types.passport_element_error_unspecified
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
############
PassportFile
############
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
.. automodule:: aiogram.api.types.passport_file
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########
PhotoSize
#########
This object represents one size of a photo or a file / sticker thumbnail.
.. automodule:: aiogram.api.types.photo_size
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/poll.rst Normal file
View file

@ -0,0 +1,11 @@
####
Poll
####
This object contains information about a poll.
.. automodule:: aiogram.api.types.poll
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########
PollAnswer
##########
This object represents an answer of a user in a non-anonymous poll.
.. automodule:: aiogram.api.types.poll_answer
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########
PollOption
##########
This object contains information about one answer option in a poll.
.. automodule:: aiogram.api.types.poll_option
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
################
PreCheckoutQuery
################
This object contains information about an incoming pre-checkout query.
.. automodule:: aiogram.api.types.pre_checkout_query
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###################
ReplyKeyboardMarkup
###################
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
.. automodule:: aiogram.api.types.reply_keyboard_markup
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###################
ReplyKeyboardRemove
###################
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).
.. automodule:: aiogram.api.types.reply_keyboard_remove
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##################
ResponseParameters
##################
Contains information about why a request was unsuccessful.
.. automodule:: aiogram.api.types.response_parameters
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###############
ShippingAddress
###############
This object represents a shipping address.
.. automodule:: aiogram.api.types.shipping_address
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##############
ShippingOption
##############
This object represents one shipping option.
.. automodule:: aiogram.api.types.shipping_option
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#############
ShippingQuery
#############
This object contains information about an incoming shipping query.
.. automodule:: aiogram.api.types.shipping_query
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#######
Sticker
#######
This object represents a sticker.
.. automodule:: aiogram.api.types.sticker
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
##########
StickerSet
##########
This object represents a sticker set.
.. automodule:: aiogram.api.types.sticker_set
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#################
SuccessfulPayment
#################
This object contains basic information about a successful payment.
.. automodule:: aiogram.api.types.successful_payment
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,13 @@
######
Update
######
This object represents an incoming update.
At most one of the optional parameters can be present in any given update.
.. automodule:: aiogram.api.types.update
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/user.rst Normal file
View file

@ -0,0 +1,11 @@
####
User
####
This object represents a Telegram user or bot.
.. automodule:: aiogram.api.types.user
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#################
UserProfilePhotos
#################
This object represent a user's profile pictures.
.. automodule:: aiogram.api.types.user_profile_photos
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/venue.rst Normal file
View file

@ -0,0 +1,11 @@
#####
Venue
#####
This object represents a venue.
.. automodule:: aiogram.api.types.venue
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/video.rst Normal file
View file

@ -0,0 +1,11 @@
#####
Video
#####
This object represents a video file.
.. automodule:: aiogram.api.types.video
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
#########
VideoNote
#########
This object represents a video message (available in Telegram apps as of v.4.0).
.. automodule:: aiogram.api.types.video_note
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

11
docs2/api/types/voice.rst Normal file
View file

@ -0,0 +1,11 @@
#####
Voice
#####
This object represents a voice note.
.. automodule:: aiogram.api.types.voice
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True

View file

@ -0,0 +1,11 @@
###########
WebhookInfo
###########
Contains information about the current status of a webhook.
.. automodule:: aiogram.api.types.webhook_info
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True