| <!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:41 NOVT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RoomWebService (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="RoomWebService (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,"i8":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/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"> |
| <li><a href="../../../../org/apache/openmeetings/webservice/RecordingWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/RoomWebService.html" target="_top">Frames</a></li> |
| <li><a href="RoomWebService.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 RoomWebService" class="title">Class RoomWebService</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.RoomWebService</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Produces(value="application/json") |
| @Path(value="/room") |
| public class <span class="typeNameLabel">RoomWebService</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></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"> |
| <!-- ======== 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/RoomWebService.html#RoomWebService--">RoomWebService</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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/RoomWebService.html#add-java.lang.String-org.apache.openmeetings.db.dto.room.RoomDTO-">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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</a> room)</code> |
| <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="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/RoomWebService.html#close-java.lang.String-long-">close</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">Method to remotely close rooms.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/room/RoomCountBean.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomCountBean</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/RoomWebService.html#counters-java.lang.String-java.util.List-">counters</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/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> ids)</code> |
| <div class="block">Returns current users for rooms ids</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/RoomWebService.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 room by its room id</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://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">RoomDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/RoomWebService.html#getExternal-java.lang.String-java.lang.String-java.lang.String-java.lang.Long-org.apache.openmeetings.db.dto.room.RoomDTO-">getExternal</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> type, |
| <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/Long.html?is-external=true" title="class or interface in java.lang">Long</a> externalId, |
| <a href="http://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">RoomDTO</a> room)</code> |
| <div class="block">Checks if a room with this exteralRoomId + externalRoomType does exist, |
| if yes it returns the room id if not, it will create the room and then |
| return the room id of the newly created room</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/RoomWebService.html#getPublic-java.lang.String-java.lang.String-">getPublic</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> type)</code> |
| <div class="block">Returns an Object of Type RoomsList which contains a list of |
| Room-Objects.</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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/RoomWebService.html#getRoomById-java.lang.String-java.lang.Long-">getRoomById</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> id)</code> |
| <div class="block">returns a conference room object</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/RoomWebService.html#kick-java.lang.String-long-">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, |
| long id)</code> |
| <div class="block">kick all uses of a certain room</div> |
| </td> |
| </tr> |
| <tr id="i8" 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/RoomWebService.html#open-java.lang.String-long-">open</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">Method to remotely open rooms.</div> |
| </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="RoomWebService--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RoomWebService</h4> |
| <pre>public RoomWebService()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPublic-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPublic</h4> |
| <pre>@GET |
| @Path(value="/public/{type}") |
| 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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</a>> getPublic(@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="type") |
| <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> type) |
| 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">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 1 for conference rooms or 2 for |
| audience rooms.</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> - </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="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="getRoomById-java.lang.String-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoomById</h4> |
| <pre>@GET |
| @Path(value="/{id}") |
| public <a href="http://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">RoomDTO</a> getRoomById(@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") |
| <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> 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">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="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="getExternal-java.lang.String-java.lang.String-java.lang.String-java.lang.Long-org.apache.openmeetings.db.dto.room.RoomDTO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternal</h4> |
| <pre>@GET |
| @Path(value="/{type}/{externaltype}/{externaliId}") |
| public <a href="http://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">RoomDTO</a> getExternal(@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="type") |
| <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> type, |
| @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/Long.html?is-external=true" title="class or interface in java.lang">Long</a> externalId, |
| @QueryParam(value="room") |
| <a href="http://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">RoomDTO</a> room) |
| 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">Checks if a room with this exteralRoomId + externalRoomType does exist, |
| if yes it returns the room id if not, it will create the room and then |
| return the room id of the newly created room</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="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.room.RoomDTO-"> |
| <!-- --> |
| </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/room/RoomDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomDTO</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, |
| @FormParam(value="room") |
| <a href="http://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">RoomDTO</a> room) |
| 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">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>- 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">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="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="close-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>@GET |
| @Path(value="/close/{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> close(@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">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="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="open-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>@GET |
| @Path(value="/open/{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> open(@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">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="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-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>kick</h4> |
| <pre>@GET |
| @Path(value="/kick/{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> 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="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">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 |
| _Admin</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="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="counters-java.lang.String-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>counters</h4> |
| <pre>@GET |
| @Path(value="/counters") |
| 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/room/RoomCountBean.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.room">RoomCountBean</a>> counters(@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="id") |
| <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://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> ids) |
| 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">Returns current users for rooms ids</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>ids</code> - - id of the room you need counters for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- current users for rooms ids</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> |
| </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/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"> |
| <li><a href="../../../../org/apache/openmeetings/webservice/RecordingWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/RoomWebService.html" target="_top">Frames</a></li> |
| <li><a href="RoomWebService.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> |