pyrofork/pyrogram/methods/payments/hide_gift.py
KurimuzonAkuma 7662cc164f Pyrofork: Sync Star Gift With Layer 198
Signed-off-by: Yasir <git@yasir.id>
2025-02-03 04:44:29 +00:00

55 lines
1.7 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# 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 pyrogram
from pyrogram import raw
class HideGift:
async def hide_gift(
self: "pyrogram.Client",
message_id: int
) -> bool:
"""Hide the star gift from your profile.
.. include:: /_includes/usable-by/users.rst
Parameters:
message_id (``int``):
Unique message identifier of star gift.
Returns:
``bool``: On success, True is returned.
Example:
.. code-block:: python
# Hide gift
app.hide_gift(message_id=123)
"""
r = await self.invoke(
raw.functions.payments.SaveStarGift(
stargift=raw.types.InputSavedStarGiftUser(
msg_id=message_id
),
unsave=True
)
)
return r