| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RoomWebService (Openmeetings Webservices 7.2.0 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.openmeetings.webservice, class: RoomWebService"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RoomWebService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.openmeetings.webservice</a></div> |
| <h1 title="Class RoomWebService" class="title">Class RoomWebService</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">org.apache.openmeetings.webservice.BaseWebService</a> |
| <div class="inheritance">org.apache.openmeetings.webservice.RoomWebService</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Service("roomWebService") |
| @Produces("application/json") |
| @Path("/room") |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">RoomWebService</span> |
| <span class="extends-implements">extends <a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">BaseWebService</a></span></div> |
| <div class="block">RoomService contains methods to manipulate rooms and create invitation hash</div> |
| <dl class="notes"> |
| <dt>Author:</dt> |
| <dd>sebawagner</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.openmeetings.webservice.BaseWebService">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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RoomWebService</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a> room)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a new ROOM like through the Frontend</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close(java.lang.String,long)" class="member-name-link">close</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method to remotely close rooms.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#count(java.lang.String,java.lang.Long)" class="member-name-link">count</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> roomId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the count of users currently in the ROOM with given id</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(java.lang.String,long)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Delete a room by its room id</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExternal(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)" class="member-name-link">getExternal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a> room)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPublic(java.lang.String,java.lang.String)" class="member-name-link">getPublic</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an Object of Type RoomsList which contains a list of |
| ROOM-Objects.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoomById(java.lang.String,java.lang.Long)" class="member-name-link">getRoomById</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">returns a conference room object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hash(java.lang.String,org.apache.openmeetings.db.dto.room.InvitationDTO,boolean)" class="member-name-link">hash</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/InvitationDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">InvitationDTO</a> invite, |
| boolean sendmail)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method to get invitation hash with given parameters</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#kick(java.lang.String,long,java.lang.String,java.lang.String)" class="member-name-link">kick</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">kick external USER from given room</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#kickAll(java.lang.String,long)" class="member-name-link">kickAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">kick all uses of a certain room</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#open(java.lang.String,long)" class="member-name-link">open</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method to remotely open rooms.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html" title="class or interface in org.apache.openmeetings.db.dto.user" class="external-link">UserDTO</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#users(java.lang.String,java.lang.Long)" class="member-name-link">users</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> roomId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns list of users currently in the ROOM with given id</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>RoomWebService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RoomWebService</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getPublic(java.lang.String,java.lang.String)"> |
| <h3>getPublic</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/public/{type}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a>></span> <span class="element-name">getPublic</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("type") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> type)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- list of public rooms</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoomById(java.lang.String,java.lang.Long)"> |
| <h3>getRoomById</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></span> <span class="element-name">getRoomById</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">returns a conference room object</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- room with the id given</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExternal(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)"> |
| <h3>getExternal</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/{type}/{externaltype}/{externalid}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></span> <span class="element-name">getExternal</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("type") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> type, |
| @PathParam("externaltype") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| @PathParam("externalid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId, |
| @QueryParam("room") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a> room)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- id of the room or error code</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.openmeetings.db.dto.room.RoomDTO)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="annotations">@POST |
| @Path("/") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a></span> <span class="element-name">add</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @FormParam("room") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/RoomDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">RoomDTO</a> room)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Adds a new ROOM like through the Frontend</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID from getSession</dd> |
| <dd><code>room</code> - room object</dd> |
| <dt>Returns:</dt> |
| <dd>- Room object or throw error</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(java.lang.String,long)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="annotations">@DELETE |
| @Path("/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">delete</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Delete a room by its room id</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- id of the room deleted</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close(java.lang.String,long)"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/close/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">close</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- 1 in case of success, -2 otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="open(java.lang.String,long)"> |
| <h3>open</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/open/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">open</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- 1 in case of success, -2 otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="kickAll(java.lang.String,long)"> |
| <h3>kickAll</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/kick/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">kickAll</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">kick all uses of a certain room</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- true if USER was kicked, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="kick(java.lang.String,long,java.lang.String,java.lang.String)"> |
| <h3>kick</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/kick/{id}/{externalType}/{externalId}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">kick</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id, |
| @PathParam("externalType") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| @PathParam("externalId") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">kick external USER from given room</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- 'Kicked' if USER was 'Not kicked' otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="count(java.lang.String,java.lang.Long)"> |
| <h3>count</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/count/{roomid}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">count</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("roomid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> roomId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Returns the count of users currently in the ROOM with given id</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID from UserService.getSession</dd> |
| <dd><code>roomId</code> - id of the room to get users</dd> |
| <dt>Returns:</dt> |
| <dd>number of users as int</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="users(java.lang.String,java.lang.Long)"> |
| <h3>users</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/users/{roomid}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/user/UserDTO.html" title="class or interface in org.apache.openmeetings.db.dto.user" class="external-link">UserDTO</a>></span> <span class="element-name">users</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("roomid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> roomId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Returns list of users currently in the ROOM with given id</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID from UserService.getSession</dd> |
| <dd><code>roomId</code> - id of the room to get users</dd> |
| <dt>Returns:</dt> |
| <dd><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of users in the room</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hash(java.lang.String,org.apache.openmeetings.db.dto.room.InvitationDTO,boolean)"> |
| <h3>hash</h3> |
| <div class="member-signature"><span class="annotations">@POST |
| @Path("/hash") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">hash</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @QueryParam("invite") |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/room/InvitationDTO.html" title="class or interface in org.apache.openmeetings.db.dto.room" class="external-link">InvitationDTO</a> invite, |
| @QueryParam("sendmail") |
| boolean sendmail)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Method to get invitation hash with given parameters</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>- serviceResult object with the result</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012–2023 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |