mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Improving docs
This commit is contained in:
parent
544e0ec2f2
commit
30d69d8d4a
33 changed files with 50 additions and 42 deletions
|
|
@ -92,13 +92,15 @@ await bot.download(document)
|
|||
|
||||
## Related pages:
|
||||
|
||||
- [Animation](types/animation.md)
|
||||
- [Audio](types/audio.md)
|
||||
- [Document](types/document.md)
|
||||
- [File](types/file.md)
|
||||
- [PassportFile](types/passport_file.md)
|
||||
- [PhotoSize](types/photo_size.md)
|
||||
- [Sticker](types/sticker.md)
|
||||
- [Video](types/video.md)
|
||||
- [VideoNote](types/video_note.md)
|
||||
- [Voice](types/voice.md)
|
||||
- [Official documentation](https://core.telegram.org/bots/api#getfile)
|
||||
- [aiogram.types.Animation](types/animation.md)
|
||||
- [aiogram.types.Audio](types/audio.md)
|
||||
- [aiogram.types.Document](types/document.md)
|
||||
- [aiogram.types.File](types/file.md)
|
||||
- [aiogram.types.PassportFile](types/passport_file.md)
|
||||
- [aiogram.types.PhotoSize](types/photo_size.md)
|
||||
- [aiogram.types.Sticker](types/sticker.md)
|
||||
- [aiogram.types.Video](types/video.md)
|
||||
- [aiogram.types.VideoNote](types/video_note.md)
|
||||
- [aiogram.types.Voice](types/voice.md)
|
||||
- [How to upload file?](upload_file.md)
|
||||
|
|
@ -61,4 +61,4 @@ return AddStickerToSet(...)
|
|||
- [Official documentation](https://core.telegram.org/bots/api#addstickertoset)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [aiogram.types.MaskPosition](../types/mask_position.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -63,4 +63,4 @@ return CreateNewStickerSet(...)
|
|||
- [Official documentation](https://core.telegram.org/bots/api#createnewstickerset)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [aiogram.types.MaskPosition](../types/mask_position.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ return SendAnimation(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ return SendAudio(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -67,4 +67,4 @@ return SendDocument(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -66,4 +66,4 @@ return SendPhoto(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -64,4 +64,4 @@ return SendSticker(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -71,4 +71,4 @@ return SendVideo(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -67,4 +67,4 @@ return SendVideoNote(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -67,4 +67,4 @@ return SendVoice(...)
|
|||
- [aiogram.types.Message](../types/message.md)
|
||||
- [aiogram.types.ReplyKeyboardMarkup](../types/reply_keyboard_markup.md)
|
||||
- [aiogram.types.ReplyKeyboardRemove](../types/reply_keyboard_remove.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -53,4 +53,4 @@ result: bool = await bot(SetChatPhoto(...))
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#setchatphoto)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -57,4 +57,4 @@ return SetStickerSetThumb(...)
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#setstickersetthumb)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ return SetWebhook(...)
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#setwebhook)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -54,4 +54,4 @@ result: File = await bot(UploadStickerFile(...))
|
|||
- [Official documentation](https://core.telegram.org/bots/api#uploadstickerfile)
|
||||
- [aiogram.types.File](../types/file.md)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -31,4 +31,4 @@ This object represents an animation file (GIF or H.264/MPEG-4 AVC video without
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#animation)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ This object represents an audio file to be treated as music by the Telegram clie
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#audio)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -28,4 +28,4 @@ This object represents a general file (as opposed to photos, voice messages and
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#document)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -27,4 +27,4 @@ Maximum file size to download is 20 MB
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#file)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -16,4 +16,4 @@ This object represents the contents of a file to be uploaded. Must be posted usi
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputfile)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputmediaanimation)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ Represents an audio file to be treated as music to be sent.
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputmediaaudio)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -27,4 +27,4 @@ Represents a general file to be sent.
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputmediadocument)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ Represents a photo to be sent.
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputmediaphoto)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -31,4 +31,4 @@ Represents a video to be sent.
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#inputmediavideo)
|
||||
- [aiogram.types.InputFile](../types/input_file.md)
|
||||
- [How to upload file?](../sending_files.md)
|
||||
- [How to upload file?](../upload_file.md)
|
||||
|
|
|
|||
|
|
@ -25,4 +25,4 @@ This object represents a file uploaded to Telegram Passport. Currently all Teleg
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#passportfile)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ This object represents one size of a photo or a file / sticker thumbnail.
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#photosize)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ This object represents a sticker.
|
|||
- [Official documentation](https://core.telegram.org/bots/api#sticker)
|
||||
- [aiogram.types.MaskPosition](../types/mask_position.md)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ This object represents a video file.
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#video)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -28,4 +28,4 @@ This object represents a video message (available in Telegram apps as of v.4.0).
|
|||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#videonote)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ This object represents a voice note.
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#voice)
|
||||
- [How to download file?](../downloading_files.md)
|
||||
- [How to download file?](../download_file.md)
|
||||
|
|
|
|||
|
|
@ -89,3 +89,9 @@ image = URLInputFile("https://www.python.org/static/community_logos/python-power
|
|||
| `filename` | `#!python3 Optional[str]` | Custom filename to be presented to Telegram |
|
||||
| `chunk_size` | `#!python3 int` | File chunks size (Default: `64 kb`) |
|
||||
| `timeout` | `#!python3 int` | Total timeout in seconds (Default: `30`) |
|
||||
|
||||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#sending-files)
|
||||
- [aiogram.types.InputFile](types/input_file.md)
|
||||
- [How to download file?](download_file.md)
|
||||
|
|
@ -233,8 +233,8 @@ nav:
|
|||
- api/types/game.md
|
||||
- api/types/callback_game.md
|
||||
- api/types/game_high_score.md
|
||||
- api/downloading_files.md
|
||||
- api/sending_files.md
|
||||
- api/download_file.md
|
||||
- api/upload_file.md
|
||||
- Dispatcher:
|
||||
- dispatcher/index.md
|
||||
- dispatcher/router.md
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue