mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-11 18:01:04 +00:00
6be0b36305
* AIOG-T-20 Bot API 4.8 * AIOG-T-20 Update aliases * AIOG-T-20 Add parse mode passing in sendPoll method * AIOG-T-20 Small changes in docs * AIOG-T-20 Revert overriding remove keyboard default value and add tests * AIOG-T-20 Bot API 4.8
64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
# editMessageText
|
|
|
|
## Description
|
|
|
|
Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
|
|
|
|
|
|
## Arguments
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `text` | `#!python3 str` | New text of the message, 1-4096 characters after entities parsing |
|
|
| `chat_id` | `#!python3 Optional[Union[int, str]]` | Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
|
|
| `message_id` | `#!python3 Optional[int]` | Optional. Required if inline_message_id is not specified. Identifier of the message to edit |
|
|
| `inline_message_id` | `#!python3 Optional[str]` | Optional. Required if chat_id and message_id are not specified. Identifier of the inline message |
|
|
| `parse_mode` | `#!python3 Optional[str]` | Optional. Mode for parsing entities in the message text. See formatting options for more details. |
|
|
| `disable_web_page_preview` | `#!python3 Optional[bool]` | Optional. Disables link previews for links in this message |
|
|
| `reply_markup` | `#!python3 Optional[InlineKeyboardMarkup]` | Optional. A JSON-serialized object for an inline keyboard. |
|
|
|
|
|
|
|
|
## Response
|
|
|
|
Type: `#!python3 Union[Message, bool]`
|
|
|
|
Description: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
|
|
|
|
|
|
## Usage
|
|
|
|
### As bot method
|
|
|
|
```python3
|
|
result: Union[Message, bool] = await bot.edit_message_text(...)
|
|
```
|
|
|
|
### Method as object
|
|
|
|
Imports:
|
|
|
|
- `from aiogram.methods import EditMessageText`
|
|
- `from aiogram.api.methods import EditMessageText`
|
|
- `from aiogram.api.methods.edit_message_text import EditMessageText`
|
|
|
|
#### In handlers with current bot
|
|
```python3
|
|
result: Union[Message, bool] = await EditMessageText(...)
|
|
```
|
|
|
|
#### With specific bot
|
|
```python3
|
|
result: Union[Message, bool] = await bot(EditMessageText(...))
|
|
```
|
|
#### As reply into Webhook in handler
|
|
```python3
|
|
return EditMessageText(...)
|
|
```
|
|
|
|
|
|
## Related pages:
|
|
|
|
- [Official documentation](https://core.telegram.org/bots/api#editmessagetext)
|
|
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
|
|
- [aiogram.types.Message](../types/message.md)
|