python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-11 18:01:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove MkDocs

Browse source
This commit is contained in:
Alex Root Junior 2021-05-13 00:13:09 +03:00
parent 7dd80d281f
commit e1cd7268a1
442 changed files with 4 additions and 9429 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/api/types/animation.md
View file

@ -1,34 +0,0 @@
# Animation
## Description
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
## Attributes
| Name | Type | Description |
| - | - | - |
| `file_id` | `#!python str` | Identifier for this file, which can be used to download or reuse the file |
| `file_unique_id` | `#!python str` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
| `width` | `#!python int` | Video width as defined by sender |
| `height` | `#!python int` | Video height as defined by sender |
| `duration` | `#!python int` | Duration of the video in seconds as defined by sender |
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Animation thumbnail as defined by sender |
| `file_name` | `#!python Optional[str]` | Optional. Original animation filename as defined by sender |
| `mime_type` | `#!python Optional[str]` | Optional. MIME type of the file as defined by sender |
| `file_size` | `#!python Optional[int]` | Optional. File size |
## Location
- `from aiogram.types import Animation`
- `from aiogram.api.types import Animation`
- `from aiogram.api.types.animation import Animation`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#animation)
- [aiogram.types.PhotoSize](../types/photo_size.md)
- [How to download file?](../download_file.md)

9
docs/api/types/animation.rst Normal file
View file

@ -0,0 +1,9 @@
#########
Animation
#########
.. automodule:: aiogram.types.animation
:members:
:member-order: bysource
:undoc-members: True

33
docs/api/types/audio.md
View file

@ -1,33 +0,0 @@
# Audio
## Description
This object represents an audio file to be treated as music by the Telegram clients.
## Attributes
| Name | Type | Description |
| - | - | - |
| `file_id` | `#!python str` | Identifier for this file, which can be used to download or reuse the file |
| `file_unique_id` | `#!python str` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
| `duration` | `#!python int` | Duration of the audio in seconds as defined by sender |
| `performer` | `#!python Optional[str]` | Optional. Performer of the audio as defined by sender or by audio tags |
| `title` | `#!python Optional[str]` | Optional. Title of the audio as defined by sender or by audio tags |
| `mime_type` | `#!python Optional[str]` | Optional. MIME type of the file as defined by sender |
| `file_size` | `#!python Optional[int]` | Optional. File size |
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Thumbnail of the album cover to which the music file belongs |
## Location
- `from aiogram.types import Audio`
- `from aiogram.api.types import Audio`
- `from aiogram.api.types.audio import Audio`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#audio)
- [aiogram.types.PhotoSize](../types/photo_size.md)
- [How to download file?](../download_file.md)

9
docs/api/types/audio.rst Normal file
View file

@ -0,0 +1,9 @@
#####
Audio
#####
.. automodule:: aiogram.types.audio
:members:
:member-order: bysource
:undoc-members: True

25
docs/api/types/bot_command.md
View file

@ -1,25 +0,0 @@
# BotCommand
## Description
This object represents a bot command.
## Attributes
| Name | Type | Description |
| - | - | - |
| `command` | `#!python str` | Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and underscores. |
| `description` | `#!python str` | Description of the command, 3-256 characters. |
## Location
- `from aiogram.types import BotCommand`
- `from aiogram.api.types import BotCommand`
- `from aiogram.api.types.bot_command import BotCommand`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#botcommand)

9
docs/api/types/bot_command.rst Normal file
View file

@ -0,0 +1,9 @@
##########
BotCommand
##########
.. automodule:: aiogram.types.bot_command
:members:
:member-order: bysource
:undoc-members: True

18
docs/api/types/callback_game.md
View file

@ -1,18 +0,0 @@
# CallbackGame
## Description
A placeholder, currently holds no information. Use BotFather to set up your game.
## Location
- `from aiogram.types import CallbackGame`
- `from aiogram.api.types import CallbackGame`
- `from aiogram.api.types.callback_game import CallbackGame`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#callbackgame)

9
docs/api/types/callback_game.rst Normal file
View file

@ -0,0 +1,9 @@
############
CallbackGame
############
.. automodule:: aiogram.types.callback_game
:members:
:member-order: bysource
:undoc-members: True

47
docs/api/types/callback_query.md
View file

@ -1,47 +0,0 @@
# CallbackQuery
## Description
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).
## Attributes
| Name | Type | Description |
| - | - | - |
| `id` | `#!python str` | Unique identifier for this query |
| `from_user` | `#!python User` | Sender |
| `chat_instance` | `#!python str` | Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. |
| `message` | `#!python Optional[Message]` | Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old |
| `inline_message_id` | `#!python Optional[str]` | Optional. Identifier of the message sent via the bot in inline mode, that originated the query. |
| `data` | `#!python Optional[str]` | Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field. |
| `game_short_name` | `#!python Optional[str]` | Optional. Short name of a Game to be returned, serves as the unique identifier for the game |
## Location
- `from aiogram.types import CallbackQuery`
- `from aiogram.api.types import CallbackQuery`
- `from aiogram.api.types.callback_query import CallbackQuery`
## Aliases
Aliases is always returns related API method (Awaitable) and can be used directly or as answer's into webhook.
### Answer
This method has the same specification with the API but without `callback_query_id` argument.
| Answer method | Alias for | Description |
| - | - | - |
| `answer` | [Bot.answer_callback_query](../methods/answer_callback_query.md) | Answer to callback query |
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#callbackquery)
- [aiogram.types.Message](../types/message.md)
- [aiogram.types.User](../types/user.md)
- [aiogram.methods.AnswerCallbackQuery](../methods/answer_callback_query.md)

9
docs/api/types/callback_query.rst Normal file
View file

@ -0,0 +1,9 @@
#############
CallbackQuery
#############
.. automodule:: aiogram.types.callback_query
:members:
:member-order: bysource
:undoc-members: True

40
docs/api/types/chat.md
View file

@ -1,40 +0,0 @@
# Chat
## Description
This object represents a chat.
## Attributes
| Name | Type | Description |
| - | - | - |
| `id` | `#!python int` | Unique identifier for this chat. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. |
| `type` | `#!python str` | Type of chat, can be either 'private', 'group', 'supergroup' or 'channel' |
| `title` | `#!python Optional[str]` | Optional. Title, for supergroups, channels and group chats |
| `username` | `#!python Optional[str]` | Optional. Username, for private chats, supergroups and channels if available |
| `first_name` | `#!python Optional[str]` | Optional. First name of the other party in a private chat |
| `last_name` | `#!python Optional[str]` | Optional. Last name of the other party in a private chat |
| `photo` | `#!python Optional[ChatPhoto]` | Optional. Chat photo. Returned only in getChat. |
| `description` | `#!python Optional[str]` | Optional. Description, for groups, supergroups and channel chats. Returned only in getChat. |
| `invite_link` | `#!python Optional[str]` | Optional. Chat invite link, for groups, supergroups and channel chats. Each administrator in a chat generates their own invite links, so the bot must first generate the link using exportChatInviteLink. Returned only in getChat. |
| `pinned_message` | `#!python Optional[Message]` | Optional. Pinned message, for groups, supergroups and channels. Returned only in getChat. |
| `permissions` | `#!python Optional[ChatPermissions]` | Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat. |
| `slow_mode_delay` | `#!python Optional[int]` | Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in getChat. |
| `sticker_set_name` | `#!python Optional[str]` | Optional. For supergroups, name of group sticker set. Returned only in getChat. |
| `can_set_sticker_set` | `#!python Optional[bool]` | Optional. True, if the bot can change the group sticker set. Returned only in getChat. |
## Location
- `from aiogram.types import Chat`
- `from aiogram.api.types import Chat`
- `from aiogram.api.types.chat import Chat`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#chat)
- [aiogram.types.ChatPermissions](../types/chat_permissions.md)
- [aiogram.types.ChatPhoto](../types/chat_photo.md)
- [aiogram.types.Message](../types/message.md)

