| <!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" content="OpenMeetings Team"> | |
| <meta name="email" content="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="210" name="WebserviceIndex.html" | |
| scrolling="no" marginheight="0" marginwidth="0" frameborder="0"> | |
| <p>Your Browser does not support frames ...</p> | |
| </iframe> | |
| <hr /> | |
| <h3>WebService: JabberService</h3> | |
| <p>This class provides method implementations necessary for OM to Jabber integration.<p> | |
| <p>WSDL sample Url: <a href="http://localhost:5080/openmeetings/services/JabberService?wsdl">http://localhost:5080/openmeetings/services/JabberService?wsdl</a><p> | |
| <!-- Links to Methods --> | |
| <h3>Index of Methods available in JabberService</h3> | |
| <div class="navigation"> | |
| <div> | |
| <a href="#getAvailableRooms"><b>getAvailableRooms</b></a><br/> | |
| <div class="navigation_comment"><i >Get List<Rooms> of all rooms available to the user. | |
| No admin rights are necessary for this call</i></div> | |
| </div> | |
| <div> | |
| <a href="#getUserCount"><b>getUserCount</b></a><br/> | |
| <div class="navigation_comment"><i >Returns the count of users currently in the Room with given id | |
| No admin rights are necessary for this call</i></div> | |
| </div> | |
| <div> | |
| <a href="#getInvitationHash"><b>getInvitationHash</b></a><br/> | |
| <div class="navigation_comment"><i >Get invitation hash for the room with given id | |
| No admin rights are necessary for this call</i></div> | |
| </div> | |
| </div> | |
| <h3>Methods Details in JabberService</h3> | |
| <div class="method"> | |
| <div class="method_header"> | |
| <div style="margin-left:10px"> | |
| <a name="getAvailableRooms" ><b>getAvailableRooms</b></a> | |
| </div> | |
| </div> | |
| Method: <i>getAvailableRooms ( | |
| String SID | |
| ) | |
| </i><br/> | |
| <p> | |
| Get List<Rooms> of all rooms available to the user. | |
| No admin rights are necessary for this call | |
| </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 from UserService.getSession</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| <br/> | |
| REST Sample Call/URL:<br/> | |
| <a href="http://localhost:5080/openmeetings/services/JabberService/getAvailableRooms?SID=VALUE">http://localhost:5080/openmeetings/services/JabberService/getAvailableRooms?SID=VALUE</a> | |
| </div> | |
| <div class="method"> | |
| <div class="method_header"> | |
| <div style="margin-left:10px"> | |
| <a name="getUserCount" ><b>getUserCount</b></a> | |
| </div> | |
| </div> | |
| Method: <i>getUserCount ( | |
| String SID | |
| , | |
| Long roomId | |
| ) | |
| </i><br/> | |
| <p> | |
| Returns the count of users currently in the Room with given id | |
| No admin rights are necessary for this call | |
| </p> | |
| <p> | |
| Return Type: int | |
| </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 from UserService.getSession</td> | |
| </tr> | |
| <tr> | |
| <td valign="top"> | |
| Long | |
| </td> | |
| <td valign="top">roomId</td> | |
| <td valign="top">id of the room to get users</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| <br/> | |
| REST Sample Call/URL:<br/> | |
| <a href="http://localhost:5080/openmeetings/services/JabberService/getUserCount?SID=VALUE&roomId=VALUE">http://localhost:5080/openmeetings/services/JabberService/getUserCount?SID=VALUE&roomId=VALUE</a> | |
| </div> | |
| <div class="method"> | |
| <div class="method_header"> | |
| <div style="margin-left:10px"> | |
| <a name="getInvitationHash" ><b>getInvitationHash</b></a> | |
| </div> | |
| </div> | |
| Method: <i>getInvitationHash ( | |
| String SID | |
| , | |
| String username | |
| , | |
| Long room_id | |
| ) | |
| </i><br/> | |
| <p> | |
| Get invitation hash for the room with given id | |
| No admin rights are necessary for this call | |
| </p> | |
| <p> | |
| Return Type: java.lang.String | |
| </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 from UserService.getSession</td> | |
| </tr> | |
| <tr> | |
| <td valign="top"> | |
| String | |
| </td> | |
| <td valign="top">username</td> | |
| <td valign="top">The name of invited user, will be displayed in the rooms user list</td> | |
| </tr> | |
| <tr> | |
| <td valign="top"> | |
| Long | |
| </td> | |
| <td valign="top">room_id</td> | |
| <td valign="top">id of the room to get users</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| <br/> | |
| REST Sample Call/URL:<br/> | |
| <a href="http://localhost:5080/openmeetings/services/JabberService/getInvitationHash?SID=VALUE&username=VALUE&room_id=VALUE">http://localhost:5080/openmeetings/services/JabberService/getInvitationHash?SID=VALUE&username=VALUE&room_id=VALUE</a> | |
| </div> | |
| </body> | |
| </html> | |