Package com.treescrub.spedran.requests.builders

Class LeaderboardRequest

java.lang.Object

com.treescrub.spedran.SingleResourceRequest<Leaderboard>

com.treescrub.spedran.requests.builders.LeaderboardRequest

public class LeaderboardRequest
extends SingleResourceRequest<Leaderboard>

A request builder to get a specific Leaderboard.

Constructor Summary

Constructors

Constructor	Description
LeaderboardRequest(Game game, Category category)
LeaderboardRequest(Game game, Category category, Level level)
LeaderboardRequest(String game, String category)
LeaderboardRequest(String game, String category, String level)

Method Summary

Modifier and Type	Method	Description
LeaderboardRequest	beforeDate(String date)	Restricts the results to runs done before or on this date.
LeaderboardRequest	onlyEmulators()	Restricts the results to runs done on an emulator.
LeaderboardRequest	onlyRealDevices()	Restricts the results to runs done on hardware (that is, not an emulator).
LeaderboardRequest	platform(Platform platform)	Restricts the results to runs done on the given Platform.
LeaderboardRequest	platform(String id)	Restricts the results to runs done on the given Platform.
LeaderboardRequest	region(Region region)	Restricts the results to runs done on the given Region.
LeaderboardRequest	region(String id)	Restricts the results to runs done on the given Region.
LeaderboardRequest	timing(TimingType timingType)	Sorts the leaderboard by the timing type.
LeaderboardRequest	top(int topPlaces)
LeaderboardRequest	variable(Variable variable, String valueId)	Restricts the results to runs with the given Variable set to the given variable value.
LeaderboardRequest	variable(String id, String value)	Restricts the results to runs with the given Variable set to the given variable value.
LeaderboardRequest	videosOnly()	Restricts the results to runs with videos specified.

Methods inherited from class com.treescrub.spedran.SingleResourceRequest

complete

Methods inherited from class java.lang.Object

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

Constructor Detail

LeaderboardRequest

public LeaderboardRequest(String game,
                          String category)

LeaderboardRequest

public LeaderboardRequest(String game,
                          String category,
                          String level)

LeaderboardRequest

public LeaderboardRequest(Game game,
                          Category category)

LeaderboardRequest

public LeaderboardRequest(Game game,
                          Category category,
                          Level level)

Method Detail

top

public LeaderboardRequest top(int topPlaces)

platform

public LeaderboardRequest platform(String id)

Restricts the results to runs done on the given Platform.

Parameters:

id - the platform ID

Returns:

this LeaderboardRequest builder

platform

public LeaderboardRequest platform(Platform platform)

Restricts the results to runs done on the given Platform.

Parameters:

platform - the platform

Returns:

this LeaderboardRequest builder

region

public LeaderboardRequest region(String id)

Restricts the results to runs done on the given Region.

Parameters:

id - the region ID

Returns:

this LeaderboardRequest builder

region

public LeaderboardRequest region(Region region)

Restricts the results to runs done on the given Region.

Parameters:

region - the region

Returns:

this LeaderboardRequest builder

onlyEmulators

public LeaderboardRequest onlyEmulators()

Restricts the results to runs done on an emulator.

Returns:

this LeaderboardRequest builder

onlyRealDevices

public LeaderboardRequest onlyRealDevices()

Restricts the results to runs done on hardware (that is, not an emulator).

Returns:

this LeaderboardRequest builder

videosOnly

public LeaderboardRequest videosOnly()

Restricts the results to runs with videos specified.

Returns:

this LeaderboardRequest builder

timing

public LeaderboardRequest timing(TimingType timingType)

Sorts the leaderboard by the timing type.

Parameters:

timingType - the type to sort by

Returns:

this LeaderboardRequest builder

beforeDate

public LeaderboardRequest beforeDate(String date)

Restricts the results to runs done before or on this date.

Parameters:

date - the date in ISO 8601 format

Returns:

this LeaderboardRequest builder

variable

public LeaderboardRequest variable(String id,
                                   String value)

Restricts the results to runs with the given Variable set to the given variable value.

Parameters:

id - the variable ID

value - the variable value ID

Returns:

this LeaderboardRequest builder

variable

public LeaderboardRequest variable(Variable variable,
                                   String valueId)

Restricts the results to runs with the given Variable set to the given variable value.

Parameters:

variable - the variable

valueId - the variable value ID

Returns:

this LeaderboardRequest builder