org.telegram.telegrambots.api.methods.games

Class SetGameScore

java.lang.Object

org.telegram.telegrambots.api.methods.PartialBotApiMethod<T>

org.telegram.telegrambots.api.methods.BotApiMethod<Serializable>

org.telegram.telegrambots.api.methods.games.SetGameScore

All Implemented Interfaces:

Validable

public class SetGameScore
extends BotApiMethod<Serializable>

Version:

2.4 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.

Author:

Ruben Bermudez

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Fields inherited from class org.telegram.telegrambots.api.methods.BotApiMethod

METHOD_FIELD

Fields inherited from class org.telegram.telegrambots.api.methods.PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
SetGameScore()

Method Summary

Modifier and Type	Method and Description
Serializable	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
String	getChatId()
Boolean	getDisableEditMessage()
Boolean	getForce()
String	getInlineMessageId()
Integer	getMessageId()
String	getMethod() Getter for method path (that is the same as method name)
Integer	getScore()
Integer	getUserId()
SetGameScore	setChatId(Long chatId)
SetGameScore	setChatId(String chatId)
SetGameScore	setDisableEditMessage(Boolean disableEditMessage)
SetGameScore	setForce(Boolean force)
SetGameScore	setInlineMessageId(String inlineMessageId)
SetGameScore	setMessageId(Integer messageId)
SetGameScore	setScore(Integer score)
SetGameScore	setUserId(Integer userId)
String	toString()
void	validate() Validates that mandatory fields are filled and optional objects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

SetGameScore

public SetGameScore()

Method Detail

getChatId

public String getChatId()

getMessageId

public Integer getMessageId()

getInlineMessageId

public String getInlineMessageId()

getDisableEditMessage

public Boolean getDisableEditMessage()

getUserId

public Integer getUserId()

getScore

public Integer getScore()

getForce

public Boolean getForce()

setChatId

public SetGameScore setChatId(String chatId)

setChatId

public SetGameScore setChatId(Long chatId)

setMessageId

public SetGameScore setMessageId(Integer messageId)

setInlineMessageId

public SetGameScore setInlineMessageId(String inlineMessageId)

setDisableEditMessage

public SetGameScore setDisableEditMessage(Boolean disableEditMessage)

setUserId

public SetGameScore setUserId(Integer userId)

setScore

public SetGameScore setScore(Integer score)

setForce

public SetGameScore setForce(Boolean force)

getMethod

public String getMethod()

Description copied from class: BotApiMethod

Getter for method path (that is the same as method name)

Specified by:

getMethod in class BotApiMethod<Serializable>

Returns:

Method path

deserializeResponse

public Serializable deserializeResponse(String answer)
                                 throws TelegramApiRequestException

Description copied from class: PartialBotApiMethod

Deserialize a json answer to the response type to a method

Specified by:

deserializeResponse in class PartialBotApiMethod<Serializable>

Parameters:

answer - Json answer received

Returns:

Answer for the method

Throws:

TelegramApiRequestException

validate

public void validate()
              throws TelegramApiValidationException

Description copied from interface: Validable

Validates that mandatory fields are filled and optional objects

Throws:

TelegramApiValidationException - If any mandatory field is empty

toString

public String toString()

Overrides:

toString in class Object