setGameScore

suspend fun TelegramBotApiClient.setGameScore(requestBody: SetGameScoreRequest): TelegramResponse<Message>
Content copied to clipboard

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

suspend fun TelegramBotApiClient.setGameScore(userId: Int, score: Int, force: Boolean = false, disableEditMessage: Boolean = false, chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null): TelegramResponse<Message>
Content copied to clipboard

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Parameters

userId

User identifier

score

New score, must be non-negative

force

Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters

disableEditMessage

Pass True, if the game message should not be automatically edited to include the current scoreboard

chatId

Required if inline_message_id is not specified. Unique identifier for the target chat

messageId

Required if inline_message_id is not specified. Identifier of the sent message

inlineMessageId

Required if chat_id and message_id are not specified. Identifier of the inline message