mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
680918eed7
Co-authored-by: Shrimadhav U K <SpEcHiDe@users.noreply.github.com> Signed-off-by: wulan17 <wulan17@nusantararom.org>
105 lines
3.9 KiB
Python
105 lines
3.9 KiB
Python
# 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 typing import Optional, Union, List
|
|
|
|
import pyrogram
|
|
from pyrogram import raw, types, enums, utils
|
|
|
|
|
|
class SendGift:
|
|
async def send_gift(
|
|
self: "pyrogram.Client",
|
|
user_id: Union[int, str],
|
|
gift_id: int,
|
|
text: Optional[str] = None,
|
|
parse_mode: Optional["enums.ParseMode"] = None,
|
|
entities: Optional[List["types.MessageEntity"]] = None,
|
|
is_private: Optional[bool] = None,
|
|
) -> bool:
|
|
"""Sends a gift to another user.
|
|
|
|
.. include:: /_includes/usable-by/users.rst
|
|
|
|
Parameters:
|
|
user_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the user that will receive the gift.
|
|
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).
|
|
|
|
gift_id (``int``):
|
|
Unique identifier of the gift to send.
|
|
|
|
text (``str``, *optional*):
|
|
Text of the message to be sent. 0-``gift_text_length_max`` characters.
|
|
|
|
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
You can combine both syntaxes together.
|
|
|
|
entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*):
|
|
List of special entities that appear in message text, which can be specified instead of *parse_mode*.
|
|
Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.
|
|
|
|
is_private (``bool``, *optional*):
|
|
Pass True to show the current user as sender and gift text only to the gift receiver; otherwise, everyone will be able to see them.
|
|
|
|
Returns:
|
|
``bool``: On success, True is returned.
|
|
|
|
Raises:
|
|
RPCError: In case of a Telegram RPC error.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Send gift
|
|
app.send_gift(user_id=user_id, gift_id=123)
|
|
|
|
"""
|
|
peer = await self.resolve_peer(user_id)
|
|
|
|
if not isinstance(peer, (raw.types.InputPeerUser, raw.types.InputPeerSelf)):
|
|
raise ValueError("user_id must belong to a user.")
|
|
|
|
text, entities = (await utils.parse_text_entities(self, text, parse_mode, entities)).values()
|
|
|
|
invoice = raw.types.InputInvoiceStarGift(
|
|
user_id=peer,
|
|
gift_id=gift_id,
|
|
hide_name=is_private,
|
|
message=raw.types.TextWithEntities(
|
|
text=text, entities=entities or []
|
|
) if text else None
|
|
)
|
|
|
|
form = await self.invoke(
|
|
raw.functions.payments.GetPaymentForm(
|
|
invoice=invoice
|
|
)
|
|
)
|
|
|
|
await self.invoke(
|
|
raw.functions.payments.SendStarsForm(
|
|
form_id=form.form_id,
|
|
invoice=invoice
|
|
)
|
|
)
|
|
|
|
return True
|