pyrofork/pyrogram/methods/users/get_peer_stories.py
wulan17 b345bf8876
Pyrofork: Update some methods and types to layer 164
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2023-09-22 16:33:52 +07:00

65 lines
2.3 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# 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 logging
from typing import AsyncGenerator, Union, Optional
import pyrogram
from pyrogram import raw
from pyrogram import types
log = logging.getLogger(__name__)
class GetPeerStories:
async def get_peer_stories(
self: "pyrogram.Client",
from_id: Union[int, str]
) -> Optional[AsyncGenerator["types.Story", None]]:
"""Get all active stories from an user/channel by using user identifiers.
.. include:: /_includes/usable-by/users.rst
Parameters:
from_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target user/channel.
For your personal story you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
Returns:
``Generator``: On success, a generator yielding :obj:`~pyrogram.types.Story` objects is returned.
Example:
.. code-block:: python
# Get all active story from spesific user/channel
async for story in app.get_peer_stories(from_id):
print(story)
Raises:
ValueError: In case of invalid arguments.
"""
peer = await self.resolve_peer(from_id)
rpc = raw.functions.stories.GetPeerStories(peer=peer)
r = await self.invoke(rpc, sleep_threshold=-1)
for story in r.stories.stories:
yield await types.Story._parse(self, story, peer)