Source code for pyrogram.methods.stories.edit_story_caption
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import pyrogram
from pyrogram import enums, raw, types, utils
class EditStoryCaption:
async def edit_story_caption(
self: pyrogram.Client,
chat_id: int | str,
story_id: int,
caption: str,
parse_mode: enums.ParseMode | None = None,
caption_entities: list[types.MessageEntity] | None = None,
) -> types.Story:
"""Edit the caption of story.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
story_id (``int``):
Story identifier in the chat specified in chat_id.
caption (``str``):
New caption of the story, 0-1024 characters.
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
caption_entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
Returns:
:obj:`~pyrogram.types.Story`: On success, the edited story is returned.
Example:
.. code-block:: python
await app.edit_story(chat_id, story_id, "new media caption")
"""
message, entities = (
await utils.parse_text_entities(self, caption, parse_mode, caption_entities)
).values()
r = await self.invoke(
raw.functions.stories.EditStory(
peer=await self.resolve_peer(chat_id),
id=story_id,
caption=message,
entities=entities or [],
privacy_rules=None,
)
)
for i in r.updates:
if isinstance(i, raw.types.UpdateStory):
return await types.Story._parse(
self, i.story, i.peer, {i.id: i for i in r.users}, {i.id: i for i in r.chats}
)