Source code for pyrogram.raw.functions.stories.search_posts
# 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 io import BytesIO
from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram 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 SearchPosts(TLObject): # type: ignore
"""Globally search for `stories <https://core.telegram.org/api/stories>`_ using a hashtag or a `location media area <https://core.telegram.org/api/stories#location-tags>`_, see `here ยป <https://core.telegram.org/api/stories#searching-stories>`_ for more info on the full flow.
.. include:: /_includes/usable-by/users.rst
Details:
- Layer: ``229``
- ID: ``D1810907``
Parameters:
offset (``str``):
Offset for `pagination <https://core.telegram.org/api/offsets>`_: initially an empty string, then the ``next_offset`` from the previously returned `stories.foundStories <https://core.telegram.org/constructor/stories.foundStories>`_.
limit (``int`` ``32-bit``):
Maximum number of results to return, `see pagination <https://core.telegram.org/api/offsets>`_
hashtag (``str``, *optional*):
Hashtag (without the ``#`` )
area (:obj:`MediaArea <pyrogram.raw.base.MediaArea>`, *optional*):
A `mediaAreaGeoPoint <https://core.telegram.org/constructor/mediaAreaGeoPoint>`_ or a `mediaAreaVenue <https://core.telegram.org/constructor/mediaAreaVenue>`_. Note `mediaAreaGeoPoint <https://core.telegram.org/constructor/mediaAreaGeoPoint>`_ areas may be searched only if they have an associated ``address``.
peer (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`, *optional*):
If set, returns only stories posted by this peer.
Returns:
:obj:`stories.FoundStories <pyrogram.raw.base.stories.FoundStories>`
"""
__slots__: List[str] = ["offset", "limit", "hashtag", "area", "peer"]
ID = 0xd1810907
QUALNAME = "functions.stories.SearchPosts"
def __init__(self, *, offset: str, limit: int, hashtag: Optional[str] = None, area: "raw.base.MediaArea" = None, peer: "raw.base.InputPeer" = None) -> None:
self.offset = offset # string
self.limit = limit # int
self.hashtag = hashtag # flags.0?string
self.area = area # flags.1?MediaArea
self.peer = peer # flags.2?InputPeer
@staticmethod
def read(b: BytesIO, *args: Any) -> "SearchPosts":
flags = Int.read(b)
hashtag = String.read(b) if flags & (1 << 0) else None
area = TLObject.read(b) if flags & (1 << 1) else None
peer = TLObject.read(b) if flags & (1 << 2) else None
offset = String.read(b)
limit = Int.read(b)
return SearchPosts(offset=offset, limit=limit, hashtag=hashtag, area=area, peer=peer)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.hashtag is not None else 0
flags |= (1 << 1) if self.area is not None else 0
flags |= (1 << 2) if self.peer is not None else 0
b.write(Int(flags))
if self.hashtag is not None:
b.write(String(self.hashtag))
if self.area is not None:
b.write(self.area.write())
if self.peer is not None:
b.write(self.peer.write())
b.write(String(self.offset))
b.write(Int(self.limit))
return b.getvalue()