Source code for pyrogram.methods.stories.get_archived_stories
# 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 __future__ import annotations
import pyrogram
from pyrogram import raw, types
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import AsyncGenerator
class GetArchivedStories:
async def get_archived_stories(
self: pyrogram.Client, chat_id: int | str, limit: int = 0, offset_id: int = 0
) -> AsyncGenerator[types.Story, None]:
"""Get all archived stories from a chat by using chat identifier.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
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``: A generator yielding :obj:`~pyrogram.types.Story` objects.
Example:
.. code-block:: python
# Get archived stories from specific chat
async for story in app.get_archived_stories(chat_id):
print(story)
"""
current = 0
total = abs(limit) or (1 << 31)
limit = min(100, total)
while True:
peer = await self.resolve_peer(chat_id)
r = await self.invoke(
raw.functions.stories.GetStoriesArchive(peer=peer, offset_id=offset_id, limit=limit)
)
if not r.stories:
return
last = r.stories[-1]
offset_id = last.id
users = {i.id: i for i in r.users}
chats = {i.id: i for i in r.chats}
for story in r.stories:
yield await types.Story._parse(self, story, peer, users, chats)
current += 1
if current >= total:
return