@Service(value="roomWebService") @Produces(value="application/json") @Path(value="/room") public class RoomWebService extends BaseWebService
| コンストラクタと説明 |
|---|
RoomWebService() |
| 修飾子とタイプ | メソッドと説明 |
|---|---|
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<RoomCountDTO> |
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,
String 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 |
hash(String sid,
InvitationDTO invite,
boolean sendmail)
Method to get invitation hash with given parameters
|
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)
sid - The SID of the User. This SID must be marked as Loggedintype - @GET
@Path(value="/{id}")
public RoomDTO getRoomById(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
Long id)
sid - - The SID of the User. This SID must be marked as Loggedinid - - the room id@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")
String externalId,
@QueryParam(value="room")
RoomDTO room)
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 found@POST @Path(value="/") public RoomDTO add(@QueryParam(value="sid") String sid, @FormParam(value="room") RoomDTO room)
sid - The SID from getSessionroom - room object@DELETE
@Path(value="/{id}")
public ServiceResult delete(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
long id)
sid - - The SID of the User. This SID must be marked as Loggedinid - - The id of the room@GET
@Path(value="/close/{id}")
public ServiceResult close(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
long id)
sid - The SID of the User. This SID must be marked as Loggedinid - the room id@GET
@Path(value="/open/{id}")
public ServiceResult open(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
long id)
sid - The SID of the User. This SID must be marked as Loggedinid - the room id@GET
@Path(value="/kick/{id}")
public ServiceResult kick(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
long id)
sid - The SID of the User. This SID must be marked as Loggedin
_Adminid - the room id@GET @Path(value="/counters") public List<RoomCountDTO> counters(@QueryParam(value="sid") String sid, @QueryParam(value="id") List<Long> ids)
sid - - The SID of the User. This SID must be marked as Loggedinids - - id of the room you need counters for@POST @Path(value="/hash") public ServiceResult hash(@QueryParam(value="sid") String sid, @QueryParam(value="invite") InvitationDTO invite, @QueryParam(value="sendmail") boolean sendmail)
sid - - The SID of the User. This SID must be marked as Loggedininvite - - parameters of the invitationsendmail - - flag to determine if email should be sent or notCopyright © 2012–2017 Apache Software Foundation. All rights reserved.