107 lines
4.1 KiB
Python
107 lines
4.1 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2020 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 Union
|
|
|
|
import pyrogram
|
|
from pyrogram.api import functions, types
|
|
from pyrogram.client.ext import BaseClient
|
|
|
|
|
|
class SendDice(BaseClient):
|
|
def send_dice(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
emoji: str = "🎲",
|
|
disable_notification: bool = None,
|
|
reply_to_message_id: int = None,
|
|
schedule_date: int = None,
|
|
reply_markup: Union[
|
|
"pyrogram.InlineKeyboardMarkup",
|
|
"pyrogram.ReplyKeyboardMarkup",
|
|
"pyrogram.ReplyKeyboardRemove",
|
|
"pyrogram.ForceReply"
|
|
] = None
|
|
) -> Union["pyrogram.Message", None]:
|
|
"""Send a dice with a random value from 1 to 6.
|
|
|
|
Parameters:
|
|
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).
|
|
|
|
emoji (``str``, *optional*):
|
|
Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀" or "⚽️".
|
|
Defaults to "🎲".
|
|
|
|
disable_notification (``bool``, *optional*):
|
|
Sends the message silently.
|
|
Users will receive a notification with no sound.
|
|
|
|
reply_to_message_id (``int``, *optional*):
|
|
If the message is a reply, ID of the original message.
|
|
|
|
schedule_date (``int``, *optional*):
|
|
Date when the message will be automatically sent. Unix time.
|
|
|
|
reply_markup (:obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply`, *optional*):
|
|
Additional interface options. An object for an inline keyboard, custom reply keyboard,
|
|
instructions to remove reply keyboard or to force a reply from the user.
|
|
|
|
Returns:
|
|
:obj:`Message`: On success, the sent dice message is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Send a dice
|
|
app.send_dice("pyrogramlounge")
|
|
|
|
# Send a dart
|
|
app.send_dice("pyrogramlounge", "🎯")
|
|
|
|
# Send a basketball
|
|
app.send_dice("pyrogramlounge", "🏀")
|
|
"""
|
|
|
|
r = self.send(
|
|
functions.messages.SendMedia(
|
|
peer=self.resolve_peer(chat_id),
|
|
media=types.InputMediaDice(emoticon=emoji),
|
|
silent=disable_notification or None,
|
|
reply_to_msg_id=reply_to_message_id,
|
|
random_id=self.rnd_id(),
|
|
schedule_date=schedule_date,
|
|
reply_markup=reply_markup.write() if reply_markup else None,
|
|
message=""
|
|
)
|
|
)
|
|
|
|
for i in r.updates:
|
|
if isinstance(
|
|
i,
|
|
(types.UpdateNewMessage, types.UpdateNewChannelMessage, types.UpdateNewScheduledMessage)
|
|
):
|
|
return pyrogram.Message._parse(
|
|
self, i.message,
|
|
{i.id: i for i in r.users},
|
|
{i.id: i for i in r.chats},
|
|
is_scheduled=isinstance(i, types.UpdateNewScheduledMessage)
|
|
)
|