9
docs/api/types/chat.rst Normal file
View file

@ -0,0 +1,9 @@
####
Chat
####
.. automodule:: aiogram.types.chat
:members:
:member-order: bysource
:undoc-members: True

9
docs/api/types/chat_invite_link.rst Normal file
View file

@ -0,0 +1,9 @@
##############
ChatInviteLink
##############
.. automodule:: aiogram.types.chat_invite_link
:members:
:member-order: bysource
:undoc-members: True

9
docs/api/types/chat_location.rst Normal file
View file

@ -0,0 +1,9 @@
############
ChatLocation
############
.. automodule:: aiogram.types.chat_location
:members:
:member-order: bysource
:undoc-members: True

64
docs/api/types/chat_member.md
View file

@ -1,64 +0,0 @@
# ChatMember
## Description
This object contains information about one member of a chat.
## Attributes
| Name | Type | Description |
| - | - | - |
| `user` | `#!python User` | Information about the user |
| `status` | `#!python str` | The member's status in the chat. Can be 'creator', 'administrator', 'member', 'restricted', 'left' or 'kicked' |
| `custom_title` | `#!python Optional[str]` | Optional. Owner and administrators only. Custom title for this user |
| `until_date` | `#!python Optional[Union[datetime.datetime, datetime.timedelta, int]]` | Optional. Restricted and kicked only. Date when restrictions will be lifted for this user; unix time |
| `can_be_edited` | `#!python Optional[bool]` | Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user |
| `can_post_messages` | `#!python Optional[bool]` | Optional. Administrators only. True, if the administrator can post in the channel; channels only |
| `can_edit_messages` | `#!python Optional[bool]` | Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages; channels only |
| `can_delete_messages` | `#!python Optional[bool]` | Optional. Administrators only. True, if the administrator can delete messages of other users |
| `can_restrict_members` | `#!python Optional[bool]` | Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members |
| `can_promote_members` | `#!python Optional[bool]` | Optional. Administrators only. True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) |
| `can_change_info` | `#!python Optional[bool]` | Optional. Administrators and restricted only. True, if the user is allowed to change the chat title, photo and other settings |
| `can_invite_users` | `#!python Optional[bool]` | Optional. Administrators and restricted only. True, if the user is allowed to invite new users to the chat |
| `can_pin_messages` | `#!python Optional[bool]` | Optional. Administrators and restricted only. True, if the user is allowed to pin messages; groups and supergroups only |
| `is_member` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is a member of the chat at the moment of the request |
| `can_send_messages` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is allowed to send text messages, contacts, locations and venues |
| `can_send_media_messages` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes |
| `can_send_polls` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is allowed to send polls |
| `can_send_other_messages` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is allowed to send animations, games, stickers and use inline bots |
| `can_add_web_page_previews` | `#!python Optional[bool]` | Optional. Restricted only. True, if the user is allowed to add web page previews to their messages |
## Extensions
| Name | Type | Description |
| - | - | - |
| `is_chat_admin` | `#!python bool` | True if the user is administrator or creator of the chat |
| `is_chat_member` | `#!python bool` | True if the user is member of the chat |
## ChatMemberStatus helper
This object helps to describe user's status.
#### Attributes:
- CREATOR
- ADMINISTRATOR
- MEMBER
- RESTRICTED
- LEFT
- KICKED
## Location
- `from aiogram.types import ChatMember`
- `from aiogram.api.types import ChatMember`
- `from aiogram.api.types.chat_member import ChatMember`
- `from aiogram.api.types.chat_member import ChatMemberStatus`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#chatmember)
- [aiogram.types.User](../types/user.md)

9
docs/api/types/chat_member.rst Normal file
View file

@ -0,0 +1,9 @@
##########
ChatMember
##########
.. automodule:: aiogram.types.chat_member
:members:
:member-order: bysource
:undoc-members: True

9
docs/api/types/chat_member_updated.rst Normal file
View file

@ -0,0 +1,9 @@
#################
ChatMemberUpdated
#################
.. automodule:: aiogram.types.chat_member_updated
:members:
:member-order: bysource
:undoc-members: True

31
docs/api/types/chat_permissions.md
View file

@ -1,31 +0,0 @@
# ChatPermissions
## Description
Describes actions that a non-administrator user is allowed to take in a chat.
## Attributes
| Name | Type | Description |
| - | - | - |
| `can_send_messages` | `#!python Optional[bool]` | Optional. True, if the user is allowed to send text messages, contacts, locations and venues |
| `can_send_media_messages` | `#!python Optional[bool]` | Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages |
| `can_send_polls` | `#!python Optional[bool]` | Optional. True, if the user is allowed to send polls, implies can_send_messages |
| `can_send_other_messages` | `#!python Optional[bool]` | Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages |
| `can_add_web_page_previews` | `#!python Optional[bool]` | Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages |
| `can_change_info` | `#!python Optional[bool]` | Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups |
| `can_invite_users` | `#!python Optional[bool]` | Optional. True, if the user is allowed to invite new users to the chat |
| `can_pin_messages` | `#!python Optional[bool]` | Optional. True, if the user is allowed to pin messages. Ignored in public supergroups |
## Location
- `from aiogram.types import ChatPermissions`
- `from aiogram.api.types import ChatPermissions`
- `from aiogram.api.types.chat_permissions import ChatPermissions`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#chatpermissions)

9
docs/api/types/chat_permissions.rst Normal file
View file

@ -0,0 +1,9 @@
###############
ChatPermissions
###############
.. automodule:: aiogram.types.chat_permissions
:members:
:member-order: bysource
:undoc-members: True

27
docs/api/types/chat_photo.md
View file

@ -1,27 +0,0 @@
# ChatPhoto
## Description
This object represents a chat photo.
## Attributes
| Name | Type | Description |
| - | - | - |
| `small_file_id` | `#!python str` | File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. |
| `small_file_unique_id` | `#!python str` | Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
| `big_file_id` | `#!python str` | File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. |
| `big_file_unique_id` | `#!python str` | Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
## Location
- `from aiogram.types import ChatPhoto`
- `from aiogram.api.types import ChatPhoto`
- `from aiogram.api.types.chat_photo import ChatPhoto`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#chatphoto)

9
docs/api/types/chat_photo.rst Normal file
View file

@ -0,0 +1,9 @@
#########
ChatPhoto
#########
.. automodule:: aiogram.types.chat_photo
:members:
:member-order: bysource
:undoc-members: True

32
docs/api/types/chosen_inline_result.md
View file

