@Produces(value="application/json") @Path(value="/room") public class RoomWebService extends Object
Constructor and Description |
---|
RoomWebService() |
Modifier and Type | Method and Description |
---|---|
RoomDTO |
add(String sid,
RoomDTO room)
Adds a new Room like through the Frontend
|
ServiceResult |
close(String sid,
long id)
Method to remotely close rooms.
|
List<RoomCountBean> |
counters(String sid,
List<Long> ids)
Returns current users for rooms ids
|
ServiceResult |
delete(String sid,
long id)
Delete a room by its room id
|
RoomDTO |
getExternal(String sid,
String type,
String externalType,
Long externalId,
RoomDTO room)
Checks if a room with this exteralRoomId + externalRoomType does exist,
if yes it returns the room id if not, it will create the room and then
return the room id of the newly created room
|
List<RoomDTO> |
getPublic(String sid,
String type)
Returns an Object of Type RoomsList which contains a list of
Room-Objects.
|
RoomDTO |
getRoomById(String sid,
Long id)
returns a conference room object
|
ServiceResult |
kick(String sid,
long id)
kick all uses of a certain room
|
ServiceResult |
open(String sid,
long id)
Method to remotely open rooms.
|
@GET @Path(value="/public/{type}") public List<RoomDTO> getPublic(@QueryParam(value="sid") String sid, @PathParam(value="type") String type) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedintype
- org.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/{id}") public RoomDTO getRoomById(@QueryParam(value="sid") String sid, @PathParam(value="id") Long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- - The SID of the User. This SID must be marked as Loggedinid
- - the room idorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/{type}/{externaltype}/{externaliId}") public RoomDTO getExternal(@QueryParam(value="sid") String sid, @PathParam(value="type") String type, @PathParam(value="externaltype") String externalType, @PathParam(value="externalid") Long externalId, @QueryParam(value="room") RoomDTO room) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedintype
- type of the roomexternalType
- you can specify your system-name or type of room here, for
example "moodle"externalId
- your external room id may set hereroom
- details of the room to be created if not foundorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/") public RoomDTO add(@QueryParam(value="sid") String sid, @FormParam(value="room") RoomDTO room) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionroom
- room objectorg.apache.openmeetings.webservice.error.ServiceException
@DELETE @Path(value="/{id}") public ServiceResult delete(@QueryParam(value="sid") String sid, @PathParam(value="id") long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- - The SID of the User. This SID must be marked as Loggedinid
- - The id of the roomorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/close/{id}") public ServiceResult close(@QueryParam(value="sid") String sid, @PathParam(value="id") long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedinid
- the room idorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/open/{id}") public ServiceResult open(@QueryParam(value="sid") String sid, @PathParam(value="id") long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedinid
- the room idorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/kick/{id}") public ServiceResult kick(@QueryParam(value="sid") String sid, @PathParam(value="id") long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedin
_Adminid
- the room idorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/counters") public List<RoomCountBean> counters(@QueryParam(value="sid") String sid, @QueryParam(value="id") List<Long> ids) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- - The SID of the User. This SID must be marked as Loggedinids
- - id of the room you need counters fororg.apache.openmeetings.webservice.error.ServiceException
Copyright © 2012–2017 Apache Software Foundation. All rights reserved.