Package org.exoplatform.social.service.rest

Class SpacesRestService

  • All Implemented Interfaces:
    org.exoplatform.services.rest.resource.ResourceContainer
    @Deprecated
public class SpacesRestService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer
    Deprecated.
    use SpaceRestResourcesV1
    Provides services for the space gadget to display a user's spaces and pending spaces.
    eXo anchor for generated doc on REST API
    SpacesRestService

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SpacesRestService.SpaceList
      Deprecated.
      List that contains space from space service.
      Need this class for converter from rest service.

    • Constructor Summary

      Constructors 
      Constructor Description
      SpacesRestService​(org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.web.WebAppController webAppController)
      Deprecated.
       

    • Constructor Detail

      • SpacesRestService

        public SpacesRestService​(org.exoplatform.social.core.space.spi.SpaceService spaceService,
                         org.exoplatform.web.WebAppController webAppController)
        Deprecated.

    • Method Detail

      • showMySpaceList

        public javax.ws.rs.core.Response showMySpaceList​(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String portalName,
                                                 String format)
                                          throws Exception
        Deprecated.
        Deprecated from 4.3.x. Replaced by a new API UserRestResourcesV1.getSpacesOfUser(UriInfo, String, int, int, boolean, String)
        Gets the current user's spaces and pending spaces.
        Parameters:
        uriInfo - The requested URI information.
        portalName - The name of the current container.
        format - The format of the returned result.
        Returns:
        response
        Throws:
        Exception
        eXo level API
        Platform
        eXo anchor for generated doc on REST API
        SpacesRestService.showMySpaceList

      • getLastVisitedSpace

        @RolesAllowed("users")
public javax.ws.rs.core.Response getLastVisitedSpace​(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String portalName,
                                                     String format,
                                                     String appId,
                                                     int offset,
                                                     int limit)
                                              throws Exception
        Deprecated.
        Provides a way to get the latest spaces ordered by last access and to be able to filter spaces, based on the application Id in the spaces.
        Parameters:
        uriInfo - The requested URI information.
        portalName - The portal container name.
        format - The format of the returned result, for example, JSON, or XML.
        offset - Specifies the staring point of the returned results. It must be greater than or equal to 0.
        limit - Specifies the ending point of the returned results. It must be less than or equal to 10.
        appId - The application Id which is contained in spaces to filter, such as, Wiki, Discussion, Documents, Agenda and more.
        Returns:
        the response
        Throws:
        Exception
        eXo level API
        Platform
        eXo anchor for generated doc on REST API
        SpacesRestService.getLastVisitedSpace
        eXo anchor for generated doc on REST API
        GET: http://localhost:8080/rest/private/social/spaces/lastVisitedSpace/list.json?appId=Wiki&offset=0&limit=10
        eXo response for generated doc on REST API
        { "spaces":[ {"groupId":"/spaces/space_2","spaceUrl":null,"name":"space_2","displayName":"space 2","url":"space_2"}, {"groupId":"/spaces/space_1","spaceUrl":null,"name":"space_1","displayName":"space 1","url":"space_1"} ], "moreSpacesUrl":null }
        eXo authentication for generated doc on REST API

      • getSpaceInfo

        public javax.ws.rs.core.Response getSpaceInfo​(@Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              String portalName,
                                              String spaceName)
                                       throws Exception
        Deprecated.
        Gets space display info
        Parameters:
        uriInfo - The requested URI information.
        Returns:
        the response
        Throws:
        Exception
        eXo level API
        Platform
        eXo anchor for generated doc on REST API
        SpacesRestService.getSpaceInfo
        eXo anchor for generated doc on REST API
        GET: http://localhost:8080/rest/private/social/spaces/spaceInfo/?spaceName=space1
        eXo response for generated doc on REST API
        { {"displayName":"space 2","url":"","imageSource":""}, }
        eXo authentication for generated doc on REST API

      • showPendingSpaceList

        public javax.ws.rs.core.Response showPendingSpaceList​(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String portalName,
                                                      String format)
                                               throws Exception
        Deprecated.
        Gets a user's pending spaces.
        Parameters:
        uriInfo - The requested URI information.
        portalName - The portal container name.
        format - The format of the returned result, for example, JSON, or XML.
        Returns:
        response
        Throws:
        Exception
        eXo level API
        Platform
        eXo anchor for generated doc on REST API
        SpacesRestService.showPendingSpaceList

      • suggestSpacenames

        @RolesAllowed("users")
public javax.ws.rs.core.Response suggestSpacenames​(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String portalName,
                                                   String conditionToSearch,
                                                   String typeOfRelation,
                                                   String userId,
                                                   String format)
                                            throws Exception
        Deprecated.
        Deprecated from 4.3.x. Replaced by a new API SpaceRestResourcesV1.getSpaces(UriInfo, Request, String, String, int, int, String, String, boolean, String)
        Suggests the space's name for searching.
        Parameters:
        uriInfo - The requested URI information.
        portalName - The name of portal.
        conditionToSearch - The input information to search.
        typeOfRelation - The type of relationship of the user and the space.
        userId - The Id of current user.
        format - The format of the returned result, for example, JSON, or XML.
        Returns:
        Throws:
        Exception
        eXo level API
        Platform
        eXo anchor for generated doc on REST API
        SpacesRestService.suggestSpacenames