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/18 15:13:10 UTC
svn commit: r1220411 [2/2] - in
/incubator/openmeetings/trunk/singlewebapp/docs: FileService.html
RoomService.html UserService.html WebserviceIndex.html
Modified: incubator/openmeetings/trunk/singlewebapp/docs/UserService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/UserService.html?rev=1220411&r1=1220410&r2=1220411&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/UserService.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/UserService.html Sun Dec 18 14:13:10 2011
@@ -39,7 +39,7 @@ limitations under the License.
<hr />
<h3>WebService: UserService</h3>
- <p>The Service contains methods to login and create hash to directly enter
+ <p>The Service contains methods to login and create hash to directly enter
conference rooms, recordings or the application in general<p>
<p>WSDL sample Url: <a href="http://localhost:5080/openmeetings/services/UserService?wsdl">http://localhost:5080/openmeetings/services/UserService?wsdl</a><p>
@@ -49,39 +49,39 @@ limitations under the License.
<div class="navigation">
<div>
<a href="#getSession"><b>getSession</b></a><br/>
- <div class="navigation_comment"><i >load this session id before doing anything else Returns an Object of Type
+ <div class="navigation_comment"><i >load this session id before doing anything else Returns an Object of Type
Sessiondata, this contains a sessionId, use that sessionId in all Methods</i></div>
</div>
<div>
<a href="#loginUser"><b>loginUser</b></a><br/>
- <div class="navigation_comment"><i >uth function, use the SID you get by getSession, return positive means
- logged-in, if negative its an ErrorCode, you have to invoke the Method
+ <div class="navigation_comment"><i >uth function, use the SID you get by getSession, return positive means
+ logged-in, if negative its an ErrorCode, you have to invoke the Method
getErrorByCode to get the Text-Description of that ErrorCode</i></div>
</div>
<div>
<a href="#getErrorByCode"><b>getErrorByCode</b></a><br/>
- <div class="navigation_comment"><i >loads an Error-Object. If a Method returns a negative Result, its an
- Error-id, it needs a language_id to specify in which language you want to
- display/read the error-message. English has the Language-ID one, for
+ <div class="navigation_comment"><i >loads an Error-Object. If a Method returns a negative Result, its an
+ Error-id, it needs a language_id to specify in which language you want to
+ display/read the error-message. English has the Language-ID one, for
different one see the list of languages</i></div>
</div>
<div>
<a href="#addNewUser"><b>addNewUser</b></a><br/>
- <div class="navigation_comment"><i >Adds a new Usre like through the Frontend, but also does activates the
+ <div class="navigation_comment"><i >Adds a new Usre like through the Frontend, but also does activates the
Account To do SSO see the methods to create a hash and use those ones!</i></div>
</div>
<div>
<a href="#addNewUserWithTimeZone"><b>addNewUserWithTimeZone</b></a><br/>
- <div class="navigation_comment"><i >Adds a new User like through the Frontend, but also does activates the
+ <div class="navigation_comment"><i >Adds a new User like through the Frontend, but also does activates the
Account</i></div>
</div>
<div>
<a href="#addNewUserWithExternalType"><b>addNewUserWithExternalType</b></a><br/>
- <div class="navigation_comment"><i >Adds a new User like through the Frontend, but also does activates the
- Account, sends NO email (no matter what you configured) and sets the
- users external user id and type
-
- Use the methods to create a hash for SSO, creating users is not required
+ <div class="navigation_comment"><i >Adds a new User like through the Frontend, but also does activates the
+ Account, sends NO email (no matter what you configured) and sets the
+ users external user id and type
+
+ Use the methods to create a hash for SSO, creating users is not required
for SSO</i></div>
</div>
<div>
@@ -94,69 +94,69 @@ limitations under the License.
</div>
<div>
<a href="#setUserObject"><b>setUserObject</b></a><br/>
- <div class="navigation_comment"><i >deprecated use setUserObjectAndGenerateRoomHash
-
- Description: sets the SessionObject for a certain SID, after setting this
+ <div class="navigation_comment"><i >deprecated use setUserObjectAndGenerateRoomHash
+
+ Description: sets the SessionObject for a certain SID, after setting this
Session-Object you can use the SID + a RoomId to enter any Room.</i></div>
</div>
<div>
<a href="#setUserObjectWithExternalUser"><b>setUserObjectWithExternalUser</b></a><br/>
- <div class="navigation_comment"><i >deprecated use setUserObjectAndGenerateRoomHash
-
- Description: sets the SessionObject for a certain SID, after setting this
+ <div class="navigation_comment"><i >deprecated use setUserObjectAndGenerateRoomHash
+
+ Description: sets the SessionObject for a certain SID, after setting this
Session-Object you can use the SID + a RoomId to enter any Room.</i></div>
</div>
<div>
<a href="#setUserObjectAndGenerateRoomHash"><b>setUserObjectAndGenerateRoomHash</b></a><br/>
- <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room. ...
+ <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room. ...
Session-Hashs are deleted 15 minutes after the creation if not used.</i></div>
</div>
<div>
<a href="#setUserObjectAndGenerateRoomHashByURL"><b>setUserObjectAndGenerateRoomHashByURL</b></a><br/>
- <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
+ <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
deleted 15 minutes after the creation if not used.</i></div>
</div>
<div>
<a href="#setUserObjectAndGenerateRoomHashByURLAndRecFlag"><b>setUserObjectAndGenerateRoomHashByURLAndRecFlag</b></a><br/>
- <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
- deleted 15 minutes after the creation if not used.
-
+ <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
+ deleted 15 minutes after the creation if not used.
+
++ sets the flag if the user can do recording in the conference room</i></div>
</div>
<div>
<a href="#setUserObjectMainLandingZone"><b>setUserObjectMainLandingZone</b></a><br/>
- <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID and directly login into the dashboard
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
+ <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID and directly login into the dashboard
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
deleted 15 minutes after the creation if not used.</i></div>
</div>
<div>
<a href="#setUserAndNickName"><b>setUserAndNickName</b></a><br/>
- <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
- deleted 15 minutes after the creation if not used.
-
- ++ Additionally you can set a param showNickNameDialogAsInt, the effect
- if that param is 1 is, that the user gets a popup where he can enter his
- nickname right before he enters the conference room. All nicknames and
+ <div class="navigation_comment"><i >Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
+ deleted 15 minutes after the creation if not used.
+
+ ++ Additionally you can set a param showNickNameDialogAsInt, the effect
+ if that param is 1 is, that the user gets a popup where he can enter his
+ nickname right before he enters the conference room. All nicknames and
emails users enter are logged in the conferencelog table.</i></div>
</div>
<div>
@@ -190,7 +190,7 @@ limitations under the License.
)
</i><br/>
<p>
- load this session id before doing anything else Returns an Object of Type
+ load this session id before doing anything else Returns an Object of Type
Sessiondata, this contains a sessionId, use that sessionId in all Methods
</p>
<p>
@@ -220,8 +220,8 @@ limitations under the License.
)
</i><br/>
<p>
- uth function, use the SID you get by getSession, return positive means
- logged-in, if negative its an ErrorCode, you have to invoke the Method
+ uth function, use the SID you get by getSession, return positive means
+ logged-in, if negative its an ErrorCode, you have to invoke the Method
getErrorByCode to get the Text-Description of that ErrorCode
</p>
<p>
@@ -285,9 +285,9 @@ limitations under the License.
)
</i><br/>
<p>
- loads an Error-Object. If a Method returns a negative Result, its an
- Error-id, it needs a language_id to specify in which language you want to
- display/read the error-message. English has the Language-ID one, for
+ loads an Error-Object. If a Method returns a negative Result, its an
+ Error-id, it needs a language_id to specify in which language you want to
+ display/read the error-message. English has the Language-ID one, for
different one see the list of languages
</p>
<p>
@@ -373,7 +373,7 @@ limitations under the License.
)
</i><br/>
<p>
- Adds a new Usre like through the Frontend, but also does activates the
+ Adds a new Usre like through the Frontend, but also does activates the
Account To do SSO see the methods to create a hash and use those ones!
</p>
<p>
@@ -499,8 +499,8 @@ limitations under the License.
String
</td>
<td valign="top">baseURL</td>
- <td valign="top">the baseURL is needed to send the Initial Email correctly to
- that User, otherwise the Link in the EMail that the new User
+ <td valign="top">the baseURL is needed to send the Initial Email correctly to
+ that User, otherwise the Link in the EMail that the new User
will reveive is not valid</td>
</tr>
@@ -551,7 +551,7 @@ limitations under the License.
)
</i><br/>
<p>
- Adds a new User like through the Frontend, but also does activates the
+ Adds a new User like through the Frontend, but also does activates the
Account
</p>
<p>
@@ -677,8 +677,8 @@ limitations under the License.
String
</td>
<td valign="top">baseURL</td>
- <td valign="top">the baseURL is needed to send the Initial Email correctly to
- that User, otherwise the Link in the EMail that the new User
+ <td valign="top">the baseURL is needed to send the Initial Email correctly to
+ that User, otherwise the Link in the EMail that the new User
will reveive is not valid</td>
</tr>
@@ -739,11 +739,11 @@ limitations under the License.
)
</i><br/>
<p>
- Adds a new User like through the Frontend, but also does activates the
- Account, sends NO email (no matter what you configured) and sets the
- users external user id and type
-
- Use the methods to create a hash for SSO, creating users is not required
+ Adds a new User like through the Frontend, but also does activates the
+ Account, sends NO email (no matter what you configured) and sets the
+ users external user id and type
+
+ Use the methods to create a hash for SSO, creating users is not required
for SSO
</p>
<p>
@@ -1033,9 +1033,9 @@ limitations under the License.
)
</i><br/>
<p>
- deprecated use setUserObjectAndGenerateRoomHash
-
- Description: sets the SessionObject for a certain SID, after setting this
+ deprecated use setUserObjectAndGenerateRoomHash
+
+ Description: sets the SessionObject for a certain SID, after setting this
Session-Object you can use the SID + a RoomId to enter any Room.
</p>
<p>
@@ -1133,9 +1133,9 @@ limitations under the License.
)
</i><br/>
<p>
- deprecated use setUserObjectAndGenerateRoomHash
-
- Description: sets the SessionObject for a certain SID, after setting this
+ deprecated use setUserObjectAndGenerateRoomHash
+
+ Description: sets the SessionObject for a certain SID, after setting this
Session-Object you can use the SID + a RoomId to enter any Room.
</p>
<p>
@@ -1255,8 +1255,8 @@ limitations under the License.
)
</i><br/>
<p>
- Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room. ...
+ Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room. ...
Session-Hashs are deleted 15 minutes after the creation if not used.
</p>
<p>
@@ -1358,7 +1358,7 @@ limitations under the License.
int
</td>
<td valign="top">showAudioVideoTestAsInt</td>
- <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
+ <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
Test Application before the user is logged into the room</td>
</tr>
@@ -1401,12 +1401,12 @@ limitations under the License.
)
</i><br/>
<p>
- Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
+ Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
deleted 15 minutes after the creation if not used.
</p>
<p>
@@ -1508,7 +1508,7 @@ limitations under the License.
int
</td>
<td valign="top">showAudioVideoTestAsInt</td>
- <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
+ <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
Test Application before the user is logged into the room</td>
</tr>
@@ -1553,14 +1553,14 @@ limitations under the License.
)
</i><br/>
<p>
- Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
- deleted 15 minutes after the creation if not used.
-
+ Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
+ deleted 15 minutes after the creation if not used.
+
++ sets the flag if the user can do recording in the conference room
</p>
<p>
@@ -1662,7 +1662,7 @@ limitations under the License.
int
</td>
<td valign="top">showAudioVideoTestAsInt</td>
- <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
+ <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
Test Application before the user is logged into the room</td>
</tr>
@@ -1707,12 +1707,12 @@ limitations under the License.
)
</i><br/>
<p>
- Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID and directly login into the dashboard
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
+ Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID and directly login into the dashboard
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
deleted 15 minutes after the creation if not used.
</p>
<p>
@@ -1834,17 +1834,17 @@ limitations under the License.
)
</i><br/>
<p>
- Description: sets the SessionObject for a certain SID, after setting this
- Session-Object you can use the SID + a RoomId to enter any Room.
-
- ++ the user can press f5 to reload the page / use the link several times,
- the SOAP Gateway does remember the IP of the user and the will only the
- first user that enters the room allow to re-enter. ... Session-Hashs are
- deleted 15 minutes after the creation if not used.
-
- ++ Additionally you can set a param showNickNameDialogAsInt, the effect
- if that param is 1 is, that the user gets a popup where he can enter his
- nickname right before he enters the conference room. All nicknames and
+ Description: sets the SessionObject for a certain SID, after setting this
+ Session-Object you can use the SID + a RoomId to enter any Room.
+
+ ++ the user can press f5 to reload the page / use the link several times,
+ the SOAP Gateway does remember the IP of the user and the will only the
+ first user that enters the room allow to re-enter. ... Session-Hashs are
+ deleted 15 minutes after the creation if not used.
+
+ ++ Additionally you can set a param showNickNameDialogAsInt, the effect
+ if that param is 1 is, that the user gets a popup where he can enter his
+ nickname right before he enters the conference room. All nicknames and
emails users enter are logged in the conferencelog table.
</p>
<p>
@@ -1946,7 +1946,7 @@ limitations under the License.
int
</td>
<td valign="top">showAudioVideoTestAsInt</td>
- <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
+ <td valign="top">0 means don't show Audio/Video Test, 1 means show Audio/Video
Test Application before the user is logged into the room</td>
</tr>
@@ -1955,7 +1955,7 @@ limitations under the License.
int
</td>
<td valign="top">showNickNameDialogAsInt</td>
- <td valign="top">0 means do not show the popup to enter a nichname, 1 means
+ <td valign="top">0 means do not show the popup to enter a nichname, 1 means
that there is a popup to enter the nickname for the conference</td>
</tr>
@@ -2059,7 +2059,7 @@ limitations under the License.
Long
</td>
<td valign="top">recording_id</td>
- <td valign="top">the id of the recording, get a List of all Recordings with
+ <td valign="top">the id of the recording, get a List of all Recordings with
RoomService::getFlvRecordingByExternalRoomType</td>
</tr>
@@ -2289,7 +2289,7 @@ limitations under the License.
String
</td>
<td valign="top">publicSID</td>
- <td valign="top">the publicSID (you can get it from the call to get users in a
+ <td valign="top">the publicSID (you can get it from the call to get users in a
room)</td>
</tr>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html?rev=1220411&r1=1220410&r2=1220411&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html Sun Dec 18 14:13:10 2011
@@ -32,7 +32,7 @@ limitations under the License.
<div class="navigation">
<div>
<a href="UserService.html" target="_PARENT"><b>UserService</b></a><br/>
- <div class="navigation_comment"><i >The Service contains methods to login and create hash to directly enter
+ <div class="navigation_comment"><i >The Service contains methods to login and create hash to directly enter
conference rooms, recordings or the application in general</i></div>
</div>
<div>
@@ -41,7 +41,7 @@ limitations under the License.
</div>
<div>
<a href="FileService.html" target="_PARENT"><b>FileService</b></a><br/>
- <div class="navigation_comment"><i >Contains methods to import and upload files into the Files section of the
+ <div class="navigation_comment"><i >Contains methods to import and upload files into the Files section of the
conference room and the personal drive of any user</i></div>
</div>
</div>