MTPyroger/pyrogram/client/methods/messages/get_history.py

88 lines
3.3 KiB
Python
Raw Normal View History

2018-05-09 11:06:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2018 Dan Tès <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 typing import Union
import pyrogram
2018-05-09 18:27:29 +00:00
from pyrogram.api import functions
2018-12-17 13:18:41 +00:00
from ...ext import BaseClient
2018-05-09 11:06:32 +00:00
class GetHistory(BaseClient):
def get_history(self,
chat_id: Union[int, str],
limit: int = 100,
2018-07-02 00:48:58 +00:00
offset: int = 0,
2018-05-09 11:06:32 +00:00
offset_id: int = 0,
offset_date: int = 0,
2018-12-27 22:55:56 +00:00
reversed: bool = False):
"""Use this method to retrieve the history of a chat.
You can get up to 100 messages at once.
Args:
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 messages to be retrieved.
By default, the first 100 messages are returned.
2018-12-27 22:55:56 +00:00
offset (``int``, *optional*)
Sequential number of the first message to be returned. Defaults to 0 (most recent message).
Negative values are also accepted and become useful in case you set offset_id or offset_date.
offset_id (``int``, *optional*):
Pass a message identifier as offset to retrieve only older messages starting from that message.
offset_date (``int``, *optional*):
Pass a date in Unix time as offset to retrieve only older messages starting from that date.
2018-12-27 22:55:56 +00:00
reversed (``bool``, *optional*):
Pass True to retrieve the messages in reversed order (from older to most recent).
Returns:
On success, a :obj:`Messages <pyrogram.Messages>` object is returned.
Raises:
2018-11-03 09:49:11 +00:00
:class:`Error <pyrogram.Error>` in case of a Telegram RPC error.
"""
2018-12-27 22:55:56 +00:00
messages = pyrogram.Messages._parse(
2018-12-17 13:18:41 +00:00
self,
self.send(
functions.messages.GetHistory(
peer=self.resolve_peer(chat_id),
offset_id=offset_id,
offset_date=offset_date,
2018-12-27 22:55:56 +00:00
add_offset=offset - (limit if reversed else 0),
2018-12-17 13:18:41 +00:00
limit=limit,
max_id=0,
min_id=0,
hash=0
)
2018-05-09 18:27:29 +00:00
)
)
2018-12-27 22:55:56 +00:00
if reversed:
messages.messages.reverse()
return messages