# 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 typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime, timedelta
class SendDice:
async def send_dice(
self: pyrogram.Client,
chat_id: int | str,
emoji: str = "🎲",
disable_notification: bool | None = None,
reply_to_message_id: int | None = None,
reply_to_chat_id: int | str | None = None,
schedule_date: datetime | timedelta | None = None,
protect_content: bool | None = None,
quote_text: str | None = None,
quote_entities: list[types.MessageEntity] | None = None,
reply_parameters: types.ReplyParameters | None = None,
message_thread_id: int | None = None,
effect_id: int | None = None,
repeat_period: int | None = None,
business_connection_id: str | None = None,
allow_paid_broadcast: bool | None = None,
paid_message_star_count: int | None = None,
suggested_post_parameters: types.SuggestedPostParameters | None = None,
direct_messages_topic_id: int | None = None,
show_caption_above_media: bool | None = None,
background: bool | None = None,
clear_draft: bool | None = None,
update_stickersets_order: bool | None = None,
send_as: int | str | None = None,
quick_reply_shortcut: int | None = None,
reply_markup: types.InlineKeyboardMarkup
| types.ReplyKeyboardMarkup
| types.ReplyKeyboardRemove
| types.ForceReply
| None = None,
) -> types.Message | None:
"""Send a dice with a random value from 1 to 6.
.. include:: /_includes/usable-by/users-bots.rst
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 "🎰".
Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and
values 1-64 for "🎰".
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 (:py:obj:`~datetime.datetime`, *optional*):
Date when the message will be automatically sent.
protect_content (``bool``, *optional*):
Protects the contents of the sent message from forwarding and saving.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.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.
reply_to_chat_id (``int`` | ``str``, *optional*):
Unique identifier for the chat to which the replied message belongs.
Only applicable in combination with *reply_to_message_id*.
quote_text (``str``, *optional*):
Text of the quote to reply to.
quote_entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in *quote_text*, which can be specified instead of *parse_mode*.
reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*):
Describes reply parameters for the message that is being sent.
message_thread_id (``int``, *optional*):
Unique identifier for a message thread in a forum topic.
effect_id (``int``, *optional*):
Unique identifier of the effect to apply to the message.
repeat_period (``int``, *optional*):
New period in seconds for the message to be sent repeatedly.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection.
allow_paid_broadcast (``bool``, *optional*):
If True, you will be allowed to send up to 1000 messages per second.
Ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message.
The relevant Stars will be withdrawn from the bot's balance.
For bots only.
paid_message_star_count (``int``, *optional*):
The number of Telegram Stars the user agreed to pay to send the messages.
suggested_post_parameters (:obj:`~pyrogram.types.SuggestedPostParameters`, *optional*):
Parameters of the suggested post.
direct_messages_topic_id (``int``, *optional*):
Unique identifier of the topic in a channel direct messages chat administered by the current user.
For directs only only.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media.
background (``bool``, *optional*):
Send the message in background.
clear_draft (``bool``, *optional*):
Clear the draft of the chat.
update_stickersets_order (``bool``, *optional*):
Move the sticker set to the top of the list.
send_as (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the chat or channel to send the message as.
quick_reply_shortcut (``int``, *optional*):
Unique identifier of the quick reply shortcut the message belongs to.
Returns:
:obj:`~pyrogram.types.Message`: On success, the sent dice message is returned.
Example:
.. code-block:: python
# Send a dice
await app.send_dice(chat_id)
# Send a dart
await app.send_dice(chat_id, "🎯")
# Send a basketball
await app.send_dice(chat_id, "🏀")
"""
if reply_parameters is None:
if reply_to_message_id is not None:
reply_parameters = types.ReplyParameters(
message_id=reply_to_message_id,
chat_id=reply_to_chat_id,
quote=quote_text,
quote_entities=quote_entities,
)
elif quote_text is not None:
reply_parameters = types.ReplyParameters(
message_id=None,
chat_id=reply_to_chat_id,
quote=quote_text,
quote_entities=quote_entities,
)
r = await self.invoke(
raw.functions.messages.SendMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaDice(emoticon=emoji),
silent=disable_notification if disable_notification is not None else None,
reply_to=await utils.get_reply_to(
self,
reply_parameters,
message_thread_id,
direct_messages_topic_id=direct_messages_topic_id,
),
random_id=self.rnd_id(),
schedule_date=utils.datetime_to_timestamp(schedule_date),
noforwards=protect_content,
effect=effect_id,
schedule_repeat_period=repeat_period,
allow_paid_floodskip=allow_paid_broadcast
if allow_paid_broadcast is not None
else None,
allow_paid_stars=paid_message_star_count
if paid_message_star_count is not None
else None,
suggested_post=suggested_post_parameters.write()
if suggested_post_parameters
else None,
invert_media=show_caption_above_media
if show_caption_above_media is not None
else None,
background=background,
clear_draft=clear_draft,
update_stickersets_order=update_stickersets_order,
send_as=await self.resolve_peer(send_as) if send_as is not None else None,
quick_reply_shortcut=raw.types.InputQuickReplyShortcutId(
shortcut_id=quick_reply_shortcut
)
if quick_reply_shortcut is not None
else None,
reply_markup=await reply_markup.write(self) if reply_markup else None,
entities=None,
message="",
),
sleep_threshold=60,
business_connection_id=business_connection_id,
)
for i in r.updates:
if isinstance(
i,
(
raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateNewScheduledMessage,
raw.types.UpdateBotNewBusinessMessage,
),
):
return await types.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, raw.types.UpdateNewScheduledMessage),
business_connection_id=getattr(i, "connection_id", None),
raw_reply_to_message=getattr(i, "reply_to_message", None),
)