Source code for pyrogram.methods.stories.toggle_stories_pinned_to_top
# 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
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import Iterable
class ToggleStoriesPinnedToTop:
async def toggle_stories_pinned_to_top(
self: pyrogram.Client,
chat_id: int | str,
story_ids: int | Iterable[int],
) -> bool:
"""Pin stories to the top of the pinned stories list.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
story_ids (``int`` | Iterable of ``int``):
A single story ID or list of story IDs to pin to top.
Returns:
``bool``: True on success.
Example:
.. code-block:: python
await app.toggle_stories_pinned_to_top(chat_id, [123, 456])
"""
peer = await self.resolve_peer(chat_id)
ids = list(story_ids) if not isinstance(story_ids, int) else [story_ids]
return await self.invoke(
raw.functions.stories.TogglePinnedToTop(
peer=peer,
id=ids,
)
)