io.github.ageofwar.telejam.methods

Class GetGameHighScores

java.lang.Object

io.github.ageofwar.telejam.methods.GetGameHighScores

All Implemented Interfaces:

TelegramMethod<GameHighScore[]>

public class GetGameHighScores
extends java.lang.Object
implements TelegramMethod<GameHighScore[]>

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.

This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
GetGameHighScores()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the method.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Return the parameters of the method.
java.lang.Class<? extends GameHighScore[]>	getReturnType() Returns the return type of the method.
GetGameHighScores	inlineMessage(java.lang.String inlineMessageId)
GetGameHighScores	message(java.lang.Long messageId)
GetGameHighScores	message(Message message)
GetGameHighScores	user(java.lang.Long userId)
GetGameHighScores	user(User user)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.ageofwar.telejam.methods.TelegramMethod

getFiles

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

GetGameHighScores

public GetGameHighScores()

Method Detail

user

public GetGameHighScores user(java.lang.Long userId)

user

public GetGameHighScores user(User user)

message

public GetGameHighScores message(java.lang.Long messageId)

message

public GetGameHighScores message(Message message)

inlineMessage

public GetGameHighScores inlineMessage(java.lang.String inlineMessageId)

getName

public java.lang.String getName()

Description copied from interface: TelegramMethod

Returns the name of the method.

Specified by:

getName in interface TelegramMethod<GameHighScore[]>

Returns:

the name of the method

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Description copied from interface: TelegramMethod

Return the parameters of the method.

Specified by:

getParameters in interface TelegramMethod<GameHighScore[]>

Returns:

the parameters of the method

getReturnType

public java.lang.Class<? extends GameHighScore[]> getReturnType()

Description copied from interface: TelegramMethod

Returns the return type of the method.

Specified by:

getReturnType in interface TelegramMethod<GameHighScore[]>

Returns:

the return type of the method