# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from io import BytesIO
from hydrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from hydrogram.raw.core import TLObject
from hydrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class SearchGlobal(TLObject): # type: ignore
"""Search for messages and peers globally
Details:
- Layer: ``181``
- ID: ``4BC6589A``
Parameters:
q (``str``):
Query
filter (:obj:`MessagesFilter <hydrogram.raw.base.MessagesFilter>`):
Global search filter
min_date (``int`` ``32-bit``):
If a positive value was specified, the method will return only messages with date bigger than min_date
max_date (``int`` ``32-bit``):
If a positive value was transferred, the method will return only messages with date smaller than max_date
offset_rate (``int`` ``32-bit``):
Initially 0, then set to the next_rate parameter of messages.messagesSlice
offset_peer (:obj:`InputPeer <hydrogram.raw.base.InputPeer>`):
Offsets for pagination, for more info click here
offset_id (``int`` ``32-bit``):
Offsets for pagination, for more info click here
limit (``int`` ``32-bit``):
Offsets for pagination, for more info click here
broadcasts_only (``bool``, *optional*):
folder_id (``int`` ``32-bit``, *optional*):
Peer folder ID, for more info click here
Returns:
:obj:`messages.Messages <hydrogram.raw.base.messages.Messages>`
"""
__slots__: List[str] = ["q", "filter", "min_date", "max_date", "offset_rate", "offset_peer", "offset_id", "limit", "broadcasts_only", "folder_id"]
ID = 0x4bc6589a
QUALNAME = "functions.messages.SearchGlobal"
def __init__(self, *, q: str, filter: "raw.base.MessagesFilter", min_date: int, max_date: int, offset_rate: int, offset_peer: "raw.base.InputPeer", offset_id: int, limit: int, broadcasts_only: Optional[bool] = None, folder_id: Optional[int] = None) -> None:
self.q = q # string
self.filter = filter # MessagesFilter
self.min_date = min_date # int
self.max_date = max_date # int
self.offset_rate = offset_rate # int
self.offset_peer = offset_peer # InputPeer
self.offset_id = offset_id # int
self.limit = limit # int
self.broadcasts_only = broadcasts_only # flags.1?true
self.folder_id = folder_id # flags.0?int
@staticmethod
def read(b: BytesIO, *args: Any) -> "SearchGlobal":
flags = Int.read(b)
broadcasts_only = True if flags & (1 << 1) else False
folder_id = Int.read(b) if flags & (1 << 0) else None
q = String.read(b)
filter = TLObject.read(b)
min_date = Int.read(b)
max_date = Int.read(b)
offset_rate = Int.read(b)
offset_peer = TLObject.read(b)
offset_id = Int.read(b)
limit = Int.read(b)
return SearchGlobal(q=q, filter=filter, min_date=min_date, max_date=max_date, offset_rate=offset_rate, offset_peer=offset_peer, offset_id=offset_id, limit=limit, broadcasts_only=broadcasts_only, folder_id=folder_id)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 1) if self.broadcasts_only else 0
flags |= (1 << 0) if self.folder_id is not None else 0
b.write(Int(flags))
if self.folder_id is not None:
b.write(Int(self.folder_id))
b.write(String(self.q))
b.write(self.filter.write())
b.write(Int(self.min_date))
b.write(Int(self.max_date))
b.write(Int(self.offset_rate))
b.write(self.offset_peer.write())
b.write(Int(self.offset_id))
b.write(Int(self.limit))
return b.getvalue()