org.exoplatform.social.service.rest

Class PeopleRestService

java.lang.Object

org.exoplatform.social.service.rest.PeopleRestService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class PeopleRestService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Provides REST Services for manipulating jobs relates to people.

eXo anchor for generated doc on REST API

PeopleRestService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeopleRestService.ConnectionInfoRestOut
static class	PeopleRestService.UserInfo

Constructor Summary

Constructors

Constructor and Description
PeopleRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getPeopleInfo(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String userId, String format, String currentUserName, String updatedType) Gets a set of information of the target user.
org.exoplatform.social.core.space.spi.SpaceService	getSpaceService()
javax.ws.rs.core.Response	searchConnection(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String portalName, String nameToSearch, int offset, int limit, String lang, String format) Deprecated. Deprecated from 4.3.x. Replaced by a new API UserRestResourcesV1.getConnectionOfUser(UriInfo, String, boolean, String)
javax.ws.rs.core.Response	suggestUsernames(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String query) Deprecated. Deprecated from 4.3.x. Replaced by a new API UserRestResourcesV1.getUsers(UriInfo, String, String, String, int, int, boolean, String)
javax.ws.rs.core.Response	suggestUsernames(javax.ws.rs.core.UriInfo uriInfo, String name, String currentUser, String typeOfRelation, String activityId, String spaceURL, String format) Gets users' names that match the input string for suggestion.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeopleRestService

public PeopleRestService()

Method Detail

suggestUsernames

@RolesAllowed(value="users")
public javax.ws.rs.core.Response suggestUsernames(@Context
                                                                               javax.ws.rs.core.UriInfo uriInfo,
                                                                               String name,
                                                                               String currentUser,
                                                                               String typeOfRelation,
                                                                               String activityId,
                                                                               String spaceURL,
                                                                               String format)
                                                                        throws Exception

Gets users' names that match the input string for suggestion.

Parameters:

uriInfo - The requested URI information.

name - The provided characters to be searched.

currentUser - The user who sends request.

activityId - the Id of the activity where we want to mention a user in its comment

typeOfRelation - The relationship status such as "confirmed", "pending", "incoming", "member_of_space", "mention_activity_stream", "mention_comment" or "user_to_invite"

spaceURL - The URL of the related space.

format - The format of the returned result, for example, JSON, or XML.

Returns:

A list of users' names that match the input string.

Throws:

Exception

eXo level API

Platform

eXo anchor for generated doc on REST API

PeopleRestService.suggestUsernames

suggestUsernames

@RolesAllowed(value="users")
public javax.ws.rs.core.Response suggestUsernames(@Context
                                                                               javax.ws.rs.core.UriInfo uriInfo,
                                                                               @Context
                                                                               javax.ws.rs.core.SecurityContext securityContext,
                                                                               String query)
                                                                        throws Exception

Deprecated. Deprecated from 4.3.x. Replaced by a new API UserRestResourcesV1.getUsers(UriInfo, String, String, String, int, int, boolean, String)

Gets users' information that matches the input string.

Parameters:

uriInfo - The request URI information.

query - The name of the user to filter.

Returns:

Users' information that matches the input string.

Throws:

Exception

eXo level API

Platform

eXo anchor for generated doc on REST API

PeopleRestService.suggestUsernames

searchConnection

@RolesAllowed(value="users")
public javax.ws.rs.core.Response searchConnection(@Context
                                                                               javax.ws.rs.core.UriInfo uriInfo,
                                                                               @Context
                                                                               javax.ws.rs.core.SecurityContext securityContext,
                                                                               String portalName,
                                                                               String nameToSearch,
                                                                               int offset,
                                                                               int limit,
                                                                               String lang,
                                                                               String format)
                                                                        throws Exception

Deprecated. Deprecated from 4.3.x. Replaced by a new API UserRestResourcesV1.getConnectionOfUser(UriInfo, String, boolean, String)

Gets the information of people who have had connection with the current user.

Parameters:

uriInfo - The requested URI information.

format - The format of the returned result, for example, JSON, or XML.

portalName - The name of current portal.

nameToSearch - The name of user who wants to get.

offset - The starting point of the returned result.

limit - The ending point of the returned result.

lang - The locale type.

Returns:

The information of people who have had connection with the current user and the information must match with the input condition (name to search).

Throws:

Exception

eXo level API

Platform

eXo anchor for generated doc on REST API

PeopleRestService.searchConnection

getPeopleInfo

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getPeopleInfo(@Context
                                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                                            @Context
                                                                            javax.ws.rs.core.SecurityContext securityContext,
                                                                            String userId,
                                                                            String format,
                                                                            String currentUserName,
                                                                            String updatedType)
                                                                     throws Exception

Gets a set of information of the target user. The returned information of the user includes full name, position avatar, link to profile and relationship status with the current user who sends request.

Parameters:

uriInfo - The requested URI information.

securityContext - The security context of the system.

userId - The Id of a specific user.

format - The format of the returned result, for example, JSON, or XML.

currentUserName - The current user name who sends request.

updatedType - The type of connection action shown on the pop-up.

Returns:

The detailed information of a user.

Throws:

Exception

eXo level API

Platform

eXo anchor for generated doc on REST API

PeopleRestService.getPeopleInfo

getSpaceService

public org.exoplatform.social.core.space.spi.SpaceService getSpaceService()