Source code for pyrogram.methods.messages.check_search_posts_flood

#  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 CheckSearchPostsFlood:
    async def check_search_posts_flood(
        self: pyrogram.Client,
        query: str | None = None,
    ) -> raw.types.SearchPostsFlood:
        """Check the current flood status and quota for searching public channel posts.

        Parameters:
            query (``str``, *optional*):
                The query or hashtag to check search limits for.

        Returns:
            :obj:`~pyrogram.raw.types.SearchPostsFlood`: The flood quota information.

        Example:
            .. code-block:: python

                flood_info = await app.check_search_posts_flood()
        """
        return await self.invoke(
            raw.functions.channels.CheckSearchPostsFlood(
                query=query,
            )
        )