@ -1,32 +0,0 @@
# ChosenInlineResult
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `result_id` | `#!python str` | The unique identifier for the result that was chosen |
| `from_user` | `#!python User` | The user that chose the result |
| `query` | `#!python str` | The query that was used to obtain the result |
| `location` | `#!python Optional[Location]` | Optional. Sender location, only for bots that require user location |
| `inline_message_id` | `#!python Optional[str]` | Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message. |
## Location
- `from aiogram.types import ChosenInlineResult`
- `from aiogram.api.types import ChosenInlineResult`
- `from aiogram.api.types.chosen_inline_result import ChosenInlineResult`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#choseninlineresult)
- [aiogram.types.Location](../types/location.md)
- [aiogram.types.User](../types/user.md)

9
docs/api/types/chosen_inline_result.rst Normal file
View file

@ -0,0 +1,9 @@
##################
ChosenInlineResult
##################
.. automodule:: aiogram.types.chosen_inline_result
:members:
:member-order: bysource
:undoc-members: True

28
docs/api/types/contact.md
View file

@ -1,28 +0,0 @@
# Contact
## Description
This object represents a phone contact.
## Attributes
| Name | Type | Description |
| - | - | - |
| `phone_number` | `#!python str` | Contact's phone number |
| `first_name` | `#!python str` | Contact's first name |
| `last_name` | `#!python Optional[str]` | Optional. Contact's last name |
| `user_id` | `#!python Optional[int]` | Optional. Contact's user identifier in Telegram |
| `vcard` | `#!python Optional[str]` | Optional. Additional data about the contact in the form of a vCard |
## Location
- `from aiogram.types import Contact`
- `from aiogram.api.types import Contact`
- `from aiogram.api.types.contact import Contact`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#contact)

9
docs/api/types/contact.rst Normal file
View file

@ -0,0 +1,9 @@
#######
Contact
#######
.. automodule:: aiogram.types.contact
:members:
:member-order: bysource
:undoc-members: True

25
docs/api/types/dice.md
View file

@ -1,25 +0,0 @@
# Dice
## Description
This object represents a dice with a random value from 1 to 6 for currently supported base emoji. (Yes, we're aware of the 'proper' singular of die. But it's awkward, and we decided to help it change. One dice at a time!)
## Attributes
| Name | Type | Description |
| - | - | - |
| `emoji` | `#!python str` | Emoji on which the dice throw animation is based |
| `value` | `#!python int` | Value of the dice, 1-6 for currently supported base emoji |
## Location
- `from aiogram.types import Dice`
- `from aiogram.api.types import Dice`
- `from aiogram.api.types.dice import Dice`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#dice)

9
docs/api/types/dice.rst Normal file
View file

@ -0,0 +1,9 @@
####
Dice
####
.. automodule:: aiogram.types.dice
:members:
:member-order: bysource
:undoc-members: True

31
docs/api/types/document.md
View file

@ -1,31 +0,0 @@
# Document
## Description
This object represents a general file (as opposed to photos, voice messages and audio files).
## Attributes
| Name | Type | Description |
| - | - | - |
| `file_id` | `#!python str` | Identifier for this file, which can be used to download or reuse the file |
| `file_unique_id` | `#!python str` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Document thumbnail as defined by sender |
| `file_name` | `#!python Optional[str]` | Optional. Original filename as defined by sender |
| `mime_type` | `#!python Optional[str]` | Optional. MIME type of the file as defined by sender |
| `file_size` | `#!python Optional[int]` | Optional. File size |
## Location
- `from aiogram.types import Document`
- `from aiogram.api.types import Document`
- `from aiogram.api.types.document import Document`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#document)
- [aiogram.types.PhotoSize](../types/photo_size.md)
- [How to download file?](../download_file.md)

9
docs/api/types/document.rst Normal file
View file

@ -0,0 +1,9 @@
########
Document
########
.. automodule:: aiogram.types.document
:members:
:member-order: bysource
:undoc-members: True

26
docs/api/types/encrypted_credentials.md
View file

@ -1,26 +0,0 @@
# EncryptedCredentials
## Description
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
## Attributes
| Name | Type | Description |
| - | - | - |
| `data` | `#!python str` | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication |
| `hash` | `#!python str` | Base64-encoded data hash for data authentication |
| `secret` | `#!python str` | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption |
## Location
- `from aiogram.types import EncryptedCredentials`
- `from aiogram.api.types import EncryptedCredentials`
- `from aiogram.api.types.encrypted_credentials import EncryptedCredentials`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#encryptedcredentials)

9
docs/api/types/encrypted_credentials.rst Normal file
View file

@ -0,0 +1,9 @@
####################
EncryptedCredentials
####################
.. automodule:: aiogram.types.encrypted_credentials
:members:
:member-order: bysource
:undoc-members: True

34
docs/api/types/encrypted_passport_element.md
View file

@ -1,34 +0,0 @@
# EncryptedPassportElement
## Description
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Element type. One of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration', 'phone_number', 'email'. |
| `hash` | `#!python str` | Base64-encoded element hash for using in PassportElementErrorUnspecified |
| `data` | `#!python Optional[str]` | Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport' and 'address' types. Can be decrypted and verified using the accompanying EncryptedCredentials. |
| `phone_number` | `#!python Optional[str]` | Optional. User's verified phone number, available only for 'phone_number' type |
| `email` | `#!python Optional[str]` | Optional. User's verified email address, available only for 'email' type |
| `files` | `#!python Optional[List[PassportFile]]` | Optional. Array of encrypted files with documents provided by the user, available for 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials. |
| `front_side` | `#!python Optional[PassportFile]` | Optional. Encrypted file with the front side of the document, provided by the user. Available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| `reverse_side` | `#!python Optional[PassportFile]` | Optional. Encrypted file with the reverse side of the document, provided by the user. Available for 'driver_license' and 'identity_card'. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| `selfie` | `#!python Optional[PassportFile]` | Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials. |
| `translation` | `#!python Optional[List[PassportFile]]` | Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials. |
## Location
- `from aiogram.types import EncryptedPassportElement`
- `from aiogram.api.types import EncryptedPassportElement`
- `from aiogram.api.types.encrypted_passport_element import EncryptedPassportElement`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#encryptedpassportelement)
- [aiogram.types.PassportFile](../types/passport_file.md)

9
docs/api/types/encrypted_passport_element.rst Normal file
View file

@ -0,0 +1,9 @@
########################
EncryptedPassportElement
########################
.. automodule:: aiogram.types.encrypted_passport_element
:members:
:member-order: bysource
:undoc-members: True

30
docs/api/types/file.md
View file

@ -1,30 +0,0 @@
# File
## Description
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
## Attributes
| Name | Type | Description |
| - | - | - |
| `file_id` | `#!python str` | Identifier for this file, which can be used to download or reuse the file |
| `file_unique_id` | `#!python str` | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. |
| `file_size` | `#!python Optional[int]` | Optional. File size, if known |
| `file_path` | `#!python Optional[str]` | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. |
## Location
- `from aiogram.types import File`
- `from aiogram.api.types import File`
- `from aiogram.api.types.file import File`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#file)
- [How to download file?](../download_file.md)

9
docs/api/types/file.rst Normal file
View file

@ -0,0 +1,9 @@
####
File
####
.. automodule:: aiogram.types.file
:members:
:member-order: bysource
:undoc-members: True

35
docs/api/types/force_reply.md
View file

