Package org.telegram.telegrambots.meta.api.methods.games

Class GetGameHighScores

Object

PartialBotApiMethod<T>

BotApiMethod<ArrayList<GameHighScore>>

GetGameHighScores

All Implemented Interfaces:

Validable

public class GetGameHighScores
extends BotApiMethod<ArrayList<GameHighScore>>

Version:

2.4 Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.

Author:

Ruben Bermudez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetGameHighScores.GetGameHighScoresBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Fields inherited from class BotApiMethod

METHOD_FIELD

Fields inherited from class PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor	Description
GetGameHighScores()

Method Summary

Modifier and Type	Method	Description
ArrayList<GameHighScore>	deserializeResponse(String answer)	Deserialize a json answer to the response type to a method
String	getMethod()	Getter for method path (that is the same as method name)
void	setChatId(Long chatId)
void	validate()	Validates that mandatory fields are filled and optional objects

Methods inherited from class PartialBotApiMethod

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

Constructor Details

GetGameHighScores

public GetGameHighScores()

Method Details

setChatId

public void setChatId(Long chatId)

getMethod

public String getMethod()

Description copied from class: PartialBotApiMethod

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

Specified by:

getMethod in class PartialBotApiMethod<ArrayList<GameHighScore>>

Returns:

Method path

deserializeResponse

public ArrayList<GameHighScore> 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<ArrayList<GameHighScore>>

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