mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
74 lines
2.5 KiB
Python
74 lines
2.5 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, Optional
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
class GetUserStoriesHistory:
|
|
async def get_stories_history(
|
|
self: "pyrogram.Client",
|
|
channel_id: int = None,
|
|
limit: int = 0,
|
|
offset_id: int = 0
|
|
) -> Optional[AsyncGenerator["types.Story", None]]:
|
|
"""Get stories history.
|
|
|
|
.. include:: /_includes/usable-by/users.rst
|
|
|
|
Parameters:
|
|
channel_id (``int``, *optional*):
|
|
Unique identifier (int) of the target channel.
|
|
|
|
limit (``int``, *optional*):
|
|
Limits the number of stories to be retrieved.
|
|
By default, no limit is applied and all stories are returned.
|
|
|
|
offset_id (``int``, *optional*):
|
|
Identifier of the first story to be returned.
|
|
|
|
Returns:
|
|
``Generator``: On success, a generator yielding :obj:`~pyrogram.types.Story` objects is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Get story history
|
|
async for story in app.get_stories_history():
|
|
print(story)
|
|
|
|
Raises:
|
|
ValueError: In case of invalid arguments.
|
|
"""
|
|
|
|
if channel_id:
|
|
peer = await self.resolve_peer(channel_id)
|
|
else:
|
|
peer = await self.resolve_peer("me")
|
|
|
|
rpc = raw.functions.stories.GetStoriesArchive(peer=peer, offset_id=offset_id, limit=limit)
|
|
|
|
r = await self.invoke(rpc, sleep_threshold=-1)
|
|
|
|
for story in r.stories:
|
|
yield await types.Story._parse(self, story, peer)
|