pyrofork/pyrogram/methods/messages/search_global_count.py
wulan17 1b3f0933c7
Pyrofork: Update Copyright headers
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-02-07 20:25:08 +07:00

63 lines
2.2 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrofork.
#
# Pyrofork 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.
#
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
import pyrogram
from pyrogram import raw, enums
class SearchGlobalCount:
async def search_global_count(
self: "pyrogram.Client",
query: str = "",
filter: "enums.MessagesFilter" = enums.MessagesFilter.EMPTY,
) -> 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:
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
)
)
if hasattr(r, "count"):
return r.count
else:
return len(r.messages)