mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
fea1b7b0a3
* Reworked request builder * Added more default values * Update tests * Fixed timestamp * Fixed Py3.8 support * Describe changes
32 lines
1.5 KiB
Python
32 lines
1.5 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Optional, Union
|
|
|
|
from ..types import Message
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class SetGameScore(TelegramMethod[Union[Message, bool]]):
|
|
"""
|
|
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is :code:`False`.
|
|
|
|
Source: https://core.telegram.org/bots/api#setgamescore
|
|
"""
|
|
|
|
__returning__ = Union[Message, bool]
|
|
__api_method__ = "setGameScore"
|
|
|
|
user_id: int
|
|
"""User identifier"""
|
|
score: int
|
|
"""New score, must be non-negative"""
|
|
force: Optional[bool] = None
|
|
"""Pass :code:`True` if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"""
|
|
disable_edit_message: Optional[bool] = None
|
|
"""Pass :code:`True` if the game message should not be automatically edited to include the current scoreboard"""
|
|
chat_id: Optional[int] = None
|
|
"""Required if *inline_message_id* is not specified. Unique identifier for the target chat"""
|
|
message_id: Optional[int] = None
|
|
"""Required if *inline_message_id* is not specified. Identifier of the sent message"""
|
|
inline_message_id: Optional[str] = None
|
|
"""Required if *chat_id* and *message_id* are not specified. Identifier of the inline message"""
|