Package dev.getelements.elements.rest.leaderboard

Class RankResource

java.lang.Object

dev.getelements.elements.rest.leaderboard.RankResource

@Path("rank")
public class RankResource
extends Object

Constructor Summary

Constructors

Constructor	Description
RankResource()

Method Summary

Modifier and Type	Method	Description
Pagination<Rank>	getGlobalRank(int offset, int count, String profileId, long leaderboardEpoch, String leaderboardNameOrId)
Tabulation<RankRow>	getGlobalRankTabular(String leaderboardNameOrId, long leaderboardEpoch)
Pagination<Rank>	getRankAmongFriends(int offset, int count, boolean relative, long leaderboardEpoch, String leaderboardNameOrId)
Pagination<Rank>	getRankAmongMutualFollowers(int offset, int count, boolean relative, long leaderboardEpoch, String leaderboardNameOrId)
RankService	getRankService()
void	setRankService(RankService rankService)

Methods inherited from class java.lang.Object

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

Constructor Details

RankResource

public RankResource()

Method Details

getGlobalRank

@GET
@Path("global/{leaderboardNameOrId}")
@Produces("application/json")
public Pagination<Rank> getGlobalRank(@QueryParam("offset") @DefaultValue("0")
 int offset,
 @QueryParam("count") @DefaultValue("20")
 int count,
 @QueryParam("profileId")
 String profileId,
 @QueryParam("leaderboardEpoch") @DefaultValue("0")
 long leaderboardEpoch,
 @PathParam("leaderboardNameOrId")
 String leaderboardNameOrId)

getGlobalRankTabular

@GET
@Path("global/{leaderboardNameOrId}")
@Produces("text/csv")
public Tabulation<RankRow> getGlobalRankTabular(@PathParam("leaderboardNameOrId")
 String leaderboardNameOrId,
 @QueryParam("leaderboardEpoch") @DefaultValue("0")
 long leaderboardEpoch)

getRankAmongFriends

@GET
@Path("friends/{leaderboardNameOrId}")
@Produces("application/json")
public Pagination<Rank> getRankAmongFriends(@QueryParam("offset") @DefaultValue("0")
 int offset,
 @QueryParam("count") @DefaultValue("20")
 int count,
 @QueryParam("relative") @DefaultValue("false")
 boolean relative,
 @QueryParam("leaderboardEpoch") @DefaultValue("0")
 long leaderboardEpoch,
 @PathParam("leaderboardNameOrId")
 String leaderboardNameOrId)

getRankAmongMutualFollowers

@GET
@Path("mutual_followers/{leaderboardNameOrId}")
@Produces("application/json")
public Pagination<Rank> getRankAmongMutualFollowers(@QueryParam("offset") @DefaultValue("0")
 int offset,
 @QueryParam("count") @DefaultValue("20")
 int count,
 @QueryParam("relative") @DefaultValue("false")
 boolean relative,
 @QueryParam("leaderboardEpoch") @DefaultValue("0")
 long leaderboardEpoch,
 @PathParam("leaderboardNameOrId")
 String leaderboardNameOrId)

getRankService

public RankService getRankService()

setRankService

@Inject
public void setRankService(RankService rankService)