Package org.exoplatform.social.rest.api

Interface SpaceRestResources

All Superinterfaces:
org.exoplatform.services.rest.resource.ResourceContainer, SocialRest
All Known Implementing Classes:
SpaceRestResourcesV1
public interface SpaceRestResources extends SocialRest

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    createSpace(javax.ws.rs.core.UriInfo uriInfo, String expand, SpaceEntity model)
    Process to create a new space
    javax.ws.rs.core.Response
    deleteSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)
    Process to delete a space by id
    javax.ws.rs.core.Response
    getSpaceByDisplayName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String displayName, String expand)
    Process to return a space by display name
    javax.ws.rs.core.Response
    getSpaceById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id, String expand)
    Process to return a space by id
    javax.ws.rs.core.Response
    getSpaceByPrettyName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String prettyName, String expand)
    Process to return a space by pretty name
    javax.ws.rs.core.Response
    getSpaceMembers(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id, String q, String role, int offset, int limit, boolean returnSize, String expand)
    Process to return a space by id
    javax.ws.rs.core.Response
    getSpaces(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String q, String typeFilter, int offset, int limit, String sort, String order, boolean returnSize, boolean favorites, String expand)
    Process to return a list of space in json format
    javax.ws.rs.core.Response
    isSpaceContainsExternals(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String spaceId)
    Checks if a specific space contains external users
    javax.ws.rs.core.Response
    updateSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, SpaceEntity model)
    Process to update a space by id

  • Method Details

    • getSpaces

      javax.ws.rs.core.Response getSpaces(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String q, String typeFilter, int offset, int limit, String sort, String order, boolean returnSize, boolean favorites, String expand) throws Exception
      Process to return a list of space in json format
      Parameters:
      uriInfo -
      request -
      q -
      typeFilter -
      offset -
      limit -
      sort -
      order -
      returnSize -
      expand -
      Returns:
      Throws:
      Exception

    • createSpace

      javax.ws.rs.core.Response createSpace(@Context javax.ws.rs.core.UriInfo uriInfo, String expand, SpaceEntity model) throws Exception
      Process to create a new space
      Parameters:
      uriInfo -
      Returns:
      Throws:
      Exception

    • isSpaceContainsExternals

      javax.ws.rs.core.Response isSpaceContainsExternals(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String spaceId)
      Checks if a specific space contains external users
      Parameters:
      uriInfo -
      request -
      spaceId -
      Returns:
      space info of a space contains an external members

    • getSpaceById

      javax.ws.rs.core.Response getSpaceById(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String id, String expand) throws Exception
      Process to return a space by id
      Parameters:
      uriInfo -
      Returns:
      Throws:
      Exception

    • getSpaceByPrettyName

      javax.ws.rs.core.Response getSpaceByPrettyName(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String prettyName, String expand) throws Exception
      Process to return a space by pretty name
      Parameters:
      uriInfo -
      prettyName -
      expand -
      Returns:
      Throws:
      Exception

    • getSpaceByDisplayName

      javax.ws.rs.core.Response getSpaceByDisplayName(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String displayName, String expand) throws Exception
      Process to return a space by display name
      Parameters:
      uriInfo -
      displayName -
      expand -
      Returns:
      Throws:
      Exception

    • updateSpaceById

      javax.ws.rs.core.Response updateSpaceById(@Context javax.ws.rs.core.UriInfo uriInfo, String id, String expand, SpaceEntity model) throws Exception
      Process to update a space by id
      Parameters:
      uriInfo -
      Returns:
      Throws:
      Exception

    • deleteSpaceById

      javax.ws.rs.core.Response deleteSpaceById(@Context javax.ws.rs.core.UriInfo uriInfo, String id, String expand) throws Exception
      Process to delete a space by id
      Parameters:
      uriInfo -
      Returns:
      Throws:
      Exception

    • getSpaceMembers

      javax.ws.rs.core.Response getSpaceMembers(@Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.Request request, String id, String q, String role, int offset, int limit, boolean returnSize, String expand) throws Exception
      Process to return a space by id
      Parameters:
      uriInfo -
      Returns:
      Throws:
      Exception