Package com.treescrub.spedran.requests.builders.game

Class GameRecordsRequest

java.lang.Object

com.treescrub.spedran.ResourceCollectionRequest<Leaderboard>

com.treescrub.spedran.requests.builders.game.GameRecordsRequest

public class GameRecordsRequest
extends ResourceCollectionRequest<Leaderboard>

A request builder to get records for a given Game.

Constructor Summary

Constructors

Constructor	Description
GameRecordsRequest(Game game)
GameRecordsRequest(String id)

Method Summary

Modifier and Type	Method	Description
GameRecordsRequest	miscellaneous(boolean includeMiscellaneous)	Sets whether miscellaneous categories should be returned.
GameRecordsRequest	scope(String recordsScope)	Sets the scope type.
GameRecordsRequest	skipEmpty(boolean skipEmptyRecords)	Sets whether record entries without any runs should be kept.
GameRecordsRequest	top(int topPlaces)	Sets the number of places to return.

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

complete

Methods inherited from class java.lang.Object

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

Constructor Detail

GameRecordsRequest

public GameRecordsRequest(String id)

GameRecordsRequest

public GameRecordsRequest(Game game)

Method Detail

top

public GameRecordsRequest top(int topPlaces)

Sets the number of places to return.

This will return more than value runs per leaderboard if there are ties.

Parameters:

topPlaces - the top places to filter for, clamped to >= 1

Returns:

this GameRecordsRequest builder

scope

public GameRecordsRequest scope(String recordsScope)

Sets the scope type.

Valid values are: "full-game", "levels", and "all".

Full-game scope returns only full-game categories. Levels scope returns only individual levels. All returns everything and is the default scope.

Parameters:

recordsScope - the scope to get records in

Returns:

this GameRecordsRequest builder

miscellaneous

public GameRecordsRequest miscellaneous(boolean includeMiscellaneous)

Sets whether miscellaneous categories should be returned.

Defaults to true.

Parameters:

includeMiscellaneous - whether to include miscellaneous categories in the results

Returns:

this GameRecordsRequest builder

skipEmpty

public GameRecordsRequest skipEmpty(boolean skipEmptyRecords)

Sets whether record entries without any runs should be kept.

Parameters:

skipEmptyRecords - true to skip empty records; false otherwise

Returns:

this GameRecordsRequest builder