# 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 raw, types, utils
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime, timedelta
class ForwardStory:
async def forward_story(
self: pyrogram.Client,
chat_id: int | str,
from_chat_id: int | str,
story_id: int,
disable_notification: bool | None = None,
message_thread_id: int | None = None,
schedule_date: datetime | timedelta | None = None,
repeat_period: int | None = None,
paid_message_star_count: int | None = None,
protect_content: bool | None = None,
allow_paid_broadcast: bool | None = None,
reply_parameters: types.ReplyParameters | None = None,
reply_markup: types.InlineKeyboardMarkup
| types.ReplyKeyboardMarkup
| types.ReplyKeyboardRemove
| types.ForceReply
| None = None,
effect_id: int | None = None,
show_caption_above_media: bool | None = None,
background: bool | None = None,
clear_draft: bool | None = None,
update_stickersets_order: bool | None = None,
send_as: int | str | None = None,
quick_reply_shortcut: int | None = None,
business_connection_id: str | None = None,
) -> types.Message | None:
"""Forward story.
.. include:: /_includes/usable-by/users-bots.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".
For a contact that exists in your Telegram address book you can use his phone number (str).
from_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".
For a contact that exists in your Telegram address book you can use his phone number (str).
story_id (``int``):
Unique identifier of story.
disable_notification (``bool``, *optional*):
Sends the message with story silently.
Users will receive a notification with no sound.
message_thread_id (``int``, *optional*):
Unique identifier for the target message thread (topic) of the forum.
For supergroups only.
schedule_date (:py:obj:`~datetime.datetime`, *optional*):
Date when the message will be automatically sent.
repeat_period (``int``, *optional*):
Period after which the message will be sent again in seconds.
paid_message_star_count (``int``, *optional*):
The number of Telegram Stars the user agreed to pay to send the messages.
protect_content (``bool``, *optional*):
Pass True if the content of the message must be protected from forwarding and saving; for bots only.
allow_paid_broadcast (``bool``, *optional*):
Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*):
Description of the message to reply to.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
Additional interface options. An object for an inline keyboard, custom reply keyboard,
instructions to remove reply keyboard or to force a reply from the user.
effect_id (``int`` ``64-bit``, *optional*):
Unique identifier of the message effect to be added to the message; for private chats only.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media.
background (``bool``, *optional*):
Send the message in background.
clear_draft (``bool``, *optional*):
Clear the draft of the chat.
update_stickersets_order (``bool``, *optional*):
Move the sticker set to the top of the list.
send_as (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the chat or channel to send the message as.
quick_reply_shortcut (``int``, *optional*):
Unique identifier of the quick reply shortcut the message belongs to.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection.
Returns:
:obj:`~pyrogram.types.Message`: On success, the sent story message is returned.
Example:
.. code-block:: python
# Send your story to chat_id
await app.forward_story(to_chat, from_chat, 123)
"""
r = await self.invoke(
raw.functions.messages.SendMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaStory(
peer=await self.resolve_peer(from_chat_id), id=story_id
),
silent=disable_notification,
random_id=self.rnd_id(),
schedule_date=utils.datetime_to_timestamp(schedule_date),
schedule_repeat_period=repeat_period,
message="",
entities=None,
reply_to=await utils.get_reply_to(self, reply_parameters, message_thread_id),
allow_paid_stars=paid_message_star_count
if paid_message_star_count is not None
else None,
allow_paid_floodskip=allow_paid_broadcast
if allow_paid_broadcast is not None
else None,
reply_markup=await reply_markup.write(self) if reply_markup else None,
noforwards=protect_content,
effect=effect_id,
invert_media=show_caption_above_media
if show_caption_above_media is not None
else None,
background=background if background is not None else None,
clear_draft=clear_draft if clear_draft is not None else None,
update_stickersets_order=update_stickersets_order
if update_stickersets_order is not None
else None,
send_as=await self.resolve_peer(send_as) if send_as is not None else None,
quick_reply_shortcut=raw.types.InputQuickReplyShortcutId(
shortcut_id=quick_reply_shortcut
)
if quick_reply_shortcut is not None
else None,
suggested_post=None,
),
sleep_threshold=60,
business_connection_id=business_connection_id,
)
messages = await utils.parse_messages(client=self, messages=r)
return messages[0] if messages else None