99 lines
3.8 KiB
Python
99 lines
3.8 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 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
|
|
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class SetGameScore(Scaffold):
|
|
async def set_game_score(
|
|
self,
|
|
user_id: Union[int, str],
|
|
score: int,
|
|
force: bool = None,
|
|
disable_edit_message: bool = None,
|
|
chat_id: Union[int, str] = None,
|
|
message_id: int = None
|
|
) -> Union["types.Message", bool]:
|
|
# inline_message_id: str = None): TODO Add inline_message_id
|
|
"""Set the score of the specified user in a game.
|
|
|
|
Parameters:
|
|
user_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).
|
|
|
|
score (``int``):
|
|
New score, must be non-negative.
|
|
|
|
force (``bool``, *optional*):
|
|
Pass True, if the high score is allowed to decrease.
|
|
This can be useful when fixing mistakes or banning cheaters.
|
|
|
|
disable_edit_message (``bool``, *optional*):
|
|
Pass True, if the game message should not be automatically edited to include the current scoreboard.
|
|
|
|
chat_id (``int`` | ``str``, *optional*):
|
|
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).
|
|
Required if inline_message_id is not specified.
|
|
|
|
message_id (``int``, *optional*):
|
|
Identifier of the sent message.
|
|
Required if inline_message_id is not specified.
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.Message` | ``bool``: On success, if the message was sent by the bot, the edited
|
|
message is returned, True otherwise.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Set new score
|
|
app.set_game_score(user_id, 1000)
|
|
|
|
# Force set new score
|
|
app.set_game_score(user_id, 25, force=True)
|
|
"""
|
|
r = await self.send(
|
|
raw.functions.messages.SetGameScore(
|
|
peer=await self.resolve_peer(chat_id),
|
|
score=score,
|
|
id=message_id,
|
|
user_id=await self.resolve_peer(user_id),
|
|
force=force or None,
|
|
edit_message=not disable_edit_message or None
|
|
)
|
|
)
|
|
|
|
for i in r.updates:
|
|
if isinstance(i, (raw.types.UpdateEditMessage,
|
|
raw.types.UpdateEditChannelMessage)):
|
|
return await types.Message._parse(
|
|
self, i.message,
|
|
{i.id: i for i in r.users},
|
|
{i.id: i for i in r.chats}
|
|
)
|
|
|
|
return True
|