mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 02:03:04 +00:00
Add autogenerated docs for types and methods
This commit is contained in:
parent
a24708d589
commit
65331e1fda
166 changed files with 7361 additions and 4 deletions
62
docs/api/methods/set_passport_data_errors.md
Normal file
62
docs/api/methods/set_passport_data_errors.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# setPassportDataErrors
|
||||
|
||||
## Description
|
||||
|
||||
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
|
||||
|
||||
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
|
||||
|
||||
|
||||
## Arguments
|
||||
|
||||
| Name | Type | Description |
|
||||
| - | - | - |
|
||||
| `user_id` | `#!python3 int` | User identifier |
|
||||
| `errors` | `#!python3 List[PassportElementError]` | A JSON-serialized array describing the errors |
|
||||
|
||||
|
||||
|
||||
## Response
|
||||
|
||||
Type: `#!python3 bool`
|
||||
|
||||
Description: The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
### As bot method bot
|
||||
|
||||
```python3
|
||||
result: bool = await bot.set_passport_data_errors(...)
|
||||
```
|
||||
|
||||
### Method as object
|
||||
|
||||
Imports:
|
||||
|
||||
- `from aiogram.types import SetPassportDataErrors`
|
||||
- `from aiogram.api.types import SetPassportDataErrors`
|
||||
- `from aiogram.api.types.set_passport_data_errors import SetPassportDataErrors`
|
||||
|
||||
#### As reply into Webhook
|
||||
```python3
|
||||
return SetPassportDataErrors(...)
|
||||
```
|
||||
|
||||
#### With specific bot
|
||||
```python3
|
||||
result: bool = await bot.emit(SetPassportDataErrors(...))
|
||||
```
|
||||
|
||||
#### In handlers with current bot
|
||||
```python3
|
||||
result: bool = await SetPassportDataErrors(...)
|
||||
```
|
||||
|
||||
|
||||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#setpassportdataerrors)
|
||||
- [aiogram.types.PassportElementError](../types/passport_element_error.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue