| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_111) on Wed Jan 25 23:58:42 NOVT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UserWebService (Openmeetings Webservices 3.1.5 API)</title> |
| <meta name="date" content="2017-01-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="UserWebService (Openmeetings Webservices 3.1.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserWebService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/UserWebService.html" target="_top">Frames</a></li> |
| <li><a href="UserWebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openmeetings.webservice</div> |
| <h2 title="Class UserWebService" class="title">Class UserWebService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openmeetings.webservice.UserWebService</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Produces(value="application/json") |
| @Path(value="/user") |
| public class <span class="typeNameLabel">UserWebService</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></pre> |
| <div class="block">The Service contains methods to login and create hash to directly enter |
| conference rooms, recordings or the application in general</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>sebawagner</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#UserWebService--">UserWebService</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#add-java.lang.String-org.apache.openmeetings.db.dto.user.UserDTO-java.lang.Boolean-">add</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a> user, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> confirm)</code> |
| <div class="block">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!</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#count-java.lang.String-java.lang.Long-">count</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</code> |
| <div class="block">Returns the count of users currently in the Room with given id |
| No admin rights are necessary for this call</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#delete-java.lang.String-long-">delete</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| long id)</code> |
| <div class="block">Delete a certain user by its id</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#deleteExternal-java.lang.String-java.lang.String-java.lang.String-">deleteExternal</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalType, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalId)</code> |
| <div class="block">Delete a certain user by its external user id</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid)</code> |
| <div class="block">Lists all users in the system!</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#getRoomHash-java.lang.String-org.apache.openmeetings.db.dto.user.ExternalUserDTO-org.apache.openmeetings.db.dto.room.RoomOptionsDTO-">getRoomHash</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/ExternalUserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">ExternalUserDTO</a> user, |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomOptionsDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomOptionsDTO</a> options)</code> |
| <div class="block">Description: sets the SessionObject for a certain SID, after setting this |
| Session-Object you can use the SID + a RoomId to enter any Room.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#kick-java.lang.String-java.lang.String-">kick</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID)</code> |
| <div class="block">Kick a user by its public SID</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/UserWebService.html#login-java.lang.String-java.lang.String-">login</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pass)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="UserWebService--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UserWebService</h4> |
| <pre>public UserWebService()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="login-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre>@GET |
| @Path(value="/login") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> login(@QueryParam(value="user") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| @QueryParam(value="pass") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pass)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>login</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>user</code> - - login or email of Openmeetings user with admin or SOAP-rights</dd> |
| <dd><code>pass</code> - - password</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic"><code>ServiceResult</code></a> with error code or SID and userId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>@GET |
| @Path(value="/") |
| public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a>> get(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Lists all users in the system!</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>get</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- list of users</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-java.lang.String-org.apache.openmeetings.db.dto.user.UserDTO-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>@POST |
| @Path(value="/") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a> add(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @QueryParam(value="user") |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">UserDTO</a> user, |
| @QueryParam(value="confirm") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> confirm) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">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!</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>add</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>user</code> - user object</dd> |
| <dd><code>confirm</code> - whatever or not to send email, leave empty for auto-send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- id of the user added or error code</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>@DELETE |
| @Path(value="/{id}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> delete(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="id") |
| long id) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Delete a certain user by its id</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>delete</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>id</code> - the openmeetings user id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- id of the user deleted, error code otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteExternal-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteExternal</h4> |
| <pre>@DELETE |
| @Path(value="/{externaltype}/{externalid}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> deleteExternal(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="externaltype") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalType, |
| @PathParam(value="externalid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalId) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Delete a certain user by its external user id</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>deleteExternal</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>externalType</code> - externalUserId</dd> |
| <dd><code>externalId</code> - externalUserId</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- id of user deleted, or error code</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRoomHash-java.lang.String-org.apache.openmeetings.db.dto.user.ExternalUserDTO-org.apache.openmeetings.db.dto.room.RoomOptionsDTO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoomHash</h4> |
| <pre>@POST |
| @Path(value="/hash") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> getRoomHash(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @FormParam(value="user") |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/ExternalUserDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.user">ExternalUserDTO</a> user, |
| @FormParam(value="options") |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomOptionsDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomOptionsDTO</a> options) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Description: sets the SessionObject for a certain SID, after setting this |
| Session-Object you can use the SID + a RoomId to enter any Room. ... |
| Session-Hashs are deleted 15 minutes after the creation if not used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getRoomHash</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>user</code> - user details to set</dd> |
| <dd><code>options</code> - room options to set</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- secure hash or error code</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="kick-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>kick</h4> |
| <pre>@POST |
| @Path(value="/kick/{publicsid}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> kick(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="publicsid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> publicSID) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Kick a user by its public SID</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>kick</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>publicSID</code> - the publicSID (you can get it from the call to get users in a |
| room)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- <code>true</code> if user was kicked</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="count-java.lang.String-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>count</h4> |
| <pre>@GET |
| @Path(value="/count/{roomid}") |
| public int count(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="roomid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> roomId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.openmeetings.webservice.cluster.UserService</code></span></div> |
| <div class="block">Returns the count of users currently in the Room with given id |
| No admin rights are necessary for this call</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>count</code> in interface <code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.cluster.UserService.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.cluster.UserService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from UserService.getSession</dd> |
| <dd><code>roomId</code> - id of the room to get users</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of users as int</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserWebService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/UserWebService.html" target="_top">Frames</a></li> |
| <li><a href="UserWebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012–2017 <a href="http://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
