Class GroupWebService


  • @Service("groupWebService")
    @Produces("application/json")
    @Path("/group")
    public class GroupWebService
    extends BaseWebService
    The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general
    Author:
    sebawagner
    • Constructor Summary

      Constructors 
      Constructor Description
      GroupWebService()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.openmeetings.db.dto.basic.ServiceResult add​(java.lang.String sid, java.lang.String name)
      add a new group
      org.apache.openmeetings.db.dto.basic.ServiceResult addRoom​(java.lang.String sid, java.lang.Long id, java.lang.Long roomid)
      Adds a room to an group
      org.apache.openmeetings.db.dto.basic.ServiceResult addUser​(java.lang.String sid, java.lang.Long id, java.lang.Long userid)
      Add user to a certain group
      org.apache.openmeetings.db.dto.basic.ServiceResult delete​(java.lang.String sid, long id)
      Deletes a group
      java.util.List<org.apache.openmeetings.db.dto.user.GroupDTO> get​(java.lang.String sid)
      Get the list of all groups
      org.apache.openmeetings.db.dto.user.UserSearchResult getUsers​(java.lang.String sid, long id, int start, int max, java.lang.String orderby, boolean asc)
      Search users and return them
      org.apache.openmeetings.db.dto.basic.ServiceResult removeUser​(java.lang.String sid, java.lang.Long id, java.lang.Long userid)
      Remove user from a certain group
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GroupWebService

        public GroupWebService()
    • Method Detail

      • add

        @POST
        @Path("/")
        public org.apache.openmeetings.db.dto.basic.ServiceResult add​(@QueryParam("sid")
                                                                      java.lang.String sid,
                                                                      @QueryParam("name")
                                                                      java.lang.String name)
        add a new group
        Parameters:
        sid - The SID from getSession
        name - the name of the group
        Returns:
        ServiceResult with result type, and id of the group added
      • get

        @GET
        @Path("/")
        public java.util.List<org.apache.openmeetings.db.dto.user.GroupDTO> get​(@QueryParam("sid")
                                                                                java.lang.String sid)
        Get the list of all groups
        Parameters:
        sid - The SID from getSession
        Returns:
        list of all groups
      • addUser

        @POST
        @Path("/{id}/users/{userid}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult addUser​(@QueryParam("sid")
                                                                          java.lang.String sid,
                                                                          @PathParam("id")
                                                                          java.lang.Long id,
                                                                          @PathParam("userid")
                                                                          java.lang.Long userid)
        Add user to a certain group
        Parameters:
        sid - The SID from getSession
        userid - the user id
        id - the group id
        Returns:
        ServiceResult with result type, and id of the user added, or error id in case of the error as text
      • removeUser

        @DELETE
        @Path("/{id}/users/{userid}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult removeUser​(@QueryParam("sid")
                                                                             java.lang.String sid,
                                                                             @PathParam("id")
                                                                             java.lang.Long id,
                                                                             @PathParam("userid")
                                                                             java.lang.Long userid)
        Remove user from a certain group
        Parameters:
        sid - The SID from getSession
        userid - the user id
        id - the group id
        Returns:
        ServiceResult with result type, and id of the user added, or error id in case of the error as text
      • addRoom

        @POST
        @Path("/{id}/rooms/add/{roomid}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult addRoom​(@QueryParam("sid")
                                                                          java.lang.String sid,
                                                                          @PathParam("id")
                                                                          java.lang.Long id,
                                                                          @PathParam("roomid")
                                                                          java.lang.Long roomid)
        Adds a room to an group
        Parameters:
        sid - - The SID of the User. This SID must be marked as Loggedin
        id - - Id of group that the room is being paired with
        roomid - - Id of room to be added
        Returns:
        ServiceResult with result type
      • getUsers

        @GET
        @Path("/users/{id}")
        public org.apache.openmeetings.db.dto.user.UserSearchResult getUsers​(@QueryParam("sid")
                                                                             java.lang.String sid,
                                                                             @PathParam("id")
                                                                             long id,
                                                                             @QueryParam("start")
                                                                             int start,
                                                                             @QueryParam("max")
                                                                             int max,
                                                                             @QueryParam("orderby")
                                                                             java.lang.String orderby,
                                                                             @QueryParam("asc")
                                                                             boolean asc)
        Search users and return them
        Parameters:
        sid - The SID from getSession
        id - the group id
        start - first record
        max - max records
        orderby - orderby clause
        asc - asc or desc
        Returns:
        - users found
      • delete

        @DELETE
        @Path("/{id}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult delete​(@QueryParam("sid")
                                                                         java.lang.String sid,
                                                                         @PathParam("id")
                                                                         long id)
        Deletes a group
        Parameters:
        sid - The SID of the User. This SID must be marked as Loggedin
        id - the id of the group
        Returns:
        ServiceResult with result type