Source code for pyrogram.methods.messages.search_global_count
# 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, utils
class SearchGlobalCount:
async def search_global_count(
self: pyrogram.Client,
query: str = "",
filter: enums.MessagesFilter = enums.MessagesFilter.EMPTY,
broadcasts_only: bool | None = None,
groups_only: bool | None = None,
users_only: bool | None = None,
folder_id: int | None = None,
community: int | str | None = None,
) -> int:
"""Get the count of messages resulting from a global search.
If you want to get the actual messages, see :meth:`~pyrogram.Client.search_global`.
.. include:: /_includes/usable-by/users.rst
Parameters:
query (``str``, *optional*):
Text query string.
Use "@" to search for mentions.
filter (:obj:`~pyrogram.enums.MessagesFilter`, *optional*):
Pass a filter in order to search for specific kind of messages only:
community (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the community to search in.
broadcasts_only (``bool``, *optional*):
Pass True to search channels only.
groups_only (``bool``, *optional*):
Pass True to search groups only.
users_only (``bool``, *optional*):
Pass True to search private chats only.
folder_id (``int``):
Unique identifier (int) of the target folder.
Returns:
``int``: On success, the messages count is returned.
"""
r = await self.invoke(
raw.functions.messages.SearchGlobal(
q=query,
filter=filter.value(),
min_date=0,
max_date=0,
offset_rate=0,
offset_peer=raw.types.InputPeerEmpty(),
offset_id=0,
limit=1,
broadcasts_only=broadcasts_only if broadcasts_only is not None else None,
groups_only=groups_only if groups_only is not None else None,
users_only=users_only if users_only is not None else None,
folder_id=folder_id,
community=utils.get_input_channel(await self.resolve_peer(community))
if community is not None
else None,
)
)
if hasattr(r, "count"):
return r.count
else:
return len(r.messages)