@ -1,35 +0,0 @@
# ForceReply
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `force_reply` | `#!python bool` | Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' |
| `selective` | `#!python Optional[bool]` | Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. |
## Location
- `from aiogram.types import ForceReply`
- `from aiogram.api.types import ForceReply`
- `from aiogram.api.types.force_reply import ForceReply`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#forcereply)

9
docs/api/types/force_reply.rst Normal file
View file

@ -0,0 +1,9 @@
##########
ForceReply
##########
.. automodule:: aiogram.types.force_reply
:members:
:member-order: bysource
:undoc-members: True

32
docs/api/types/game.md
View file

@ -1,32 +0,0 @@
# Game
## Description
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
## Attributes
| Name | Type | Description |
| - | - | - |
| `title` | `#!python str` | Title of the game |
| `description` | `#!python str` | Description of the game |
| `photo` | `#!python List[PhotoSize]` | Photo that will be displayed in the game message in chats. |
| `text` | `#!python Optional[str]` | Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. |
| `text_entities` | `#!python Optional[List[MessageEntity]]` | Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. |
| `animation` | `#!python Optional[Animation]` | Optional. Animation that will be displayed in the game message in chats. Upload via BotFather |
## Location
- `from aiogram.types import Game`
- `from aiogram.api.types import Game`
- `from aiogram.api.types.game import Game`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#game)
- [aiogram.types.Animation](../types/animation.md)
- [aiogram.types.MessageEntity](../types/message_entity.md)
- [aiogram.types.PhotoSize](../types/photo_size.md)

9
docs/api/types/game.rst Normal file
View file

@ -0,0 +1,9 @@
####
Game
####
.. automodule:: aiogram.types.game
:members:
:member-order: bysource
:undoc-members: True

31
docs/api/types/game_high_score.md
View file

@ -1,31 +0,0 @@
# GameHighScore
## Description
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
## Attributes
| Name | Type | Description |
| - | - | - |
| `position` | `#!python int` | Position in high score table for the game |
| `user` | `#!python User` | User |
| `score` | `#!python int` | Score |
## Location
- `from aiogram.types import GameHighScore`
- `from aiogram.api.types import GameHighScore`
- `from aiogram.api.types.game_high_score import GameHighScore`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#gamehighscore)
- [aiogram.types.User](../types/user.md)

9
docs/api/types/game_high_score.rst Normal file
View file

@ -0,0 +1,9 @@
#############
GameHighScore
#############
.. automodule:: aiogram.types.game_high_score
:members:
:member-order: bysource
:undoc-members: True

110
docs/api/types/index.md
View file

@ -1,110 +0,0 @@
# Types
Here is list of all available API types:
- Getting updates
- [Update](update.md)
- [WebhookInfo](webhook_info.md)
- Available types
- [User](user.md)
- [Chat](chat.md)
- [Message](message.md)
- [MessageEntity](message_entity.md)
- [PhotoSize](photo_size.md)
- [Audio](audio.md)
- [Document](document.md)
- [Video](video.md)
- [Animation](animation.md)
- [Voice](voice.md)
- [VideoNote](video_note.md)
- [Contact](contact.md)
- [Location](location.md)
- [Venue](venue.md)
- [PollOption](poll_option.md)
- [PollAnswer](poll_answer.md)
- [Poll](poll.md)
- [Dice](dice.md)
- [UserProfilePhotos](user_profile_photos.md)
- [File](file.md)
- [ReplyKeyboardMarkup](reply_keyboard_markup.md)
- [KeyboardButton](keyboard_button.md)
- [KeyboardButtonPollType](keyboard_button_poll_type.md)
- [ReplyKeyboardRemove](reply_keyboard_remove.md)
- [InlineKeyboardMarkup](inline_keyboard_markup.md)
- [InlineKeyboardButton](inline_keyboard_button.md)
- [LoginUrl](login_url.md)
- [CallbackQuery](callback_query.md)
- [ForceReply](force_reply.md)
- [ChatPhoto](chat_photo.md)
- [ChatMember](chat_member.md)
- [ChatPermissions](chat_permissions.md)
- [BotCommand](bot_command.md)
- [ResponseParameters](response_parameters.md)
- [InputMedia](input_media.md)
- [InputMediaPhoto](input_media_photo.md)
- [InputMediaVideo](input_media_video.md)
- [InputMediaAnimation](input_media_animation.md)
- [InputMediaAudio](input_media_audio.md)
- [InputMediaDocument](input_media_document.md)
- [InputFile](input_file.md)
- Stickers
- [Sticker](sticker.md)
- [StickerSet](sticker_set.md)
- [MaskPosition](mask_position.md)
- Inline mode
- [InlineQuery](inline_query.md)
- [InlineQueryResult](inline_query_result.md)
- [InlineQueryResultArticle](inline_query_result_article.md)
- [InlineQueryResultPhoto](inline_query_result_photo.md)
- [InlineQueryResultGif](inline_query_result_gif.md)
- [InlineQueryResultMpeg4Gif](inline_query_result_mpeg4_gif.md)
- [InlineQueryResultVideo](inline_query_result_video.md)
- [InlineQueryResultAudio](inline_query_result_audio.md)
- [InlineQueryResultVoice](inline_query_result_voice.md)
- [InlineQueryResultDocument](inline_query_result_document.md)
- [InlineQueryResultLocation](inline_query_result_location.md)
- [InlineQueryResultVenue](inline_query_result_venue.md)
- [InlineQueryResultContact](inline_query_result_contact.md)
- [InlineQueryResultGame](inline_query_result_game.md)
- [InlineQueryResultCachedPhoto](inline_query_result_cached_photo.md)
- [InlineQueryResultCachedGif](inline_query_result_cached_gif.md)
- [InlineQueryResultCachedMpeg4Gif](inline_query_result_cached_mpeg4_gif.md)
- [InlineQueryResultCachedSticker](inline_query_result_cached_sticker.md)
- [InlineQueryResultCachedDocument](inline_query_result_cached_document.md)
- [InlineQueryResultCachedVideo](inline_query_result_cached_video.md)
- [InlineQueryResultCachedVoice](inline_query_result_cached_voice.md)
- [InlineQueryResultCachedAudio](inline_query_result_cached_audio.md)
- [InputMessageContent](input_message_content.md)
- [InputTextMessageContent](input_text_message_content.md)
- [InputLocationMessageContent](input_location_message_content.md)
- [InputVenueMessageContent](input_venue_message_content.md)
- [InputContactMessageContent](input_contact_message_content.md)
- [ChosenInlineResult](chosen_inline_result.md)
- Payments
- [LabeledPrice](labeled_price.md)
- [Invoice](invoice.md)
- [ShippingAddress](shipping_address.md)
- [OrderInfo](order_info.md)
- [ShippingOption](shipping_option.md)
- [SuccessfulPayment](successful_payment.md)
- [ShippingQuery](shipping_query.md)
- [PreCheckoutQuery](pre_checkout_query.md)
- Telegram Passport
- [PassportData](passport_data.md)
- [PassportFile](passport_file.md)
- [EncryptedPassportElement](encrypted_passport_element.md)
- [EncryptedCredentials](encrypted_credentials.md)
- [PassportElementError](passport_element_error.md)
- [PassportElementErrorDataField](passport_element_error_data_field.md)
- [PassportElementErrorFrontSide](passport_element_error_front_side.md)
- [PassportElementErrorReverseSide](passport_element_error_reverse_side.md)
- [PassportElementErrorSelfie](passport_element_error_selfie.md)
- [PassportElementErrorFile](passport_element_error_file.md)
- [PassportElementErrorFiles](passport_element_error_files.md)
- [PassportElementErrorTranslationFile](passport_element_error_translation_file.md)
- [PassportElementErrorTranslationFiles](passport_element_error_translation_files.md)
- [PassportElementErrorUnspecified](passport_element_error_unspecified.md)
- Games
- [Game](game.md)
- [CallbackGame](callback_game.md)
- [GameHighScore](game_high_score.md)

