SetGameScoreRequest

data class SetGameScoreRequest(userId: Int, score: Int, force: Boolean, disableEditMessage: Boolean, chatId: Int?, messageId: Int?, inlineMessageId: String?)

Request body for setGameScore

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

Constructors

SetGameScoreRequest
Link copied to clipboard
common
fun SetGameScoreRequest(userId: Int, score: Int, force: Boolean = false, disableEditMessage: Boolean = false, chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null)
User identifier

Functions

component1
Link copied to clipboard
common
operator fun component1(): Int
component2
Link copied to clipboard
common
operator fun component2(): Int
component3
Link copied to clipboard
common
operator fun component3(): Boolean
component4
Link copied to clipboard
common
operator fun component4(): Boolean
component5
Link copied to clipboard
common
operator fun component5(): Int?
component6
Link copied to clipboard
common
operator fun component6(): Int?
component7
Link copied to clipboard
common
operator fun component7(): String?
copy
Link copied to clipboard
common
fun copy(userId: Int, score: Int, force: Boolean = false, disableEditMessage: Boolean = false, chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null): SetGameScoreRequest
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

chatId
Link copied to clipboard
common
val chatId: Int? = null
Required if inline_message_id is not specified.
disableEditMessage
Link copied to clipboard
common
val disableEditMessage: Boolean = false
Pass True, if the game message should not be automatically edited to include the current scoreboard
force
Link copied to clipboard
common
val force: Boolean = false
Pass True, if the high score is allowed to decrease.
inlineMessageId
Link copied to clipboard
common
val inlineMessageId: String? = null
Required if chat_id and message_id are not specified.
messageId
Link copied to clipboard
common
val messageId: Int? = null
Required if inline_message_id is not specified.
score
Link copied to clipboard
common
val score: Int
New score, must be non-negative
userId
Link copied to clipboard
common
val userId: Int
User identifier