# 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, utils
from .inline_session import invoke_inline
class StopMessageLiveLocation:
async def stop_message_live_location(
self: pyrogram.Client,
chat_id: int | str | None = None,
message_id: int | None = None,
inline_message_id: str | None = None,
reply_markup: types.InlineKeyboardMarkup | type[object] | None = object,
business_connection_id: str | None = None,
) -> types.Message | bool:
"""Stop updating a live location message before its ``live_period`` expires.
Either ``chat_id`` + ``message_id`` **or** ``inline_message_id`` must be provided.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the target chat.
message_id (``int``, *optional*):
Identifier of the live location message to stop.
inline_message_id (``str``, *optional*):
Identifier of the inline live location message to stop.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*):
A new inline keyboard to replace the current one.
Pass None to remove the existing reply markup.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection.
Returns:
:obj:`~pyrogram.types.Message` | ``bool``: On success, the edited Message is returned.
For inline messages, True is returned.
Example:
.. code-block:: python
# Stop a live location
await app.stop_message_live_location(chat_id, message_id)
"""
if inline_message_id is None:
if chat_id is None or message_id is None:
raise ValueError(
"Either (chat_id, message_id) or inline_message_id must be provided"
)
peer = await self.resolve_peer(chat_id)
r = await self.invoke(
raw.functions.messages.EditMessage(
peer=peer,
id=message_id,
media=raw.types.InputMediaGeoLive(
geo_point=raw.types.InputGeoPointEmpty(),
stopped=True,
),
reply_markup=await utils.write_edit_reply_markup(
self, reply_markup=reply_markup
),
),
business_connection_id=business_connection_id,
)
users = {i.id: i for i in r.users}
chats = {i.id: i for i in r.chats}
for i in r.updates:
if isinstance(i, (raw.types.UpdateEditMessage, raw.types.UpdateEditChannelMessage)):
return await types.Message._parse(self, i.message, users, chats)
return True
else:
unpacked = utils.unpack_inline_message_id(inline_message_id)
dc_id = unpacked.dc_id
return await invoke_inline(
self,
dc_id,
raw.functions.messages.EditInlineBotMessage(
id=unpacked,
media=raw.types.InputMediaGeoLive(
geo_point=raw.types.InputGeoPointEmpty(),
stopped=True,
),
reply_markup=await utils.write_edit_reply_markup(
self, reply_markup=reply_markup
),
),
business_connection_id,
)