168
docs/api/types/index.rst Normal file
View file

@ -0,0 +1,168 @@
#####
Types
#####
Here is list of all available API types:
Getting updates
===============
.. toctree::
:maxdepth: 1
update
webhook_info
Available types
===============
.. toctree::
:maxdepth: 1
user
chat
message
message_id
message_entity
photo_size
animation
audio
document
video
video_note
voice
contact
dice
poll_option
poll_answer
poll
location
venue
proximity_alert_triggered
message_auto_delete_timer_changed
voice_chat_scheduled
voice_chat_started
voice_chat_ended
voice_chat_participants_invited
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_invite_link
chat_member
chat_member_updated
chat_permissions
chat_location
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
input_invoice_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

33
docs/api/types/inline_keyboard_button.md
View file

@ -1,33 +0,0 @@
# InlineKeyboardButton
## Description
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
## Attributes
| Name | Type | Description |
| - | - | - |
| `text` | `#!python str` | Label text on the button |
| `url` | `#!python Optional[str]` | Optional. HTTP or tg:// url to be opened when button is pressed |
| `login_url` | `#!python Optional[LoginUrl]` | Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. |
| `callback_data` | `#!python Optional[str]` | Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes |
| `switch_inline_query` | `#!python Optional[str]` | Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted. |
| `switch_inline_query_current_chat` | `#!python Optional[str]` | Optional. If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat’s input field. Can be empty, in which case only the bot's username will be inserted. |
| `callback_game` | `#!python Optional[CallbackGame]` | Optional. Description of the game that will be launched when the user presses the button. |
| `pay` | `#!python Optional[bool]` | Optional. Specify True, to send a Pay button. |
## Location
- `from aiogram.types import InlineKeyboardButton`
- `from aiogram.api.types import InlineKeyboardButton`
- `from aiogram.api.types.inline_keyboard_button import InlineKeyboardButton`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinekeyboardbutton)
- [aiogram.types.CallbackGame](../types/callback_game.md)
- [aiogram.types.LoginUrl](../types/login_url.md)

9
docs/api/types/inline_keyboard_button.rst Normal file
View file

@ -0,0 +1,9 @@
####################
InlineKeyboardButton
####################
.. automodule:: aiogram.types.inline_keyboard_button
:members:
:member-order: bysource
:undoc-members: True

27
docs/api/types/inline_keyboard_markup.md
View file

@ -1,27 +0,0 @@
# InlineKeyboardMarkup
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `inline_keyboard` | `#!python List[List[InlineKeyboardButton]]` | Array of button rows, each represented by an Array of InlineKeyboardButton objects |
## Location
- `from aiogram.types import InlineKeyboardMarkup`
- `from aiogram.api.types import InlineKeyboardMarkup`
- `from aiogram.api.types.inline_keyboard_markup import InlineKeyboardMarkup`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinekeyboardmarkup)
- [aiogram.types.InlineKeyboardButton](../types/inline_keyboard_button.md)

9
docs/api/types/inline_keyboard_markup.rst Normal file
View file

@ -0,0 +1,9 @@
####################
InlineKeyboardMarkup
####################
.. automodule:: aiogram.types.inline_keyboard_markup
:members:
:member-order: bysource
:undoc-members: True

45
docs/api/types/inline_query.md
View file

@ -1,45 +0,0 @@
# InlineQuery
## Description
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
## Attributes
| Name | Type | Description |
| - | - | - |
| `id` | `#!python str` | Unique identifier for this query |
| `from_user` | `#!python User` | Sender |
| `query` | `#!python str` | Text of the query (up to 256 characters) |
| `offset` | `#!python str` | Offset of the results to be returned, can be controlled by the bot |
| `location` | `#!python Optional[Location]` | Optional. Sender location, only for bots that request user location |
## Location
- `from aiogram.types import InlineQuery`
- `from aiogram.api.types import InlineQuery`
- `from aiogram.api.types.inline_query import InlineQuery`
## Aliases
Aliases is always returns related API method (Awaitable) and can be used directly or as answer's into webhook.
### Answer
This method has the same specification with the API but without `inline_query_id` argument.
| Answer method | Alias for | Description |
| - | - | - |
| `answer` | [Bot.answer_inline_query](../methods/answer_inline_query.md) | Answer to inline query |
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequery)
- [aiogram.types.Location](../types/location.md)
- [aiogram.types.User](../types/user.md)
- [aiogram.methods.AnswerInlineQuery](../methods/answer_inline_query.md)

9
docs/api/types/inline_query.rst Normal file
View file

@ -0,0 +1,9 @@
###########
InlineQuery
###########
.. automodule:: aiogram.types.inline_query
:members:
:member-order: bysource
:undoc-members: True

58
docs/api/types/inline_query_result.md
View file

@ -1,58 +0,0 @@
# InlineQueryResult
## Description
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
## Location
- `from aiogram.types import InlineQueryResult`
- `from aiogram.api.types import InlineQueryResult`
- `from aiogram.api.types.inline_query_result import InlineQueryResult`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresult)

9
docs/api/types/inline_query_result.rst Normal file
View file

@ -0,0 +1,9 @@
#################
InlineQueryResult
#################
.. automodule:: aiogram.types.inline_query_result
:members:
:member-order: bysource
:undoc-members: True

36
docs/api/types/inline_query_result_article.md
View file

@ -1,36 +0,0 @@
# InlineQueryResultArticle
## Description
Represents a link to an article or web page.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be article |
| `id` | `#!python str` | Unique identifier for this result, 1-64 Bytes |
| `title` | `#!python str` | Title of the result |
| `input_message_content` | `#!python InputMessageContent` | Content of the message to be sent |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `url` | `#!python Optional[str]` | Optional. URL of the result |
| `hide_url` | `#!python Optional[bool]` | Optional. Pass True, if you don't want the URL to be shown in the message |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `thumb_url` | `#!python Optional[str]` | Optional. Url of the thumbnail for the result |
| `thumb_width` | `#!python Optional[int]` | Optional. Thumbnail width |
| `thumb_height` | `#!python Optional[int]` | Optional. Thumbnail height |
## Location
- `from aiogram.types import InlineQueryResultArticle`
- `from aiogram.api.types import InlineQueryResultArticle`
- `from aiogram.api.types.inline_query_result_article import InlineQueryResultArticle`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultarticle)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_article.rst Normal file
View file

@ -0,0 +1,9 @@
########################
InlineQueryResultArticle
########################
.. automodule:: aiogram.types.inline_query_result_article
:members:
:member-order: bysource
:undoc-members: True

37
docs/api/types/inline_query_result_audio.md
View file

