org.exoplatform.social.rest.api

Interface ActivityRestResources

All Superinterfaces:

org.exoplatform.services.rest.resource.ResourceContainer, SocialRest

All Known Implementing Classes:

ActivityRestResourcesV1

public interface ActivityRestResources
extends SocialRest

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addLike(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Adds a like for the activity with the given id.
javax.ws.rs.core.Response	deleteActivityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to delete an activity by id
javax.ws.rs.core.Response	deleteLike(javax.ws.rs.core.UriInfo uriInfo, String id, String username, String expand) Deletes a like from the user with the given username on the activity with the given activity id.
javax.ws.rs.core.Response	getActivitiesOfCurrentUser(javax.ws.rs.core.UriInfo uriInfo, int offset, int limit, boolean returnSize, String expand) Process to return all activities in json format
javax.ws.rs.core.Response	getActivityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to return an activity by id in json format
javax.ws.rs.core.Response	getCommentsOfActivity(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, boolean returnSize, String expand) Process to return all comments of an activity in json format
javax.ws.rs.core.Response	getLikesActivityOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, String username, String expand) Gets the like of the user with the given username for the activity with the given activity id.
javax.ws.rs.core.Response	getLikesOfActivity(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, String expand) Gets all the likes of the activity with the given id.
javax.ws.rs.core.Response	postComment(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, CommentEntity model) Process to create new comment
javax.ws.rs.core.Response	updateActivityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ActivityEntity model) Process to update the title of an activity by id

Method Detail

getActivitiesOfCurrentUser

javax.ws.rs.core.Response getActivitiesOfCurrentUser(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     int offset,
                                                     int limit,
                                                     boolean returnSize,
                                                     String expand)
                                              throws Exception

Process to return all activities in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

getActivityById

javax.ws.rs.core.Response getActivityById(@Context
                                          javax.ws.rs.core.UriInfo uriInfo,
                                          String id,
                                          String expand)
                                   throws Exception

Process to return an activity by id in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

updateActivityById

javax.ws.rs.core.Response updateActivityById(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String id,
                                             String expand,
                                             ActivityEntity model)
                                      throws Exception

Process to update the title of an activity by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

deleteActivityById

javax.ws.rs.core.Response deleteActivityById(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String id,
                                             String expand)
                                      throws Exception

Process to delete an activity by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

getCommentsOfActivity

javax.ws.rs.core.Response getCommentsOfActivity(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                String id,
                                                int offset,
                                                int limit,
                                                boolean returnSize,
                                                String expand)
                                         throws Exception

Process to return all comments of an activity in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

postComment

javax.ws.rs.core.Response postComment(@Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      String id,
                                      String expand,
                                      CommentEntity model)
                               throws Exception

Process to create new comment

Parameters:

uriInfo -

Returns:

Throws:

Exception

getLikesOfActivity

javax.ws.rs.core.Response getLikesOfActivity(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String id,
                                             int offset,
                                             int limit,
                                             String expand)
                                      throws Exception

Gets all the likes of the activity with the given id.

Parameters:

uriInfo -

id -

offset -

limit -

expand -

Returns:

Throws:

Exception

addLike

javax.ws.rs.core.Response addLike(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  String id,
                                  String expand)
                           throws Exception

Adds a like for the activity with the given id.

Parameters:

uriInfo -

id -

expand -

Returns:

Throws:

Exception

getLikesActivityOfUser

javax.ws.rs.core.Response getLikesActivityOfUser(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String id,
                                                 String username,
                                                 String expand)
                                          throws Exception

Gets the like of the user with the given username for the activity with the given activity id.

Parameters:

uriInfo -

id -

username -

expand -

Returns:

Throws:

Exception

deleteLike

javax.ws.rs.core.Response deleteLike(@Context
                                     javax.ws.rs.core.UriInfo uriInfo,
                                     String id,
                                     String username,
                                     String expand)
                              throws Exception

Deletes a like from the user with the given username on the activity with the given activity id.

Parameters:

uriInfo -

id -

username -

expand -

Returns:

Throws:

Exception