Source code for pyrogram.methods.messages.get_recent_locations
# 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
class GetRecentLocations:
async def get_recent_locations(
self: pyrogram.Client,
chat_id: int | str,
limit: int = 100,
hash: int = 0,
) -> raw.base.messages.Messages:
"""Get recently shared live locations in a chat.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
limit (``int``, *optional*):
Maximum number of results. Defaults to 100.
hash (``int``, *optional*):
Hash for caching.
Returns:
:obj:`~pyrogram.raw.base.messages.Messages`: The messages with recent locations.
Example:
.. code-block:: python
locations = await app.get_recent_locations(chat_id)
"""
peer = await self.resolve_peer(chat_id)
return await self.invoke(
raw.functions.messages.GetRecentLocations(peer=peer, limit=limit, hash=hash)
)