com.captainup.android.core.response

Interface LeaderboardCaptainUpResponse

All Superinterfaces:

CaptainUpObject, CaptainUpResponse

public interface LeaderboardCaptainUpResponse
extends CaptainUpResponse

Method Summary

Modifier and Type	Method and Description
int	getCount() The number of players returned.
java.util.List<User>	getLeaderboard() List of all the players, ordered by their position in the leaderboard.
LeaderboardTime	getLeaderboardTime() The leaderboard's type.
int	getLimit() The number of players that was requested
int	getSkip() The number of players skipped in the leaderboard
long	getTotalPlayers() The total number of players in the app.

Methods inherited from interface com.captainup.android.core.response.CaptainUpResponse

getAPIVersion, getCode, getErrorCodeException, getObjectName, getRequestURL, isSuccessful

Method Detail

getCount

int getCount()

The number of players returned.

Returns:

the number of players returned.

getSkip

int getSkip()

The number of players skipped in the leaderboard

Returns:

the number of players skipped in the leaderboard

getLimit

int getLimit()

The number of players that was requested

Returns:

the number of players that was requested.

getLeaderboardTime

LeaderboardTime getLeaderboardTime()

The leaderboard's type.

Returns:

the leaderboard's type.

getTotalPlayers

long getTotalPlayers()

The total number of players in the app.

Returns:

the total number of players in the app.

getLeaderboard

java.util.List<User> getLeaderboard()

List of all the players, ordered by their position in the leaderboard.

Returns:

an ordered list of players