Package 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	Description
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	getConnectionsOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, String q, boolean returnSize, String expand)
javax.ws.rs.core.Response	getInvitationsOfUser(javax.ws.rs.core.UriInfo uriInfo, boolean returnSize, String expand)
javax.ws.rs.core.Response	getPendingOfUser(javax.ws.rs.core.UriInfo uriInfo, 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, javax.ws.rs.core.Request request, String id, String expand)
javax.ws.rs.core.Response	getUsers(javax.ws.rs.core.UriInfo uriInfo, String q, boolean searchEmail, boolean searchUserName, String status, String userType, String isConnected, String spaceId, boolean isDisabled, String enrollmentStatus, int offset, int limit, boolean returnSize, String expand, boolean excludeCurrentUser)	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 Details

getUsers

javax.ws.rs.core.Response getUsers(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String q,
 boolean searchEmail,
 boolean searchUserName,
 String status,
 String userType,
 String isConnected,
 String spaceId,
 boolean isDisabled,
 String enrollmentStatus,
 int offset,
 int limit,
 boolean returnSize,
 String expand,
 boolean excludeCurrentUser)
                            throws Exception

Get all users, filter by name if exists.

Parameters:

q - value that an user's name match

status - filter only online users

userType - filter by user type

isConnected - filter by connected users

spaceId - filter only space members

isDisabled - only disabled users

enrollmentStatus - filter by enrollment status

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,
 @Context
 javax.ws.rs.core.Request request,
 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

getConnectionsOfUser

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

Throws:

Exception

getInvitationsOfUser

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

Throws:

Exception

getPendingOfUser

javax.ws.rs.core.Response getPendingOfUser(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 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