Revision: 4716
Author: seba.wagner
Date: Tue Dec 13 11:26:54 2011
Log: Update documentation task and style output using velocity template
http://code.google.com/p/openmeetings/source/detail?r=4716
Added:
/trunk/singlewebapp/docs/openmeetings_docs.css
Modified:
/trunk/singlewebapp/docs/ApiMethodsTemplate.vm
/trunk/singlewebapp/docs/RoomWebService.html
/trunk/singlewebapp/src/roomservice/org/openmeetings/axis/services/RoomWebService.java
=======================================
--- /dev/null
+++ /trunk/singlewebapp/docs/openmeetings_docs.css Tue Dec 13 11:26:54 2011
@@ -0,0 +1,40 @@
+/*
+* Licensed to the Apache Software Foundation (ASF) under one or more
+* contributor license agreements. See the NOTICE file distributed with
+* this work for additional information regarding copyright ownership.
+* The ASF licenses this file to You 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.
+*/
+body {
+ font: 10pt Verdana, Arial, Helvetica, sans-serif;
+}
+table {
+ margin-left: 20px;
+ border-color: #000000;
+}
+th {
+ background-color: #dddddd;
+}
+.method {
+ margin-top: 20px;
+ width: 100%;
+}
+.method_header {
+ background-color: #cccccc;
+ width: 100%;
+}
+.navigation {
+ margin-left: 40px;
+}
+.navigation_comment {
+ margin-left: 20px;
+}
=======================================
--- /trunk/singlewebapp/docs/ApiMethodsTemplate.vm Tue Dec 13 10:22:14 2011
+++ /trunk/singlewebapp/docs/ApiMethodsTemplate.vm Tue Dec 13 11:26:54 2011
@@ -25,6 +25,7 @@
<meta name="author" value="OpenMeetings Team">
<meta name="email" value="[email protected]">
<title>OpenMeetings API Methods</title>
+ <link rel="stylesheet" type="text/css"
href="openmeetings_docs.css">
</head>
<body>
@@ -32,10 +33,28 @@
<p>$classComment<p>
<p>WSDL sample Url: <a
href="http://localhost:5080/openmeetings/services/$webServiceName?wsdl";>http://localhost:5080/openmeetings/services/$webServiceName?wsdl</a><p>
+ <!-- Links to Methods -->
+ <h3>Index of Methods available in $className</h3>
+
+ <div class="navigation">
+ #foreach ( $method in $methods )
+ #if ($method.isPublic())
+ <div>
+ <a href="#$method.name()"><b>$method.name()</b></a><br/>
+ <div class="navigation_comment"><i
$method.commentText()</div>
+ </div>
+ #end
+ #end
+ </div>
+
+ <h3>Methods Details in $className</h3>
+
#foreach ( $method in $methods )
#if ($method.isPublic())
- <hr width="100%" />
- <a name="$method.name()"><b>$method.name() (
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="$method.name()" ><b>$method.name() (
#set ($index = 0)
#foreach ( $parameter in $method.parameters() )
#if ($index > 0)
@@ -46,19 +65,24 @@
#end
)
</b></a>
+ </div>
+ </div>
<p>
$method.commentText()
</p>
<p>
Return Type: $method.returnType()
</p>
-
- <table style="margin-left:20px">
+ <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>
#set ($index = 0)
#foreach ( $parameter in $method.paramTags() )
<tr>
@@ -71,7 +95,9 @@
#set ($index = $index+1)
#end
+ </tbody>
</table>
+ </div>
#end
#end
=======================================
--- /trunk/singlewebapp/docs/RoomWebService.html Tue Dec 13 10:22:14 2011
+++ /trunk/singlewebapp/docs/RoomWebService.html Tue Dec 13 11:26:54 2011
@@ -25,6 +25,7 @@
<meta name="author" value="OpenMeetings Team">
<meta name="email" value="[email protected]">
<title>OpenMeetings API Methods</title>
+ <link rel="stylesheet" type="text/css"
href="openmeetings_docs.css">
</head>
<body>
@@ -32,13 +33,206 @@
<p>RoomService contains methods to manipulate rooms and create
invitation hash<p>
<p>WSDL sample Url: <a
href="http://localhost:5080/openmeetings/services/RoomWebService?wsdl";>http://localhost:5080/openmeetings/services/RoomWebService?wsdl</a><p>
- <hr width="100%" />
- <a name="getRoomsPublic"><b>getRoomsPublic (
+ <!-- Links to Methods -->
+ <h3>Index of Methods available in RoomWebService</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.</div>
+ </div>
+ <div>
+ <a
href="#deleteFlvRecording"><b>deleteFlvRecording</b></a><br/>
+ <div class="navigation_comment"><i >Deletes a flv
recording</div>
+ </div>
+ <div>
+ <a
href="#getFlvRecordingByExternalUserId"><b>getFlvRecordingByExternalUserId</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv
recordings</div>
+ </div>
+ <div>
+ <a
href="#getFlvRecordingByExternalRoomTypeAndCreator"><b>getFlvRecordingByExternalRoomTypeAndCreator</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv
recordings</div>
+ </div>
+ <div>
+ <a
href="#getFlvRecordingByExternalRoomTypeByList"><b>getFlvRecordingByExternalRoomTypeByList</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv
recordings</div>
+ </div>
+ <div>
+ <a
href="#getFlvRecordingByExternalRoomType"><b>getFlvRecordingByExternalRoomType</b></a><br/>
+ <div class="navigation_comment"><i >Gets a list of flv
recordings</div>
+ </div>
+ <div>
+ <a
href="#getFlvRecordingByRoomId"><b>getFlvRecordingByRoomId</b></a><br/>
+ <div class="navigation_comment"><i >Get list of
recordings</div>
+ </div>
+ <div>
+ <a href="#getRoomTypes"><b>getRoomTypes</b></a><br/>
+ <div class="navigation_comment"><i >List of available room
types</div>
+ </div>
+ <div>
+ <a href="#getRoomCounters"><b>getRoomCounters</b></a><br/>
+ <div class="navigation_comment"><i >Returns current users
for rooms ids</div>
+ </div>
+ <div>
+ <a href="#getRoomById"><b>getRoomById</b></a><br/>
+ <div class="navigation_comment"><i >returns a conference
room object</div>
+ </div>
+ <div>
+ <a
href="#getRoomWithCurrentUsersById"><b>getRoomWithCurrentUsersById</b></a><br/>
+ <div class="navigation_comment"><i ></div>
+ </div>
+ <div>
+ <a
href="#getRoomWithClientObjectsById"><b>getRoomWithClientObjectsById</b></a><br/>
+ <div class="navigation_comment"><i >Returns a object of
type RoomReturn</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</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</div>
+ </div>
+ <div>
+ <a href="#addRoom"><b>addRoom</b></a><br/>
+ <div class="navigation_comment"><i >TODO: Fix Organization
Issue
+
+ deprecated use addRoomWithModeration instead</div>
+ </div>
+ <div>
+ <a
href="#addRoomWithModeration"><b>addRoomWithModeration</b></a><br/>
+ <div class="navigation_comment"><i >Create a conference
room</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</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</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</div>
+ </div>
+ <div>
+ <a href="#updateRoom"><b>updateRoom</b></a><br/>
+ <div class="navigation_comment"><i >TODO: Fix Organization
Issue deprecated use updateRoomWithModeration</div>
+ </div>
+ <div>
+ <a
href="#updateRoomWithModeration"><b>updateRoomWithModeration</b></a><br/>
+ <div class="navigation_comment"><i >Updates a conference
room by its room id</div>
+ </div>
+ <div>
+ <a
href="#updateRoomWithModerationAndQuestions"><b>updateRoomWithModerationAndQuestions</b></a><br/>
+ <div class="navigation_comment"><i ></div>
+ </div>
+ <div>
+ <a href="#deleteRoom"><b>deleteRoom</b></a><br/>
+ <div class="navigation_comment"><i >Delete a room by its
room id</div>
+ </div>
+ <div>
+ <a href="#kickUser"><b>kickUser</b></a><br/>
+ <div class="navigation_comment"><i >kick all uses of a
certain room</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</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</div>
+ </div>
+ <div>
+ <a
href="#addRoomWithModerationAndRecordingFlags"><b>addRoomWithModerationAndRecordingFlags</b></a><br/>
+ <div class="navigation_comment"><i >Adds a new room with
options for recording</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</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)</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)</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)</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</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</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</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.</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</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.</div>
+ </div>
+ </div>
+
+ <h3>Methods Details in RoomWebService</h3>
+
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomsPublic" ><b>getRoomsPublic (
String SID
,
Long roomtypes_id
)
</b></a>
+ </div>
+ </div>
<p>
Returns an Object of Type RoomsList which contains a
list of
Room-Objects. Every Room-Object contains a Roomtype and all informations
@@ -49,13 +243,16 @@
<p>
Return Type:
org.openmeetings.app.persistence.beans.rooms.Rooms[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -72,27 +269,36 @@
<td valign="top"></th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="deleteFlvRecording"><b>deleteFlvRecording (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="deleteFlvRecording" ><b>deleteFlvRecording (
String SID
,
Long flvRecordingId
)
</b></a>
+ </div>
+ </div>
<p>
Deletes a flv recording
</p>
<p>
Return Type: boolean
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -109,27 +315,36 @@
<td valign="top">the id of the recording</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getFlvRecordingByExternalUserId"><b>getFlvRecordingByExternalUserId (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalUserId"
<b>getFlvRecordingByExternalUserId (
String SID
,
String externalUserId
)
</b></a>
+ </div>
+ </div>
<p>
Gets a list of flv recordings
</p>
<p>
Return Type:
org.openmeetings.axis.services.FLVRecordingReturn[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -146,9 +361,13 @@
<td valign="top">the externalUserId</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getFlvRecordingByExternalRoomTypeAndCreator"><b>getFlvRecordingByExternalRoomTypeAndCreator
(
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomTypeAndCreator"
<b>getFlvRecordingByExternalRoomTypeAndCreator (
String SID
,
String externalRoomType
@@ -156,19 +375,24 @@
Long insertedBy
)
</b></a>
+ </div>
+ </div>
<p>
Gets a list of flv recordings
</p>
<p>
Return Type:
org.openmeetings.axis.services.FLVRecordingReturn[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -193,27 +417,36 @@
<td valign="top">the userId that created the
recording</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getFlvRecordingByExternalRoomTypeByList"><b>getFlvRecordingByExternalRoomTypeByList
(
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomTypeByList"
<b>getFlvRecordingByExternalRoomTypeByList (
String SID
,
String externalRoomType
)
</b></a>
+ </div>
+ </div>
<p>
Gets a list of flv recordings
</p>
<p>
Return Type: java.util.List
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -230,27 +463,36 @@
<td valign="top">externalRoomType specified when
creating the room</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getFlvRecordingByExternalRoomType"><b>getFlvRecordingByExternalRoomType
(
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByExternalRoomType"
<b>getFlvRecordingByExternalRoomType (
String SID
,
String externalRoomType
)
</b></a>
+ </div>
+ </div>
<p>
Gets a list of flv recordings
</p>
<p>
Return Type:
org.openmeetings.app.persistence.beans.flvrecord.FlvRecording[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -267,27 +509,36 @@
<td valign="top">externalRoomType specified when
creating the room</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getFlvRecordingByRoomId"><b>getFlvRecordingByRoomId (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getFlvRecordingByRoomId"
><b>getFlvRecordingByRoomId (
String SID
,
Long roomId
)
</b></a>
+ </div>
+ </div>
<p>
Get list of recordings
</p>
<p>
Return Type:
org.openmeetings.app.persistence.beans.flvrecord.FlvRecording[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -304,25 +555,34 @@
<td valign="top">the room id</th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="getRoomTypes"><b>getRoomTypes (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomTypes" ><b>getRoomTypes (
String SID
)
</b></a>
+ </div>
+ </div>
<p>
List of available room types
</p>
<p>
Return Type:
org.openmeetings.app.persistence.beans.rooms.RoomTypes[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -331,9 +591,13 @@
<td valign="top">The SID of the User. This SID must
be marked as Loggedin</th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="getRoomCounters"><b>getRoomCounters (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomCounters" ><b>getRoomCounters (
String SID
,
Integer roomId1
@@ -357,19 +621,24 @@
Integer roomId10
)
</b></a>
+ </div>
+ </div>
<p>
Returns current users for rooms ids
</p>
<p>
Return Type:
org.openmeetings.axis.services.RoomCountBean[]
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -458,27 +727,36 @@
<td valign="top"></th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="getRoomById"><b>getRoomById (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomById" ><b>getRoomById (
String SID
,
long rooms_id
)
</b></a>
+ </div>
+ </div>
<p>
returns a conference room object
</p>
<p>
Return Type:
org.openmeetings.app.persistence.beans.rooms.Rooms
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -495,27 +773,36 @@
<td valign="top">the room id</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getRoomWithCurrentUsersById"><b>getRoomWithCurrentUsersById (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomWithCurrentUsersById"
<b>getRoomWithCurrentUsersById (
String SID
,
long rooms_id
)
</b></a>
+ </div>
+ </div>
<p>
</p>
<p>
Return Type:
org.openmeetings.app.persistence.beans.rooms.Rooms
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -532,27 +819,36 @@
<td valign="top"></th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getRoomWithClientObjectsById"><b>getRoomWithClientObjectsById (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomWithClientObjectsById"
<b>getRoomWithClientObjectsById (
String SID
,
long rooms_id
)
</b></a>
+ </div>
+ </div>
<p>
Returns a object of type RoomReturn
</p>
<p>
Return Type: org.openmeetings.axis.services.RoomReturn
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -569,9 +865,13 @@
<td valign="top"></th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="getRooms"><b>getRooms (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRooms" ><b>getRooms (
String SID
,
int start
@@ -583,6 +883,8 @@
boolean asc
)
</b></a>
+ </div>
+ </div>
<p>
Returns a List of Objects of Rooms You can use "name"
as value for
orderby or rooms_id
@@ -590,13 +892,16 @@
<p>
Return Type:
org.openmeetings.app.data.beans.basic.SearchResult
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -637,9 +942,13 @@
<td valign="top">Asc or Desc sort ordering</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getRoomsWithCurrentUsers"><b>getRoomsWithCurrentUsers (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomsWithCurrentUsers"
><b>getRoomsWithCurrentUsers (
String SID
,
int start
@@ -651,6 +960,8 @@
boolean asc
)
</b></a>
+ </div>
+ </div>
<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
@@ -659,13 +970,16 @@
<p>
Return Type:
org.openmeetings.app.data.beans.basic.SearchResult
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -706,9 +1020,13 @@
<td valign="top">Asc or Desc sort ordering</th>
</tr>
- </table>
- <hr
width="100%" />
- <a name="addRoom"><b>addRoom (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoom" ><b>addRoom (
String SID
,
String name
@@ -752,6 +1070,8 @@
Integer filesPanelWidth
)
</b></a>
+ </div>
+ </div>
<p>
TODO: Fix Organization Issue
@@ -760,13 +1080,16 @@
<p>
Return Type: java.lang.Long
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -935,9 +1258,13 @@
<td valign="top"></th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="addRoomWithModeration"><b>addRoomWithModeration (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModeration"
><b>addRoomWithModeration (
String SID
,
String name
@@ -959,19 +1286,24 @@
Boolean isModeratedRoom
)
</b></a>
+ </div>
+ </div>
<p>
Create a conference room
</p>
<p>
Return Type: java.lang.Long
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -1057,9 +1389,13 @@
set a user as default Moderator</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="addRoomWithModerationAndQuestions"><b>addRoomWithModerationAndQuestions
(
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModerationAndQuestions"
<b>addRoomWithModerationAndQuestions (
String SID
,
String name
@@ -1083,6 +1419,8 @@
Boolean allowUserQuestions
)
</b></a>
+ </div>
+ </div>
<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
@@ -1091,13 +1429,16 @@
<p>
Return Type: java.lang.Long
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -1192,9 +1533,13 @@
moderation</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="addRoomWithModerationQuestionsAndAudioType"><b>addRoomWithModerationQuestionsAndAudioType
(
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="addRoomWithModerationQuestionsAndAudioType"
<b>addRoomWithModerationQuestionsAndAudioType (
String SID
,
String name
@@ -1220,19 +1565,24 @@
Boolean isAudioOnly
)
</b></a>
+ </div>
+ </div>
<p>
-
+ adds a new room with options for user questions and
audio only
</p>
<p>
Return Type: java.lang.Long
</p>
-
- <table style="margin-left:20px">
+ <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
@@ -1335,9 +1685,13 @@
<td valign="top">enable or disable the video / or
audio-only</th>
</tr>
- </table>
- <hr
width="100%" />
- <a
name="getRoomIdByExternalId"><b>getRoomIdByExternalId (
+ </tbody>
+ </table>
+ </div>
+ <div
class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getRoomIdByExternalId"
><b>getRoomIdByExternalId (
String SID
,
String name
@@ -1363,6 +1717,8 @@
String externalRoomType
)
</b></a>
+ </div>
+ </div>
<p>
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
@@ -1371,13 +1727,16 @@
<p>
Return Type: java.lang.Long
</p>
***The diff for this file has been truncated for email.***
=======================================
---
/trunk/singlewebapp/src/roomservice/org/openmeetings/axis/services/RoomWebService.java
Tue Dec 13 10:22:14 2011
+++
/trunk/singlewebapp/src/roomservice/org/openmeetings/axis/services/RoomWebService.java
Tue Dec 13 11:26:54 2011
@@ -780,6 +780,8 @@
/**
*
+ * adds a new room with options for user questions and audio only
+ *
* @param SID The SID of the User. This SID must be marked as Loggedin
* @param name
* Name of the Room
--
You received this message because you are subscribed to the Google Groups
"OpenMeetings developers" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/openmeetings-dev?hl=en.
