Package dev.getelements.elements.sdk.service.leaderboard

Interface RankService

All Known Implementing Classes:

AnonRankService, SuperUserRankService, UserRankService

public interface RankService

Queries and combines instances of Leaderboard and Score to calculate player rank.

Method Summary

Modifier and Type	Method	Description
Pagination<Rank>	getRanksForFriends(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile
Pagination<Rank>	getRanksForFriendsRelative(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile
Pagination<Rank>	getRanksForGlobal(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard.getId()
Pagination<Rank>	getRanksForGlobalRelative(String leaderboardNameOrId, String profileId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard relative to the Profile with the supplied id.
Tabulation<RankRow>	getRanksForGlobalTabular(String leaderboardNameOrId, long leaderboardEpoch)	Gets the global ranks for tabular data.
Pagination<Rank>	getRanksForMutualFollowers(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile
Pagination<Rank>	getRanksForMutualFollowersRelative(String leaderboardNameOrId, int offset, int count, long leaderboardEpoch)	Gets all Rank instances for the supplied Leaderboard relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile

Method Details

getRanksForGlobal

Pagination<Rank> getRanksForGlobal(String leaderboardNameOrId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard.getId()

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

offset - the offset

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForGlobalRelative

Pagination<Rank> getRanksForGlobalRelative(String leaderboardNameOrId,
 String profileId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard relative to the Profile with the supplied id.

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

profileId - the value of Profile.getId()

offset -

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForFriends

Pagination<Rank> getRanksForFriends(String leaderboardNameOrId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

offset - the offset

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForFriendsRelative

Pagination<Rank> getRanksForFriendsRelative(String leaderboardNameOrId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

offset - the offset

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForMutualFollowers

Pagination<Rank> getRanksForMutualFollowers(String leaderboardNameOrId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard.getId() relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

offset - the offset

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForMutualFollowersRelative

Pagination<Rank> getRanksForMutualFollowersRelative(String leaderboardNameOrId,
 int offset,
 int count,
 long leaderboardEpoch)

Gets all Rank instances for the supplied Leaderboard relative to the Profile with the supplied id returning only Rank instances within the supplied friend list for the given Profile

Parameters:

leaderboardNameOrId - the value of Leaderboard.getId() or Leaderboard.getName()

offset - the offset

count - the count

leaderboardEpoch - the epoch timestamp

Returns:

the Pagination<Rank>

getRanksForGlobalTabular

Tabulation<RankRow> getRanksForGlobalTabular(String leaderboardNameOrId,
 long leaderboardEpoch)

Gets the global ranks for tabular data.

Returns:

the tabular ranks