| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RoomWebService (Openmeetings Webservices 6.3.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RoomWebService (Openmeetings Webservices 6.3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RoomWebService.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.openmeetings.webservice</a></div> |
| <h2 title="Class RoomWebService" class="title">Class RoomWebService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">org.apache.openmeetings.webservice.BaseWebService</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openmeetings.webservice.RoomWebService</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>@Service("roomWebService") |
| @Produces("application/json") |
| @Path("/room") |
| public class <span class="typeNameLabel">RoomWebService</span> |
| extends <a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">BaseWebService</a></pre> |
| <div class="block">RoomService contains methods to manipulate rooms and create invitation hash</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"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openmeetings.webservice.BaseWebService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.openmeetings.webservice.<a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">BaseWebService</a></h3> |
| <code><a href="BaseWebService.html#fileDao">fileDao</a>, <a href="BaseWebService.html#roomDao">roomDao</a>, <a href="BaseWebService.html#sessionDao">sessionDao</a>, <a href="BaseWebService.html#userDao">userDao</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RoomWebService</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)">add</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> room)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a new ROOM like through the Frontend</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanWb(java.lang.String,long)">cleanWb</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">please use <a href="WbWebService.html#resetWb(java.lang.String,long)"><code>WbWebService.resetWb(String, long)</code></a> method instead |
| |
| Method to clean room white board (all objects will be purged)</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(java.lang.String,long)">close</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id)</code></th> |
| <td class="colLast"> |
| <div class="block">Method to remotely close rooms.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#count(java.lang.String,java.lang.Long)">count</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> roomId)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the count of users currently in the ROOM with given id</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(java.lang.String,long)">delete</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete a room by its room id</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExternal(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)">getExternal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalId, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> room)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if a room with this exteralId + externalType 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</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPublic(java.lang.String,java.lang.String)">getPublic</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an Object of Type RoomsList which contains a list of |
| ROOM-Objects.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoomById(java.lang.String,java.lang.Long)">getRoomById</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> id)</code></th> |
| <td class="colLast"> |
| <div class="block">returns a conference room object</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hash(java.lang.String,org.apache.openmeetings.db.dto.room.InvitationDTO,boolean)">hash</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/InvitationDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">InvitationDTO</a> invite, |
| boolean sendmail)</code></th> |
| <td class="colLast"> |
| <div class="block">Method to get invitation hash with given parameters</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#kick(java.lang.String,long,java.lang.String,java.lang.String)">kick</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalId)</code></th> |
| <td class="colLast"> |
| <div class="block">kick external USER from given room</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#kickAll(java.lang.String,long)">kickAll</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id)</code></th> |
| <td class="colLast"> |
| <div class="block">kick all uses of a certain room</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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" class="externalLink">ServiceResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open(java.lang.String,long)">open</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| long id)</code></th> |
| <td class="colLast"> |
| <div class="block">Method to remotely open rooms.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://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" class="externalLink">UserDTO</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#users(java.lang.String,java.lang.Long)">users</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> roomId)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns list of users currently in the ROOM with given id</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://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" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RoomWebService</h4> |
| <pre>public RoomWebService()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getPublic(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPublic</h4> |
| <pre class="methodSignature">@GET |
| @Path("/public/{type}") |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a>> getPublic​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("type") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> type) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Returns an Object of Type RoomsList which contains a list of |
| ROOM-Objects. Every ROOM-Object contains a Roomtype and all informations |
| about that ROOM. The List of current-users in the room is Null if you get |
| them via SOAP. The Roomtype can be 'conference', 'presentation' or 'interview'.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>type</code> - Type of public rooms need to be retrieved</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- list of public rooms</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRoomById(java.lang.String,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoomById</h4> |
| <pre class="methodSignature">@GET |
| @Path("/{id}") |
| public <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> getRoomById​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">returns a conference room object</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>id</code> - - the room id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- room with the id given</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExternal(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternal</h4> |
| <pre class="methodSignature">@GET |
| @Path("/{type}/{externaltype}/{externalid}") |
| public <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> getExternal​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("type") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> type, |
| @PathParam("externaltype") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalType, |
| @PathParam("externalid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalId, |
| @QueryParam("room") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> room) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Checks if a room with this exteralId + externalType 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</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>type</code> - type of the room</dd> |
| <dd><code>externalType</code> - you can specify your system-name or type of room here, for |
| example "moodle"</dd> |
| <dd><code>externalId</code> - your external room id may set here</dd> |
| <dd><code>room</code> - details of the room to be created if not found</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- id of the room or error code</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="add(java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre class="methodSignature">@POST |
| @Path("/") |
| public <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> add​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @FormParam("room") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">RoomDTO</a> room) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Adds a new ROOM like through the Frontend</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>room</code> - room object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- Room object or throw error</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="delete(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre class="methodSignature">@DELETE |
| @Path("/{id}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> delete​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Delete a room by its room id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>id</code> - - The id of the room</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- id of the room deleted</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">@GET |
| @Path("/close/{id}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> close​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Method to remotely close rooms. If a room is closed all users |
| inside the room and all users that try to enter it will be redirected to |
| the redirectURL that is defined in the ROOM-Object. |
| |
| Returns positive value if authentication was successful.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>id</code> - the room id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- 1 in case of success, -2 otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="open(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre class="methodSignature">@GET |
| @Path("/open/{id}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> open​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Method to remotely open rooms. If a room is closed all users |
| inside the room and all users that try to enter it will be redirected to |
| the redirectURL that is defined in the ROOM-Object. |
| |
| Returns positive value if authentication was successful.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>id</code> - the room id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- 1 in case of success, -2 otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="kickAll(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>kickAll</h4> |
| <pre class="methodSignature">@GET |
| @Path("/kick/{id}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> kickAll​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">kick all uses of a certain room</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin with SOAP privileges</dd> |
| <dd><code>id</code> - the room id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- true if USER was kicked, false otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="kick(java.lang.String,long,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>kick</h4> |
| <pre class="methodSignature">@GET |
| @Path("/kick/{id}/{externalType}/{externalId}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> kick​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id, |
| @PathParam("externalType") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalType, |
| @PathParam("externalId") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> externalId) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">kick external USER from given room</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin with SOAP privileges</dd> |
| <dd><code>id</code> - the room id</dd> |
| <dd><code>externalType</code> - external type of USER to kick</dd> |
| <dd><code>externalId</code> - external id of USER to kick</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- 'Kicked' if USER was 'Not kicked' otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="count(java.lang.String,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>count</h4> |
| <pre class="methodSignature">@GET |
| @Path("/count/{roomid}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> count​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("roomid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> roomId) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Returns the count of users currently in the ROOM with given id</div> |
| <dl> |
| <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> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="users(java.lang.String,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>users</h4> |
| <pre class="methodSignature">@GET |
| @Path("/users/{roomid}") |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://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" class="externalLink">UserDTO</a>> users​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("roomid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a> roomId) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Returns list of users currently in the ROOM with given id</div> |
| <dl> |
| <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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> of users in the room</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hash(java.lang.String,org.apache.openmeetings.db.dto.room.InvitationDTO,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hash</h4> |
| <pre class="methodSignature">@POST |
| @Path("/hash") |
| public <a href="https://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" class="externalLink">ServiceResult</a> hash​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @QueryParam("invite") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/InvitationDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room" class="externalLink">InvitationDTO</a> invite, |
| @QueryParam("sendmail") |
| boolean sendmail) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="block">Method to get invitation hash with given parameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>invite</code> - - parameters of the invitation</dd> |
| <dd><code>sendmail</code> - - flag to determine if email should be sent or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- serviceResult object with the result</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanWb(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cleanWb</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true#since()" title="class or interface in java.lang" class="externalLink">since</a>="5.0.0-M3") |
| @GET |
| @Path("/cleanwb/{id}") |
| public <a href="https://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" class="externalLink">ServiceResult</a> cleanWb​(@QueryParam("sid") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sid, |
| @PathParam("id") |
| long id) |
| throws <a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">please use <a href="WbWebService.html#resetWb(java.lang.String,long)"><code>WbWebService.resetWb(String, long)</code></a> method instead |
| |
| Method to clean room white board (all objects will be purged)</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>id</code> - - id of the room to clean</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- serviceResult object with the result</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RoomWebService.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2022 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |