@Produces(value="application/json") @Path(value="/user") public class UserWebService extends Object implements org.apache.openmeetings.webservice.cluster.UserService
Constructor and Description |
---|
UserWebService() |
Modifier and Type | Method and Description |
---|---|
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!
|
int |
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 publicSID)
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)
login
in interface org.apache.openmeetings.webservice.cluster.UserService
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) throws org.apache.openmeetings.webservice.error.ServiceException
org.apache.openmeetings.webservice.cluster.UserService
get
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/") public UserDTO add(@QueryParam(value="sid") String sid, @QueryParam(value="user") UserDTO user, @QueryParam(value="confirm") Boolean confirm) throws org.apache.openmeetings.webservice.error.ServiceException
org.apache.openmeetings.webservice.cluster.UserService
add
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionuser
- user objectconfirm
- whatever or not to send email, leave empty for auto-sendorg.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
org.apache.openmeetings.webservice.cluster.UserService
delete
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionid
- the openmeetings user idorg.apache.openmeetings.webservice.error.ServiceException
@DELETE @Path(value="/{externaltype}/{externalid}") public ServiceResult deleteExternal(@QueryParam(value="sid") String sid, @PathParam(value="externaltype") String externalType, @PathParam(value="externalid") String externalId) throws org.apache.openmeetings.webservice.error.ServiceException
org.apache.openmeetings.webservice.cluster.UserService
deleteExternal
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionexternalType
- externalUserIdexternalId
- externalUserIdorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/hash") public ServiceResult getRoomHash(@QueryParam(value="sid") String sid, @FormParam(value="user") ExternalUserDTO user, @FormParam(value="options") RoomOptionsDTO options) throws org.apache.openmeetings.webservice.error.ServiceException
org.apache.openmeetings.webservice.cluster.UserService
getRoomHash
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionuser
- user details to setoptions
- room options to setorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/kick/{publicsid}") public ServiceResult kick(@QueryParam(value="sid") String sid, @PathParam(value="publicsid") String publicSID) throws org.apache.openmeetings.webservice.error.ServiceException
org.apache.openmeetings.webservice.cluster.UserService
kick
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from getSessionpublicSID
- the publicSID (you can get it from the call to get users in a
room)true
if user was kickedorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/count/{roomid}") public int count(@QueryParam(value="sid") String sid, @PathParam(value="roomid") Long roomId)
org.apache.openmeetings.webservice.cluster.UserService
count
in interface org.apache.openmeetings.webservice.cluster.UserService
sid
- The SID from UserService.getSessionroomId
- id of the room to get usersCopyright © 2012–2017 Apache Software Foundation. All rights reserved.