mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 02:03:04 +00:00
Add docs for ContentTypesFilter
This commit is contained in:
parent
6ee05fb901
commit
1d9e80a4dc
3 changed files with 45 additions and 5 deletions
38
docs/dispatcher/filters/content_types.md
Normal file
38
docs/dispatcher/filters/content_types.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# ContentTypesFilter
|
||||
|
||||
Is useful for handling specific types of messages (For example separate text and stickers handlers).
|
||||
This is always automatically adds to the filters list for message handlers.
|
||||
|
||||
Can be imported:
|
||||
|
||||
- `#!python3 from aiogram.dispatcher.filters.content_types import ContentTypesFilter`
|
||||
- `#!python3 from aiogram.dispatcher.filters import ContentTypesFilter`
|
||||
- `#!python3 from aiogram.filters import ContentTypesFilter`
|
||||
|
||||
Or used from filters factory by passing corresponding arguments to handler registration line
|
||||
|
||||
!!! warning "Please be patient!"
|
||||
If no one content type filter is specified the `["text"]` value is automatically will be used.
|
||||
|
||||
|
||||
## Specification
|
||||
|
||||
| Argument | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `content_types` | `#!python3 Optional[List[str]]` | List of allowed content types |
|
||||
|
||||
## Usage
|
||||
|
||||
1. Single content type: `#!python3 ContentTypesFilter(content_types=["sticker"])`
|
||||
1. Multiple content types: `#!python3 ContentTypesFilter(content_types=["sticker", "photo"])`
|
||||
1. Recommended: With usage of `ContentType` helper: `#!python3 ContentTypesFilter(content_types=[ContentType.PHOTO])`
|
||||
1. Any content type: `#!python3 ContentTypesFilter(content_types=[ContentType.ANY])`
|
||||
|
||||
## Allowed handlers
|
||||
|
||||
Allowed update types for this filter:
|
||||
|
||||
- `message`
|
||||
- `edited_message`
|
||||
- `channel_post`
|
||||
- `edited_channel_post`
|
||||
|
|
@ -10,8 +10,9 @@ Searching of handler is always stops on first match set of filters are pass.
|
|||
Here is list of builtin filters and event types where it can be used:
|
||||
|
||||
| Filter | update | message | edited_message | channel_post | edited_channel_post | inline_query | chosen_inline_result | callback_query | shipping_query | pre_checkout_query | poll |
|
||||
| --------------------------- |:------:|:-------:|:--------------:|:------------:|:-------------------:|:------------:|:--------------------:|:--------------:|:--------------:|:------------------:|:----:|
|
||||
| ----------------------------------------- |:------:|:-------:|:--------------:|:------------:|:-------------------:|:------------:|:--------------------:|:--------------:|:--------------:|:------------------:|:----:|
|
||||
| [Text](text.md) | | + | + | + | + | + | | + | | | + |
|
||||
| [ContentTypesFilter](content_types.md) | | + | + | + | + | | | | | | |
|
||||
| [Command](command.md) | | + | | | | | | | | | |
|
||||
| | | | | | | | | | | | |
|
||||
|
||||
|
|
|
|||
|
|
@ -226,6 +226,7 @@ nav:
|
|||
- dispatcher/filters/index.md
|
||||
- dispatcher/filters/text.md
|
||||
- dispatcher/filters/command.md
|
||||
- dispatcher/filters/content_types.md
|
||||
- Class based handlers:
|
||||
- dispatcher/class_based_handlers/basics.md
|
||||
- dispatcher/class_based_handlers/message.md
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue