Source code for pyrogram.methods.stories.toggle_all_stories_hidden

#  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


class ToggleAllStoriesHidden:
    async def toggle_all_stories_hidden(
        self: pyrogram.Client,
        hidden: bool = True,
    ) -> bool:
        """Globally hide or unhide all stories from the top of the chat list.

        .. include:: /_includes/usable-by/users.rst

        Parameters:
            hidden (``bool``, *optional*):
                Pass True to hide all stories, False to show them.
                Defaults to True.

        Returns:
            ``bool``: True on success.

        Example:
            .. code-block:: python

                # Hide all stories
                await app.toggle_all_stories_hidden(True)

                # Show all stories
                await app.toggle_all_stories_hidden(False)
        """
        return await self.invoke(
            raw.functions.stories.ToggleAllStoriesHidden(
                hidden=hidden,
            )
        )