@Service(value="userWebService") @Produces(value="application/json") @Path(value="/user") public class UserWebService extends BaseWebService
| コンストラクタと説明 |
|---|
UserWebService() |
| 修飾子とタイプ | メソッドと説明 |
|---|---|
UserDTO |
add(String sid,
UserDTO user,
Boolean confirm)
Adds a new User like through the Frontend, but also does activates the
Account To do SSO see the methods to create a hash and use those ones!
|
ServiceResult |
count(String sid,
Long roomId)
Returns the count of users currently in the Room with given id
No admin rights are necessary for this call
|
ServiceResult |
delete(String sid,
long id)
Delete a certain user by its id
|
ServiceResult |
deleteExternal(String sid,
String externalType,
String externalId)
Delete a certain user by its external user id
|
List<UserDTO> |
get(String sid)
Lists all users in the system!
|
ServiceResult |
getRoomHash(String sid,
ExternalUserDTO user,
RoomOptionsDTO options)
Description: sets the SessionObject for a certain SID, after setting this
Session-Object you can use the SID + a RoomId to enter any Room. ...
|
ServiceResult |
kick(String sid,
String uid)
Kick a user by its public SID
|
ServiceResult |
login(String user,
String pass) |
@GET @Path(value="/login") public ServiceResult login(@QueryParam(value="user") String user, @QueryParam(value="pass") String pass)
user - - login or email of Openmeetings user with admin or SOAP-rightspass - - passwordServiceResult with error code or SID and userId@GET @Path(value="/") public List<UserDTO> get(@QueryParam(value="sid") String sid)
sid - The SID from getSession@POST @Path(value="/") public UserDTO add(@QueryParam(value="sid") String sid, @FormParam(value="user") UserDTO user, @FormParam(value="confirm") Boolean confirm)
sid - The SID from getSessionuser - user objectconfirm - whatever or not to send email, leave empty for auto-send@DELETE
@Path(value="/{id}")
public ServiceResult delete(@QueryParam(value="sid")
String sid,
@PathParam(value="id")
long id)
sid - The SID from getSessionid - the openmeetings user id@DELETE
@Path(value="/{externaltype}/{externalid}")
public ServiceResult deleteExternal(@QueryParam(value="sid")
String sid,
@PathParam(value="externaltype")
String externalType,
@PathParam(value="externalid")
String externalId)
sid - The SID from getSessionexternalId - externalUserIdexternalType - externalUserId@POST @Path(value="/hash") public ServiceResult getRoomHash(@QueryParam(value="sid") String sid, @FormParam(value="user") ExternalUserDTO user, @FormParam(value="options") RoomOptionsDTO options)
sid - The SID from getSessionuser - user details to setoptions - room options to set@POST
@Path(value="/kick/{uid}")
public ServiceResult kick(@QueryParam(value="sid")
String sid,
@PathParam(value="uid")
String uid)
sid - The SID from getSessionuid - the uid of the clienttrue if user was kicked@GET
@Path(value="/count/{roomid}")
public ServiceResult count(@QueryParam(value="sid")
String sid,
@PathParam(value="roomid")
Long roomId)
sid - The SID from UserService.getSessionroomId - id of the room to get usersCopyright © 2012–2017 Apache Software Foundation. All rights reserved.