mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
65 lines
2.3 KiB
Python
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 GetUserStories:
|
|
async def get_user_stories(
|
|
self: "pyrogram.Client",
|
|
user_id: Union[int, str]
|
|
) -> Optional[AsyncGenerator["types.Story", None]]:
|
|
"""Get all active stories from an user by using user identifiers.
|
|
|
|
.. include:: /_includes/usable-by/users.rst
|
|
|
|
Parameters:
|
|
user_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target user.
|
|
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
|
|
async for story in app.get_user_stories(user_id):
|
|
print(story)
|
|
|
|
Raises:
|
|
ValueError: In case of invalid arguments.
|
|
"""
|
|
|
|
peer = await self.resolve_peer(user_id)
|
|
|
|
|
|
rpc = raw.functions.stories.GetUserStories(user_id=peer)
|
|
|
|
r = await self.invoke(rpc, sleep_threshold=-1)
|
|
|
|
for story in r.stories.stories:
|
|
yield await types.Story._parse(self, story, user_id)
|