Package org.exoplatform.addons.gamification.rest

Class GamificationRestEndpoint

java.lang.Object

org.exoplatform.addons.gamification.rest.GamificationRestEndpoint

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

@RolesAllowed("users")
public class GamificationRestEndpoint
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GamificationRestEndpoint.GamificationPoints

Constructor Summary

Constructors

Constructor	Description
GamificationRestEndpoint(GamificationService gamificationService, org.exoplatform.social.core.manager.IdentityManager identityManager, DomainService domainService, RuleService ruleService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAllEvents()	Return all events
javax.ws.rs.core.Response	getAllPointsByUserId(String userId, String period)	Return all earned points by a user
javax.ws.rs.core.Response	getAllPointsByUserIdByDate(String userId, String startDateEntry, String endDateEntry)	Return earned points by a user during a given period
javax.ws.rs.core.Response	getDomains()	Return enabled domains
javax.ws.rs.core.Response	getLeaderboardByDate(javax.ws.rs.core.UriInfo uriInfo, String earnerType, String startDateEntry, String endDateEntry)

Methods inherited from class java.lang.Object

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

Constructor Detail

GamificationRestEndpoint

public GamificationRestEndpoint(GamificationService gamificationService,
                                org.exoplatform.social.core.manager.IdentityManager identityManager,
                                DomainService domainService,
                                RuleService ruleService)

Method Detail

getAllPointsByUserId

@RolesAllowed("users")
public javax.ws.rs.core.Response getAllPointsByUserId(String userId,
                                                      String period)

Return all earned points by a user

Parameters:

userId - : user social id

period - : Period of time

Returns:

: and object of type GamificationPoints

getAllPointsByUserIdByDate

@RolesAllowed("users")
public javax.ws.rs.core.Response getAllPointsByUserIdByDate(String userId,
                                                            String startDateEntry,
                                                            String endDateEntry)

Return earned points by a user during a given period

Parameters:

userId - : user social id

startDateEntry - : Date from when gamification api filter earned points

endDateEntry - : Date until when gamification api filter eearned points

Returns:

: and object of type GamificationPoints

getLeaderboardByDate

@RolesAllowed("users")
public javax.ws.rs.core.Response getLeaderboardByDate(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String earnerType,
                                                      String startDateEntry,
                                                      String endDateEntry)

getDomains

@RolesAllowed("users")
public javax.ws.rs.core.Response getDomains()

Return enabled domains

Returns:

: list of enabled domains

getAllEvents

@RolesAllowed("users")
public javax.ws.rs.core.Response getAllEvents()

Return all events

Returns:

: list of all events