@ -1,37 +0,0 @@
# InlineQueryResultAudio
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be audio |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `audio_url` | `#!python str` | A valid URL for the audio file |
| `title` | `#!python str` | Title |
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. |
| `performer` | `#!python Optional[str]` | Optional. Performer |
| `audio_duration` | `#!python Optional[int]` | Optional. Audio duration in seconds |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the audio |
## Location
- `from aiogram.types import InlineQueryResultAudio`
- `from aiogram.api.types import InlineQueryResultAudio`
- `from aiogram.api.types.inline_query_result_audio import InlineQueryResultAudio`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultaudio)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_audio.rst Normal file
View file

@ -0,0 +1,9 @@
######################
InlineQueryResultAudio
######################
.. automodule:: aiogram.types.inline_query_result_audio
:members:
:member-order: bysource
:undoc-members: True

34
docs/api/types/inline_query_result_cached_audio.md
View file

@ -1,34 +0,0 @@
# InlineQueryResultCachedAudio
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be audio |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `audio_file_id` | `#!python str` | A valid file identifier for the audio file |
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the audio |
## Location
- `from aiogram.types import InlineQueryResultCachedAudio`
- `from aiogram.api.types import InlineQueryResultCachedAudio`
- `from aiogram.api.types.inline_query_result_cached_audio import InlineQueryResultCachedAudio`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedaudio)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_audio.rst Normal file
View file

@ -0,0 +1,9 @@
############################
InlineQueryResultCachedAudio
############################
.. automodule:: aiogram.types.inline_query_result_cached_audio
:members:
:member-order: bysource
:undoc-members: True

36
docs/api/types/inline_query_result_cached_document.md
View file

@ -1,36 +0,0 @@
# InlineQueryResultCachedDocument
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be document |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `title` | `#!python str` | Title for the result |
| `document_file_id` | `#!python str` | A valid file identifier for the file |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the document caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the file |
## Location
- `from aiogram.types import InlineQueryResultCachedDocument`
- `from aiogram.api.types import InlineQueryResultCachedDocument`
- `from aiogram.api.types.inline_query_result_cached_document import InlineQueryResultCachedDocument`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcacheddocument)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_document.rst Normal file
View file

@ -0,0 +1,9 @@
###############################
InlineQueryResultCachedDocument
###############################
.. automodule:: aiogram.types.inline_query_result_cached_document
:members:
:member-order: bysource
:undoc-members: True

33
docs/api/types/inline_query_result_cached_gif.md
View file

@ -1,33 +0,0 @@
# InlineQueryResultCachedGif
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be gif |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `gif_file_id` | `#!python str` | A valid file identifier for the GIF file |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the GIF animation |
## Location
- `from aiogram.types import InlineQueryResultCachedGif`
- `from aiogram.api.types import InlineQueryResultCachedGif`
- `from aiogram.api.types.inline_query_result_cached_gif import InlineQueryResultCachedGif`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedgif)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_gif.rst Normal file
View file

@ -0,0 +1,9 @@
##########################
InlineQueryResultCachedGif
##########################
.. automodule:: aiogram.types.inline_query_result_cached_gif
:members:
:member-order: bysource
:undoc-members: True

33
docs/api/types/inline_query_result_cached_mpeg4_gif.md
View file

@ -1,33 +0,0 @@
# InlineQueryResultCachedMpeg4Gif
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be mpeg4_gif |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `mpeg4_file_id` | `#!python str` | A valid file identifier for the MP4 file |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video animation |
## Location
- `from aiogram.types import InlineQueryResultCachedMpeg4Gif`
- `from aiogram.api.types import InlineQueryResultCachedMpeg4Gif`
- `from aiogram.api.types.inline_query_result_cached_mpeg4_gif import InlineQueryResultCachedMpeg4Gif`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_mpeg4_gif.rst Normal file
View file

@ -0,0 +1,9 @@
###############################
InlineQueryResultCachedMpeg4Gif
###############################
.. automodule:: aiogram.types.inline_query_result_cached_mpeg4_gif
:members:
:member-order: bysource
:undoc-members: True

34
docs/api/types/inline_query_result_cached_photo.md
View file

@ -1,34 +0,0 @@
# InlineQueryResultCachedPhoto
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be photo |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `photo_file_id` | `#!python str` | A valid file identifier of the photo |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the photo |
## Location
- `from aiogram.types import InlineQueryResultCachedPhoto`
- `from aiogram.api.types import InlineQueryResultCachedPhoto`
- `from aiogram.api.types.inline_query_result_cached_photo import InlineQueryResultCachedPhoto`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedphoto)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_photo.rst Normal file
View file

@ -0,0 +1,9 @@
############################
InlineQueryResultCachedPhoto
############################
.. automodule:: aiogram.types.inline_query_result_cached_photo
:members:
:member-order: bysource
:undoc-members: True

32
docs/api/types/inline_query_result_cached_sticker.md
View file

@ -1,32 +0,0 @@
# InlineQueryResultCachedSticker
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be sticker |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `sticker_file_id` | `#!python str` | A valid file identifier of the sticker |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the sticker |
## Location
- `from aiogram.types import InlineQueryResultCachedSticker`
- `from aiogram.api.types import InlineQueryResultCachedSticker`
- `from aiogram.api.types.inline_query_result_cached_sticker import InlineQueryResultCachedSticker`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedsticker)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_sticker.rst Normal file
View file

@ -0,0 +1,9 @@
##############################
InlineQueryResultCachedSticker
##############################
.. automodule:: aiogram.types.inline_query_result_cached_sticker
:members:
:member-order: bysource
:undoc-members: True

34
docs/api/types/inline_query_result_cached_video.md
View file

@ -1,34 +0,0 @@
# InlineQueryResultCachedVideo
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be video |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `video_file_id` | `#!python str` | A valid file identifier for the video file |
| `title` | `#!python str` | Title for the result |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the video caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video |
## Location
- `from aiogram.types import InlineQueryResultCachedVideo`
- `from aiogram.api.types import InlineQueryResultCachedVideo`
- `from aiogram.api.types.inline_query_result_cached_video import InlineQueryResultCachedVideo`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedvideo)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_video.rst Normal file
View file

@ -0,0 +1,9 @@
############################
InlineQueryResultCachedVideo
############################
.. automodule:: aiogram.types.inline_query_result_cached_video
:members:
:member-order: bysource
:undoc-members: True

35
docs/api/types/inline_query_result_cached_voice.md
View file

@ -1,35 +0,0 @@
# InlineQueryResultCachedVoice
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be voice |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `voice_file_id` | `#!python str` | A valid file identifier for the voice message |
| `title` | `#!python str` | Voice message title |
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the voice message |
## Location
- `from aiogram.types import InlineQueryResultCachedVoice`
- `from aiogram.api.types import InlineQueryResultCachedVoice`
- `from aiogram.api.types.inline_query_result_cached_voice import InlineQueryResultCachedVoice`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcachedvoice)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_cached_voice.rst Normal file
View file

@ -0,0 +1,9 @@
############################
InlineQueryResultCachedVoice
############################
.. automodule:: aiogram.types.inline_query_result_cached_voice
:members:
:member-order: bysource
:undoc-members: True

38
docs/api/types/inline_query_result_contact.md
View file

