You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by se...@apache.org on 2011/12/15 12:06:23 UTC
svn commit: r1214698 [3/6] - /incubator/openmeetings/site/docs/
Added: incubator/openmeetings/site/docs/RoomService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/site/docs/RoomService.html?rev=1214698&view=auto
==============================================================================
--- incubator/openmeetings/site/docs/RoomService.html (added)
+++ incubator/openmeetings/site/docs/RoomService.html Thu Dec 15 11:06:23 2011
@@ -0,0 +1,4634 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE TEMPLATE INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+ <meta name="author" value="OpenMeetings Team">
+ <meta name="email" value="sebawagner@apache.org">
+ <title>OpenMeetings API Methods</title>
+ <link rel="stylesheet" type="text/css" href="openmeetings_docs.css">
+ </head>
+ <body>
+
+ <h3>Available WebServices:</h3>
+
+ <iframe src="WebserviceIndex.html" width="100%" height="100" name="WebserviceIndex.html"
+ scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
+ <p>Your Browser does not support frames ...</p>
+ </iframe>
+
+ <hr />
+
+ <h3>WebService: RoomService</h3>
+ <p>RoomService contains methods to manipulate rooms and create invitation hash<p>
+ <p>WSDL sample Url: <a href="http://localhost:5080/openmeetings/services/RoomService?wsdl">http://localhost:5080/openmeetings/services/RoomService?wsdl</a><p>
+
+ <!-- Links to Methods -->
+ <h3>Index of Methods available in RoomService</h3>
+
+ <div class="navigation">
+ <div>
+ <a href="#getRoomsPublic"><b>getRoomsPublic</b></a><br/>
+ <div class="navigation_comment"><i >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.</i></div>
+ </div>
+ <div>
+ <a href="#deleteFlvRecording"><b>deleteFlvRecording</b></a><br/>
+ <div class="navigation_comment"><i >Deletes a flv recording</i></div>
+ </div>
+ <div>
+ <a href="#getFlvRecordingByExternalUserId"><b>getFlvRecordingByExternalUserId</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv recordings</i></div>
+ </div>
+ <div>
+ <a href="#getFlvRecordingByExternalRoomTypeAndCreator"><b>getFlvRecordingByExternalRoomTypeAndCreator</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv recordings</i></div>
+ </div>
+ <div>
+ <a href="#getFlvRecordingByExternalRoomTypeByList"><b>getFlvRecordingByExternalRoomTypeByList</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv recordings</i></div>
+ </div>
+ <div>
+ <a href="#getFlvRecordingByExternalRoomType"><b>getFlvRecordingByExternalRoomType</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv recordings</i></div>
+ </div>
+ <div>
+ <a href="#getFlvRecordingByRoomId"><b>getFlvRecordingByRoomId</b></a><br/>
+ <div class="navigation_comment"><i >Get list of recordings</i></div>
+ </div>
+ <div>
+ <a href="#getRoomTypes"><b>getRoomTypes</b></a><br/>
+ <div class="navigation_comment"><i >List of available room types</i></div>
+ </div>
+ <div>
+ <a href="#getRoomCounters"><b>getRoomCounters</b></a><br/>
+ <div class="navigation_comment"><i >Returns current users for rooms ids</i></div>
+ </div>
+ <div>
+ <a href="#getRoomById"><b>getRoomById</b></a><br/>
+ <div class="navigation_comment"><i >returns a conference room object</i></div>
+ </div>
+ <div>
+ <a href="#getRoomWithCurrentUsersById"><b>getRoomWithCurrentUsersById</b></a><br/>
+ <div class="navigation_comment"><i ></i></div>
+ </div>
+ <div>
+ <a href="#getRoomWithClientObjectsById"><b>getRoomWithClientObjectsById</b></a><br/>
+ <div class="navigation_comment"><i >Returns a object of type RoomReturn</i></div>
+ </div>
+ <div>
+ <a href="#getRooms"><b>getRooms</b></a><br/>
+ <div class="navigation_comment"><i >Returns a List of Objects of Rooms You can use "name" as value for
+ orderby or rooms_id</i></div>
+ </div>
+ <div>
+ <a href="#getRoomsWithCurrentUsers"><b>getRoomsWithCurrentUsers</b></a><br/>
+ <div class="navigation_comment"><i >Returns a List of Objects of Rooms You can use "name" as value for
+ orderby or rooms_id. It also fills the attribute currentUsers in the
+ Room-Object</i></div>
+ </div>
+ <div>
+ <a href="#addRoom"><b>addRoom</b></a><br/>
+ <div class="navigation_comment"><i >TODO: Fix Organization Issue
+
+ deprecated use addRoomWithModeration instead</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModeration"><b>addRoomWithModeration</b></a><br/>
+ <div class="navigation_comment"><i >Create a conference room</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationAndQuestions"><b>addRoomWithModerationAndQuestions</b></a><br/>
+ <div class="navigation_comment"><i >this SOAP Method has an additional param to enable or disable the buttons
+ to apply for moderation this does only work in combination with the
+ room-type restricted</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationQuestionsAndAudioType"><b>addRoomWithModerationQuestionsAndAudioType</b></a><br/>
+ <div class="navigation_comment"><i >adds a new room with options for user questions and audio only</i></div>
+ </div>
+ <div>
+ <a href="#getRoomIdByExternalId"><b>getRoomIdByExternalId</b></a><br/>
+ <div class="navigation_comment"><i >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</i></div>
+ </div>
+ <div>
+ <a href="#updateRoom"><b>updateRoom</b></a><br/>
+ <div class="navigation_comment"><i >TODO: Fix Organization Issue deprecated use updateRoomWithModeration</i></div>
+ </div>
+ <div>
+ <a href="#updateRoomWithModeration"><b>updateRoomWithModeration</b></a><br/>
+ <div class="navigation_comment"><i >Updates a conference room by its room id</i></div>
+ </div>
+ <div>
+ <a href="#updateRoomWithModerationAndQuestions"><b>updateRoomWithModerationAndQuestions</b></a><br/>
+ <div class="navigation_comment"><i ></i></div>
+ </div>
+ <div>
+ <a href="#deleteRoom"><b>deleteRoom</b></a><br/>
+ <div class="navigation_comment"><i >Delete a room by its room id</i></div>
+ </div>
+ <div>
+ <a href="#kickUser"><b>kickUser</b></a><br/>
+ <div class="navigation_comment"><i >kick all uses of a certain room</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationAndExternalType"><b>addRoomWithModerationAndExternalType</b></a><br/>
+ <div class="navigation_comment"><i >Add a new conference room with option to set the external room type, the
+ external room type should be set if multiple applications use the same
+ OpenMeetings instance</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationExternalTypeAndAudioType"><b>addRoomWithModerationExternalTypeAndAudioType</b></a><br/>
+ <div class="navigation_comment"><i >Adds a new room with options for audio only</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationAndRecordingFlags"><b>addRoomWithModerationAndRecordingFlags</b></a><br/>
+ <div class="navigation_comment"><i >Adds a new room with options for recording</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationExternalTypeAndTopBarOption"><b>addRoomWithModerationExternalTypeAndTopBarOption</b></a><br/>
+ <div class="navigation_comment"><i >Add a conference room with options to disable the top menu bar in the
+ conference room</i></div>
+ </div>
+ <div>
+ <a href="#getInvitationHash"><b>getInvitationHash</b></a><br/>
+ <div class="navigation_comment"><i >Create a Invitation hash and optionally send it by mail the From to Date
+ is as String as some SOAP libraries do not accept Date Objects in SOAP
+ Calls Date is parsed as dd.mm.yyyy, time as hh:mm (don't forget the
+ leading zero's)</i></div>
+ </div>
+ <div>
+ <a href="#sendInvitationHash"><b>sendInvitationHash</b></a><br/>
+ <div class="navigation_comment"><i >Create a Invitation hash and optionally send it by mail the From to Date
+ is as String as some SOAP libraries do not accept Date Objects in SOAP
+ Calls Date is parsed as dd.mm.yyyy, time as hh:mm (don't forget the
+ leading zero's)</i></div>
+ </div>
+ <div>
+ <a href="#sendInvitationHashWithDateObject"><b>sendInvitationHashWithDateObject</b></a><br/>
+ <div class="navigation_comment"><i >Create a Invitation hash and optionally send it by mail the From to Date
+ is as String as some SOAP libraries do not accept Date Objects in SOAP
+ Calls Date is parsed as dd.mm.yyyy, time as hh:mm (don't forget the
+ leading zero's)</i></div>
+ </div>
+ <div>
+ <a href="#getRoomsWithCurrentUsersByList"><b>getRoomsWithCurrentUsersByList</b></a><br/>
+ <div class="navigation_comment"><i >Return a RoomReturn Object with information of the current users of a
+ conference room</i></div>
+ </div>
+ <div>
+ <a href="#getRoomsWithCurrentUsersByListAndType"><b>getRoomsWithCurrentUsersByListAndType</b></a><br/>
+ <div class="navigation_comment"><i >Return a RoomReturn Object with information of the current users of a
+ conference room with option to search for special external room types</i></div>
+ </div>
+ <div>
+ <a href="#addRoomWithModerationAndExternalTypeAndStartEnd"><b>addRoomWithModerationAndExternalTypeAndStartEnd</b></a><br/>
+ <div class="navigation_comment"><i >Adds a conference room that is only available for a period of time</i></div>
+ </div>
+ <div>
+ <a href="#addMeetingMemberRemindToRoom"><b>addMeetingMemberRemindToRoom</b></a><br/>
+ <div class="navigation_comment"><i >Add a meeting member to a certain room. This is the same as adding an
+ external user to a event in the calendar.</i></div>
+ </div>
+ <div>
+ <a href="#addExternalMeetingMemberRemindToRoom"><b>addExternalMeetingMemberRemindToRoom</b></a><br/>
+ <div class="navigation_comment"><i >Add a meeting member to a certain room. This is the same as adding an
+ external user to a event in the calendar. with a certain time zone</i></div>
+ </div>
+ <div>
+ <a href="#closeRoom"><b>closeRoom</b></a><br/>
+ <div class="navigation_comment"><i >Method to remotely close or 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.</i></div>
+ </div>
+ </div>
+
+ <h3>Methods Details in RoomService</h3>
+
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomsPublic" ><b>getRoomsPublic</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomsPublic (
+ String SID
+ ,
+ Long roomtypes_id
+ )
+ </i><br/>
+ <p>
+ 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.
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.rooms.Rooms[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomtypes_id</td>
+ <td valign="top"></td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomsPublic?SID=VALUE&roomtypes_id=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomsPublic?SID=VALUE&roomtypes_id=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="deleteFlvRecording" ><b>deleteFlvRecording</b></a>
+ </div>
+ </div>
+
+ Method: <i>deleteFlvRecording (
+ String SID
+ ,
+ Long flvRecordingId
+ )
+ </i><br/>
+ <p>
+ Deletes a flv recording
+ </p>
+ <p>
+ Return Type: boolean
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">flvRecordingId</td>
+ <td valign="top">the id of the recording</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/deleteFlvRecording?SID=VALUE&flvRecordingId=VALUE">http://localhost:5080/openmeetings/services/RoomService/deleteFlvRecording?SID=VALUE&flvRecordingId=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalUserId" ><b>getFlvRecordingByExternalUserId</b></a>
+ </div>
+ </div>
+
+ Method: <i>getFlvRecordingByExternalUserId (
+ String SID
+ ,
+ String externalUserId
+ )
+ </i><br/>
+ <p>
+ Gets a list of flv recordings
+ </p>
+ <p>
+ Return Type: org.openmeetings.axis.services.FLVRecordingReturn[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">externalUserId</td>
+ <td valign="top">the externalUserId</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalUserId?SID=VALUE&externalUserId=VALUE">http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalUserId?SID=VALUE&externalUserId=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomTypeAndCreator" ><b>getFlvRecordingByExternalRoomTypeAndCreator</b></a>
+ </div>
+ </div>
+
+ Method: <i>getFlvRecordingByExternalRoomTypeAndCreator (
+ String SID
+ ,
+ String externalRoomType
+ ,
+ Long insertedBy
+ )
+ </i><br/>
+ <p>
+ Gets a list of flv recordings
+ </p>
+ <p>
+ Return Type: org.openmeetings.axis.services.FLVRecordingReturn[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">externalRoomType</td>
+ <td valign="top">externalRoomType specified when creating the room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">insertedBy</td>
+ <td valign="top">the userId that created the recording</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomTypeAndCreator?SID=VALUE&externalRoomType=VALUE&insertedBy=VALUE">http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomTypeAndCreator?SID=VALUE&externalRoomType=VALUE&insertedBy=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomTypeByList" ><b>getFlvRecordingByExternalRoomTypeByList</b></a>
+ </div>
+ </div>
+
+ Method: <i>getFlvRecordingByExternalRoomTypeByList (
+ String SID
+ ,
+ String externalRoomType
+ )
+ </i><br/>
+ <p>
+ Gets a list of flv recordings
+ </p>
+ <p>
+ Return Type: java.util.List
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">externalRoomType</td>
+ <td valign="top">externalRoomType specified when creating the room</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomTypeByList?SID=VALUE&externalRoomType=VALUE">http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomTypeByList?SID=VALUE&externalRoomType=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomType" ><b>getFlvRecordingByExternalRoomType</b></a>
+ </div>
+ </div>
+
+ Method: <i>getFlvRecordingByExternalRoomType (
+ String SID
+ ,
+ String externalRoomType
+ )
+ </i><br/>
+ <p>
+ Gets a list of flv recordings
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.flvrecord.FlvRecording[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">externalRoomType</td>
+ <td valign="top">externalRoomType specified when creating the room</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomType?SID=VALUE&externalRoomType=VALUE">http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByExternalRoomType?SID=VALUE&externalRoomType=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByRoomId" ><b>getFlvRecordingByRoomId</b></a>
+ </div>
+ </div>
+
+ Method: <i>getFlvRecordingByRoomId (
+ String SID
+ ,
+ Long roomId
+ )
+ </i><br/>
+ <p>
+ Get list of recordings
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.flvrecord.FlvRecording[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomId</td>
+ <td valign="top">the room id</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByRoomId?SID=VALUE&roomId=VALUE">http://localhost:5080/openmeetings/services/RoomService/getFlvRecordingByRoomId?SID=VALUE&roomId=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomTypes" ><b>getRoomTypes</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomTypes (
+ String SID
+ )
+ </i><br/>
+ <p>
+ List of available room types
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.rooms.RoomTypes[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomTypes?SID=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomTypes?SID=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomCounters" ><b>getRoomCounters</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomCounters (
+ String SID
+ ,
+ Integer roomId1
+ ,
+ Integer roomId2
+ ,
+ Integer roomId3
+ ,
+ Integer roomId4
+ ,
+ Integer roomId5
+ ,
+ Integer roomId6
+ ,
+ Integer roomId7
+ ,
+ Integer roomId8
+ ,
+ Integer roomId9
+ ,
+ Integer roomId10
+ )
+ </i><br/>
+ <p>
+ Returns current users for rooms ids
+ </p>
+ <p>
+ Return Type: org.openmeetings.axis.services.RoomCountBean[]
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId1</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId2</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId3</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId4</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId5</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId6</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId7</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId8</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId9</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">roomId10</td>
+ <td valign="top"></td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomCounters?SID=VALUE&roomId1=VALUE&roomId2=VALUE&roomId3=VALUE&roomId4=VALUE&roomId5=VALUE&roomId6=VALUE&roomId7=VALUE&roomId8=VALUE&roomId9=VALUE&roomId10=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomCounters?SID=VALUE&roomId1=VALUE&roomId2=VALUE&roomId3=VALUE&roomId4=VALUE&roomId5=VALUE&roomId6=VALUE&roomId7=VALUE&roomId8=VALUE&roomId9=VALUE&roomId10=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomById" ><b>getRoomById</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomById (
+ String SID
+ ,
+ long rooms_id
+ )
+ </i><br/>
+ <p>
+ returns a conference room object
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.rooms.Rooms
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ long
+ </td>
+ <td valign="top">rooms_id</td>
+ <td valign="top">the room id</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomById?SID=VALUE&rooms_id=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomById?SID=VALUE&rooms_id=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomWithCurrentUsersById" ><b>getRoomWithCurrentUsersById</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomWithCurrentUsersById (
+ String SID
+ ,
+ long rooms_id
+ )
+ </i><br/>
+ <p>
+
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.persistence.beans.rooms.Rooms
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ long
+ </td>
+ <td valign="top">rooms_id</td>
+ <td valign="top"></td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomWithCurrentUsersById?SID=VALUE&rooms_id=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomWithCurrentUsersById?SID=VALUE&rooms_id=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomWithClientObjectsById" ><b>getRoomWithClientObjectsById</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomWithClientObjectsById (
+ String SID
+ ,
+ long rooms_id
+ )
+ </i><br/>
+ <p>
+ Returns a object of type RoomReturn
+ </p>
+ <p>
+ Return Type: org.openmeetings.axis.services.RoomReturn
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ long
+ </td>
+ <td valign="top">rooms_id</td>
+ <td valign="top"></td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomWithClientObjectsById?SID=VALUE&rooms_id=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomWithClientObjectsById?SID=VALUE&rooms_id=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRooms" ><b>getRooms</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRooms (
+ String SID
+ ,
+ int start
+ ,
+ int max
+ ,
+ String orderby
+ ,
+ boolean asc
+ )
+ </i><br/>
+ <p>
+ Returns a List of Objects of Rooms You can use "name" as value for
+ orderby or rooms_id
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.data.beans.basic.SearchResult
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ int
+ </td>
+ <td valign="top">start</td>
+ <td valign="top">The id you want to start</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ int
+ </td>
+ <td valign="top">max</td>
+ <td valign="top">The maximum you want to get</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">orderby</td>
+ <td valign="top">The column it will be ordered</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ boolean
+ </td>
+ <td valign="top">asc</td>
+ <td valign="top">Asc or Desc sort ordering</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRooms?SID=VALUE&start=VALUE&max=VALUE&orderby=VALUE&asc=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRooms?SID=VALUE&start=VALUE&max=VALUE&orderby=VALUE&asc=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomsWithCurrentUsers" ><b>getRoomsWithCurrentUsers</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomsWithCurrentUsers (
+ String SID
+ ,
+ int start
+ ,
+ int max
+ ,
+ String orderby
+ ,
+ boolean asc
+ )
+ </i><br/>
+ <p>
+ Returns a List of Objects of Rooms You can use "name" as value for
+ orderby or rooms_id. It also fills the attribute currentUsers in the
+ Room-Object
+ </p>
+ <p>
+ Return Type: org.openmeetings.app.data.beans.basic.SearchResult
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ int
+ </td>
+ <td valign="top">start</td>
+ <td valign="top">The id you want to start</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ int
+ </td>
+ <td valign="top">max</td>
+ <td valign="top">The maximum you want to get</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">orderby</td>
+ <td valign="top">The column it will be ordered</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ boolean
+ </td>
+ <td valign="top">asc</td>
+ <td valign="top">Asc or Desc sort ordering</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/getRoomsWithCurrentUsers?SID=VALUE&start=VALUE&max=VALUE&orderby=VALUE&asc=VALUE">http://localhost:5080/openmeetings/services/RoomService/getRoomsWithCurrentUsers?SID=VALUE&start=VALUE&max=VALUE&orderby=VALUE&asc=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoom" ><b>addRoom</b></a>
+ </div>
+ </div>
+
+ Method: <i>addRoom (
+ String SID
+ ,
+ String name
+ ,
+ Long roomtypes_id
+ ,
+ String comment
+ ,
+ Long numberOfPartizipants
+ ,
+ Boolean ispublic
+ ,
+ Integer videoPodWidth
+ ,
+ Integer videoPodHeight
+ ,
+ Integer videoPodXPosition
+ ,
+ Integer videoPodYPosition
+ ,
+ Integer moderationPanelXPosition
+ ,
+ Boolean showWhiteBoard
+ ,
+ Integer whiteBoardPanelXPosition
+ ,
+ Integer whiteBoardPanelYPosition
+ ,
+ Integer whiteBoardPanelHeight
+ ,
+ Integer whiteBoardPanelWidth
+ ,
+ Boolean showFilesPanel
+ ,
+ Integer filesPanelXPosition
+ ,
+ Integer filesPanelYPosition
+ ,
+ Integer filesPanelHeight
+ ,
+ Integer filesPanelWidth
+ )
+ </i><br/>
+ <p>
+ TODO: Fix Organization Issue
+
+ deprecated use addRoomWithModeration instead
+ </p>
+ <p>
+ Return Type: java.lang.Long
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">name</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomtypes_id</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">comment</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">numberOfPartizipants</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">ispublic</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">videoPodWidth</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">videoPodHeight</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">videoPodXPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">videoPodYPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">moderationPanelXPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">showWhiteBoard</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">whiteBoardPanelXPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">whiteBoardPanelYPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">whiteBoardPanelHeight</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">whiteBoardPanelWidth</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">showFilesPanel</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">filesPanelXPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">filesPanelYPosition</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">filesPanelHeight</td>
+ <td valign="top"></td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">filesPanelWidth</td>
+ <td valign="top"></td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/addRoom?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&videoPodWidth=VALUE&videoPodHeight=VALUE&videoPodXPosition=VALUE&videoPodYPosition=VALUE&moderationPanelXPosition=VALUE&showWhiteBoard=VALUE&whiteBoardPanelXPosition=VALUE&whiteBoardPanelYPosition=VALUE&whiteBoardPanelHeight=VALUE&whiteBoardPanelWidth=VALUE&showFilesPanel=VALUE&filesPanelXPosition=VALUE&filesPanelYPosition=VALUE&filesPanelHeight=VALUE&filesPanelWidth=VALUE">http:
//localhost:5080/openmeetings/services/RoomService/addRoom?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&videoPodWidth=VALUE&videoPodHeight=VALUE&videoPodXPosition=VALUE&videoPodYPosition=VALUE&moderationPanelXPosition=VALUE&showWhiteBoard=VALUE&whiteBoardPanelXPosition=VALUE&whiteBoardPanelYPosition=VALUE&whiteBoardPanelHeight=VALUE&whiteBoardPanelWidth=VALUE&showFilesPanel=VALUE&filesPanelXPosition=VALUE&filesPanelYPosition=VALUE&filesPanelHeight=VALUE&filesPanelWidth=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModeration" ><b>addRoomWithModeration</b></a>
+ </div>
+ </div>
+
+ Method: <i>addRoomWithModeration (
+ String SID
+ ,
+ String name
+ ,
+ Long roomtypes_id
+ ,
+ String comment
+ ,
+ Long numberOfPartizipants
+ ,
+ Boolean ispublic
+ ,
+ Boolean appointment
+ ,
+ Boolean isDemoRoom
+ ,
+ Integer demoTime
+ ,
+ Boolean isModeratedRoom
+ )
+ </i><br/>
+ <p>
+ Create a conference room
+ </p>
+ <p>
+ Return Type: java.lang.Long
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">name</td>
+ <td valign="top">Name of the Room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomtypes_id</td>
+ <td valign="top">Type of that room (1 = Conference, 2 = Audience, 3 =
+ Restricted, 4 = Interview)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">comment</td>
+ <td valign="top">any comment</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">numberOfPartizipants</td>
+ <td valign="top">the maximum users allowed in this room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">ispublic</td>
+ <td valign="top">If this room is public (use true if you don't deal with
+ different Organizations)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">appointment</td>
+ <td valign="top">is it a Calendar Room (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isDemoRoom</td>
+ <td valign="top">is it a Demo Room with limited time (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">demoTime</td>
+ <td valign="top">time in seconds after the user will be logged out (only
+ enabled if isDemoRoom is true)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isModeratedRoom</td>
+ <td valign="top">Users have to wait untill a Moderator arrives. Use the
+ becomeModerator param in setUserObjectAndGenerateRoomHash to
+ set a user as default Moderator</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/addRoomWithModeration?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE">http://localhost:5080/openmeetings/services/RoomService/addRoomWithModeration?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModerationAndQuestions" ><b>addRoomWithModerationAndQuestions</b></a>
+ </div>
+ </div>
+
+ Method: <i>addRoomWithModerationAndQuestions (
+ String SID
+ ,
+ String name
+ ,
+ Long roomtypes_id
+ ,
+ String comment
+ ,
+ Long numberOfPartizipants
+ ,
+ Boolean ispublic
+ ,
+ Boolean appointment
+ ,
+ Boolean isDemoRoom
+ ,
+ Integer demoTime
+ ,
+ Boolean isModeratedRoom
+ ,
+ Boolean allowUserQuestions
+ )
+ </i><br/>
+ <p>
+ this SOAP Method has an additional param to enable or disable the buttons
+ to apply for moderation this does only work in combination with the
+ room-type restricted
+ </p>
+ <p>
+ Return Type: java.lang.Long
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">name</td>
+ <td valign="top">Name of the Room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomtypes_id</td>
+ <td valign="top">Type of that room (1 = Conference, 2 = Audience, 3 =
+ Restricted, 4 = Interview)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">comment</td>
+ <td valign="top">any comment</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">numberOfPartizipants</td>
+ <td valign="top">the maximum users allowed in this room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">ispublic</td>
+ <td valign="top">If this room is public (use true if you don't deal with
+ different Organizations)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">appointment</td>
+ <td valign="top">is it a Calendar Room (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isDemoRoom</td>
+ <td valign="top">is it a Demo Room with limited time (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">demoTime</td>
+ <td valign="top">time in seconds after the user will be logged out (only
+ enabled if isDemoRoom is true)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isModeratedRoom</td>
+ <td valign="top">Users have to wait untill a Moderator arrives. Use the
+ becomeModerator param in setUserObjectAndGenerateRoomHash to
+ set a user as default Moderator</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">allowUserQuestions</td>
+ <td valign="top">enable or disable the button to allow users to apply for
+ moderation</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/addRoomWithModerationAndQuestions?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE&allowUserQuestions=VALUE">http://localhost:5080/openmeetings/services/RoomService/addRoomWithModerationAndQuestions?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE&allowUserQuestions=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModerationQuestionsAndAudioType" ><b>addRoomWithModerationQuestionsAndAudioType</b></a>
+ </div>
+ </div>
+
+ Method: <i>addRoomWithModerationQuestionsAndAudioType (
+ String SID
+ ,
+ String name
+ ,
+ Long roomtypes_id
+ ,
+ String comment
+ ,
+ Long numberOfPartizipants
+ ,
+ Boolean ispublic
+ ,
+ Boolean appointment
+ ,
+ Boolean isDemoRoom
+ ,
+ Integer demoTime
+ ,
+ Boolean isModeratedRoom
+ ,
+ Boolean allowUserQuestions
+ ,
+ Boolean isAudioOnly
+ )
+ </i><br/>
+ <p>
+ adds a new room with options for user questions and audio only
+ </p>
+ <p>
+ Return Type: java.lang.Long
+ </p>
+ <p>Params:</p>
+
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">SID</td>
+ <td valign="top">The SID of the User. This SID must be marked as Loggedin</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">name</td>
+ <td valign="top">Name of the Room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomtypes_id</td>
+ <td valign="top">Type of that room (1 = Conference, 2 = Audience, 3 =
+ Restricted, 4 = Interview)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">comment</td>
+ <td valign="top">any comment</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">numberOfPartizipants</td>
+ <td valign="top">the maximum users allowed in this room</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">ispublic</td>
+ <td valign="top">If this room is public (use true if you don't deal with
+ different Organizations)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">appointment</td>
+ <td valign="top">is it a Calendar Room (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isDemoRoom</td>
+ <td valign="top">is it a Demo Room with limited time (use false by default)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Integer
+ </td>
+ <td valign="top">demoTime</td>
+ <td valign="top">time in seconds after the user will be logged out (only
+ enabled if isDemoRoom is true)</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isModeratedRoom</td>
+ <td valign="top">Users have to wait until a Moderator arrives. Use the
+ becomeModerator param in setUserObjectAndGenerateRoomHash to
+ set a user as default Moderator</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">allowUserQuestions</td>
+ <td valign="top">enable or disable the button to allow users to apply for
+ moderation</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Boolean
+ </td>
+ <td valign="top">isAudioOnly</td>
+ <td valign="top">enable or disable the video / or audio-only</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/RoomService/addRoomWithModerationQuestionsAndAudioType?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE&allowUserQuestions=VALUE&isAudioOnly=VALUE">http://localhost:5080/openmeetings/services/RoomService/addRoomWithModerationQuestionsAndAudioType?SID=VALUE&name=VALUE&roomtypes_id=VALUE&comment=VALUE&numberOfPartizipants=VALUE&ispublic=VALUE&appointment=VALUE&isDemoRoom=VALUE&demoTime=VALUE&isModeratedRoom=VALUE&allowUserQuestions=VALUE&isAudioOnly=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomIdByExternalId" ><b>getRoomIdByExternalId</b></a>
+ </div>
+ </div>
+
+ Method: <i>getRoomIdByExternalId (
+ String SID
+ ,
+ String name
[... 2799 lines stripped ...]