org.exoplatform.social.rest.api

Interface UserRestResources

All Superinterfaces:

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

All Known Implementing Classes:

UserRestResourcesV1

public interface UserRestResources
extends SocialRest

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addActivityByUser(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ActivityEntity model)
javax.ws.rs.core.Response	addUser(javax.ws.rs.core.UriInfo uriInfo, String expand, UserEntity model) Creates an user
javax.ws.rs.core.Response	deleteUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)
javax.ws.rs.core.Response	getActivitiesOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, String type, int offset, int limit, String before, String after, boolean returnSize, String expand)
javax.ws.rs.core.Response	getConnectionOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, boolean returnSize, String expand)
javax.ws.rs.core.Response	getSpacesOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, boolean returnSize, String expand)
javax.ws.rs.core.Response	getUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)
javax.ws.rs.core.Response	getUsers(javax.ws.rs.core.UriInfo uriInfo, String q, int offset, int limit, boolean returnSize, String expand) Get all users, filter by name if exists.
javax.ws.rs.core.Response	updateUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, UserEntity model)

Method Detail

getUsers

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

Get all users, filter by name if exists.

Parameters:

q - value that an user's name match

Returns:

List of users in json format.

Throws:

Exception

addUser

javax.ws.rs.core.Response addUser(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  String expand,
                                  UserEntity model)
                           throws Exception

Creates an user

Parameters:

uriInfo -

Returns:

user created in json format

Throws:

Exception

getUserById

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

Throws:

Exception

deleteUserById

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

Throws:

Exception

updateUserById

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

Throws:

Exception

getConnectionOfUser

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

Throws:

Exception

getSpacesOfUser

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

Throws:

Exception

getActivitiesOfUser

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

Throws:

Exception

addActivityByUser

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

Throws:

Exception