@ -1,38 +0,0 @@
# InlineQueryResultContact
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be contact |
| `id` | `#!python str` | Unique identifier for this result, 1-64 Bytes |
| `phone_number` | `#!python str` | Contact's phone number |
| `first_name` | `#!python str` | Contact's first name |
| `last_name` | `#!python Optional[str]` | Optional. Contact's last name |
| `vcard` | `#!python Optional[str]` | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the contact |
| `thumb_url` | `#!python Optional[str]` | Optional. Url of the thumbnail for the result |
| `thumb_width` | `#!python Optional[int]` | Optional. Thumbnail width |
| `thumb_height` | `#!python Optional[int]` | Optional. Thumbnail height |
## Location
- `from aiogram.types import InlineQueryResultContact`
- `from aiogram.api.types import InlineQueryResultContact`
- `from aiogram.api.types.inline_query_result_contact import InlineQueryResultContact`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultcontact)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_contact.rst Normal file
View file

@ -0,0 +1,9 @@
########################
InlineQueryResultContact
########################
.. automodule:: aiogram.types.inline_query_result_contact
:members:
:member-order: bysource
:undoc-members: True

40
docs/api/types/inline_query_result_document.md
View file

@ -1,40 +0,0 @@
# InlineQueryResultDocument
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be document |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `title` | `#!python str` | Title for the result |
| `document_url` | `#!python str` | A valid URL for the file |
| `mime_type` | `#!python str` | Mime type of the content of the file, either 'application/pdf' or 'application/zip' |
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the document caption. See formatting options for more details. |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the file |
| `thumb_url` | `#!python Optional[str]` | Optional. URL of the thumbnail (jpeg only) for the file |
| `thumb_width` | `#!python Optional[int]` | Optional. Thumbnail width |
| `thumb_height` | `#!python Optional[int]` | Optional. Thumbnail height |
## Location
- `from aiogram.types import InlineQueryResultDocument`
- `from aiogram.api.types import InlineQueryResultDocument`
- `from aiogram.api.types.inline_query_result_document import InlineQueryResultDocument`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultdocument)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_document.rst Normal file
View file

@ -0,0 +1,9 @@
#########################
InlineQueryResultDocument
#########################
.. automodule:: aiogram.types.inline_query_result_document
:members:
:member-order: bysource
:undoc-members: True

30
docs/api/types/inline_query_result_game.md
View file

@ -1,30 +0,0 @@
# InlineQueryResultGame
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be game |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `game_short_name` | `#!python str` | Short name of the game |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
## Location
- `from aiogram.types import InlineQueryResultGame`
- `from aiogram.api.types import InlineQueryResultGame`
- `from aiogram.api.types.inline_query_result_game import InlineQueryResultGame`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultgame)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)

9
docs/api/types/inline_query_result_game.rst Normal file
View file

@ -0,0 +1,9 @@
#####################
InlineQueryResultGame
#####################
.. automodule:: aiogram.types.inline_query_result_game
:members:
:member-order: bysource
:undoc-members: True

37
docs/api/types/inline_query_result_gif.md
View file

@ -1,37 +0,0 @@
# InlineQueryResultGif
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be gif |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `gif_url` | `#!python str` | A valid URL for the GIF file. File size must not exceed 1MB |
| `thumb_url` | `#!python str` | URL of the static thumbnail for the result (jpeg or gif) |
| `gif_width` | `#!python Optional[int]` | Optional. Width of the GIF |
| `gif_height` | `#!python Optional[int]` | Optional. Height of the GIF |
| `gif_duration` | `#!python Optional[int]` | Optional. Duration of the GIF |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the GIF animation |
## Location
- `from aiogram.types import InlineQueryResultGif`
- `from aiogram.api.types import InlineQueryResultGif`
- `from aiogram.api.types.inline_query_result_gif import InlineQueryResultGif`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultgif)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_gif.rst Normal file
View file

@ -0,0 +1,9 @@
####################
InlineQueryResultGif
####################
.. automodule:: aiogram.types.inline_query_result_gif
:members:
:member-order: bysource
:undoc-members: True

38
docs/api/types/inline_query_result_location.md
View file

@ -1,38 +0,0 @@
# InlineQueryResultLocation
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be location |
| `id` | `#!python str` | Unique identifier for this result, 1-64 Bytes |
| `latitude` | `#!python float` | Location latitude in degrees |
| `longitude` | `#!python float` | Location longitude in degrees |
| `title` | `#!python str` | Location title |
| `live_period` | `#!python Optional[int]` | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the location |
| `thumb_url` | `#!python Optional[str]` | Optional. Url of the thumbnail for the result |
| `thumb_width` | `#!python Optional[int]` | Optional. Thumbnail width |
| `thumb_height` | `#!python Optional[int]` | Optional. Thumbnail height |
## Location
- `from aiogram.types import InlineQueryResultLocation`
- `from aiogram.api.types import InlineQueryResultLocation`
- `from aiogram.api.types.inline_query_result_location import InlineQueryResultLocation`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultlocation)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_location.rst Normal file
View file

@ -0,0 +1,9 @@
#########################
InlineQueryResultLocation
#########################
.. automodule:: aiogram.types.inline_query_result_location
:members:
:member-order: bysource
:undoc-members: True

37
docs/api/types/inline_query_result_mpeg4_gif.md
View file

@ -1,37 +0,0 @@
# InlineQueryResultMpeg4Gif
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be mpeg4_gif |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `mpeg4_url` | `#!python str` | A valid URL for the MP4 file. File size must not exceed 1MB |
| `thumb_url` | `#!python str` | URL of the static thumbnail (jpeg or gif) for the result |
| `mpeg4_width` | `#!python Optional[int]` | Optional. Video width |
| `mpeg4_height` | `#!python Optional[int]` | Optional. Video height |
| `mpeg4_duration` | `#!python Optional[int]` | Optional. Video duration |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video animation |
## Location
- `from aiogram.types import InlineQueryResultMpeg4Gif`
- `from aiogram.api.types import InlineQueryResultMpeg4Gif`
- `from aiogram.api.types.inline_query_result_mpeg4_gif import InlineQueryResultMpeg4Gif`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_mpeg4_gif.rst Normal file
View file

@ -0,0 +1,9 @@
#########################
InlineQueryResultMpeg4Gif
#########################
.. automodule:: aiogram.types.inline_query_result_mpeg4_gif
:members:
:member-order: bysource
:undoc-members: True

37
docs/api/types/inline_query_result_photo.md
View file

@ -1,37 +0,0 @@
# InlineQueryResultPhoto
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be photo |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `photo_url` | `#!python str` | A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB |
| `thumb_url` | `#!python str` | URL of the thumbnail for the photo |
| `photo_width` | `#!python Optional[int]` | Optional. Width of the photo |
| `photo_height` | `#!python Optional[int]` | Optional. Height of the photo |
| `title` | `#!python Optional[str]` | Optional. Title for the result |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the photo |
## Location
- `from aiogram.types import InlineQueryResultPhoto`
- `from aiogram.api.types import InlineQueryResultPhoto`
- `from aiogram.api.types.inline_query_result_photo import InlineQueryResultPhoto`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultphoto)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_photo.rst Normal file
View file

@ -0,0 +1,9 @@
######################
InlineQueryResultPhoto
######################
.. automodule:: aiogram.types.inline_query_result_photo
:members:
:member-order: bysource
:undoc-members: True

