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

Methods

Modifier and Type	Method and 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	getSpaceActivitiesById(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, String before, String after, boolean returnSize, String expand) Process to return a space by id
javax.ws.rs.core.Response	getSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to return a space by id
javax.ws.rs.core.Response	getSpaceMembers(javax.ws.rs.core.UriInfo uriInfo, String id, 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, String q, int offset, int limit, boolean returnSize, String expand) Process to return a list of space in json format
javax.ws.rs.core.Response	postActivityOnSpace(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ActivityRestIn model)
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 Detail

getSpaces

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

Process to return a list of space in json format

Parameters:

uriInfo -

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

getSpaceById

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

Process to return a space by id

Parameters:

uriInfo -

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,
                                        String id,
                                        String role,
                                        int offset,
                                        int limit,
                                        boolean returnSize,
                                        String expand)
                                          throws Exception

Process to return a space by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

getSpaceActivitiesById

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

Process to return a space by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

postActivityOnSpace

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

Throws:

Exception