40
docs/api/types/inline_query_result_venue.md
View file

@ -1,40 +0,0 @@
# InlineQueryResultVenue
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be venue |
| `id` | `#!python str` | Unique identifier for this result, 1-64 Bytes |
| `latitude` | `#!python float` | Latitude of the venue location in degrees |
| `longitude` | `#!python float` | Longitude of the venue location in degrees |
| `title` | `#!python str` | Title of the venue |
| `address` | `#!python str` | Address of the venue |
| `foursquare_id` | `#!python Optional[str]` | Optional. Foursquare identifier of the venue if known |
| `foursquare_type` | `#!python Optional[str]` | Optional. Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.) |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the venue |
| `thumb_url` | `#!python Optional[str]` | Optional. Url of the thumbnail for the result |
| `thumb_width` | `#!python Optional[int]` | Optional. Thumbnail width |
| `thumb_height` | `#!python Optional[int]` | Optional. Thumbnail height |
## Location
- `from aiogram.types import InlineQueryResultVenue`
- `from aiogram.api.types import InlineQueryResultVenue`
- `from aiogram.api.types.inline_query_result_venue import InlineQueryResultVenue`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultvenue)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_venue.rst Normal file
View file

@ -0,0 +1,9 @@
######################
InlineQueryResultVenue
######################
.. automodule:: aiogram.types.inline_query_result_venue
:members:
:member-order: bysource
:undoc-members: True

41
docs/api/types/inline_query_result_video.md
View file

@ -1,41 +0,0 @@
# InlineQueryResultVideo
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be video |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `video_url` | `#!python str` | A valid URL for the embedded video player or video file |
| `mime_type` | `#!python str` | Mime type of the content of video url, 'text/html' or 'video/mp4' |
| `thumb_url` | `#!python str` | URL of the thumbnail (jpeg only) for the video |
| `title` | `#!python str` | Title for the result |
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the video caption. See formatting options for more details. |
| `video_width` | `#!python Optional[int]` | Optional. Video width |
| `video_height` | `#!python Optional[int]` | Optional. Video height |
| `video_duration` | `#!python Optional[int]` | Optional. Video duration in seconds |
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). |
## Location
- `from aiogram.types import InlineQueryResultVideo`
- `from aiogram.api.types import InlineQueryResultVideo`
- `from aiogram.api.types.inline_query_result_video import InlineQueryResultVideo`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultvideo)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_video.rst Normal file
View file

@ -0,0 +1,9 @@
######################
InlineQueryResultVideo
######################
.. automodule:: aiogram.types.inline_query_result_video
:members:
:member-order: bysource
:undoc-members: True

36
docs/api/types/inline_query_result_voice.md
View file

@ -1,36 +0,0 @@
# InlineQueryResultVoice
## Description
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.
## Attributes
| Name | Type | Description |
| - | - | - |
| `type` | `#!python str` | Type of the result, must be voice |
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
| `voice_url` | `#!python str` | A valid URL for the voice recording |
| `title` | `#!python str` | Recording title |
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
| `parse_mode` | `#!python Optional[str]` | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. |
| `voice_duration` | `#!python Optional[int]` | Optional. Recording duration in seconds |
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the voice recording |
## Location
- `from aiogram.types import InlineQueryResultVoice`
- `from aiogram.api.types import InlineQueryResultVoice`
- `from aiogram.api.types.inline_query_result_voice import InlineQueryResultVoice`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inlinequeryresultvoice)
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
- [aiogram.types.InputMessageContent](../types/input_message_content.md)

9
docs/api/types/inline_query_result_voice.rst Normal file
View file

@ -0,0 +1,9 @@
######################
InlineQueryResultVoice
######################
.. automodule:: aiogram.types.inline_query_result_voice
:members:
:member-order: bysource
:undoc-members: True

27
docs/api/types/input_contact_message_content.md
View file

@ -1,27 +0,0 @@
# InputContactMessageContent
## Description
Represents the content of a contact message to be sent as the result of an inline query.
## Attributes
| Name | Type | Description |
| - | - | - |
| `phone_number` | `#!python str` | Contact's phone number |
| `first_name` | `#!python str` | Contact's first name |
| `last_name` | `#!python Optional[str]` | Optional. Contact's last name |
| `vcard` | `#!python Optional[str]` | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes |
## Location
- `from aiogram.types import InputContactMessageContent`
- `from aiogram.api.types import InputContactMessageContent`
- `from aiogram.api.types.input_contact_message_content import InputContactMessageContent`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inputcontactmessagecontent)

9
docs/api/types/input_contact_message_content.rst Normal file
View file

@ -0,0 +1,9 @@
##########################
InputContactMessageContent
##########################
.. automodule:: aiogram.types.input_contact_message_content
:members:
:member-order: bysource
:undoc-members: True

19
docs/api/types/input_file.md
View file

@ -1,19 +0,0 @@
# InputFile
## Description
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.
## Location
- `from aiogram.types import InputFile`
- `from aiogram.api.types import InputFile`
- `from aiogram.api.types.input_file import InputFile`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inputfile)
- [How to upload file?](../upload_file.md)

9
docs/api/types/input_file.rst Normal file
View file

@ -0,0 +1,9 @@
#########
InputFile
#########
.. automodule:: aiogram.types.input_file
:members:
:member-order: bysource
:undoc-members: True

9
docs/api/types/input_invoice_message_content.rst Normal file
View file

@ -0,0 +1,9 @@
##########################
InputInvoiceMessageContent
##########################
.. automodule:: aiogram.types.input_invoice_message_content
:members:
:member-order: bysource
:undoc-members: True

26
docs/api/types/input_location_message_content.md
View file

@ -1,26 +0,0 @@
# InputLocationMessageContent
## Description
Represents the content of a location message to be sent as the result of an inline query.
## Attributes
| Name | Type | Description |
| - | - | - |
| `latitude` | `#!python float` | Latitude of the location in degrees |
| `longitude` | `#!python float` | Longitude of the location in degrees |
| `live_period` | `#!python Optional[int]` | Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. |
## Location
- `from aiogram.types import InputLocationMessageContent`
- `from aiogram.api.types import InputLocationMessageContent`
- `from aiogram.api.types.input_location_message_content import InputLocationMessageContent`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inputlocationmessagecontent)

9
docs/api/types/input_location_message_content.rst Normal file
View file

@ -0,0 +1,9 @@
###########################
InputLocationMessageContent
###########################
.. automodule:: aiogram.types.input_location_message_content
:members:
:member-order: bysource
:undoc-members: True

28
docs/api/types/input_media.md
View file

@ -1,28 +0,0 @@
# InputMedia
## Description
This object represents the content of a media message to be sent. It should be one of
- InputMediaAnimation
- InputMediaDocument
- InputMediaAudio
- InputMediaPhoto
- InputMediaVideo
## Location
- `from aiogram.types import InputMedia`
- `from aiogram.api.types import InputMedia`
- `from aiogram.api.types.input_media import InputMedia`
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#inputmedia)

9
docs/api/types/input_media.rst Normal file
View file

@ -0,0 +1,9 @@
##########
InputMedia
##########
.. automodule:: aiogram.types.input_media
:members:
:member-order: bysource
:undoc-members: True

Some files were not shown because too many files have changed in this diff Show more