Fixed #255: Update javadoc documentation for 1.0.0 BETA3 release

RestComm · Dec 4, 2015 · 2f42afe · 2f42afe
1 parent 864f6fe
commit 2f42afe
Show file tree

Hide file tree

Showing 39 changed files with 787 additions and 146 deletions.
diff --git a/Examples/restcomm-helloworld/.idea/misc.xml b/Examples/restcomm-helloworld/.idea/misc.xml
diff --git a/Examples/restcomm-olympus/.idea/misc.xml b/Examples/restcomm-olympus/.idea/misc.xml
diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>All Classes</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>
@@ -21,6 +21,7 @@ <h1 class="bar">All Classes</h1>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDevice.DeviceCapability.html" title="enum in org.mobicents.restcomm.android.client.sdk" target="classFrame">RCDevice.DeviceCapability</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDevice.DeviceState.html" title="enum in org.mobicents.restcomm.android.client.sdk" target="classFrame">RCDevice.DeviceState</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDeviceListener.html" title="interface in org.mobicents.restcomm.android.client.sdk" target="classFrame"><i>RCDeviceListener</i></a></li>
+<li><a href="org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html" title="enum in org.mobicents.restcomm.android.client.sdk" target="classFrame">RCDeviceListener.RCConnectivityStatus</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCPresenceEvent.html" title="class in org.mobicents.restcomm.android.client.sdk" target="classFrame">RCPresenceEvent</a></li>
 </ul>
 </div>

diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>All Classes</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>
@@ -21,6 +21,7 @@ <h1 class="bar">All Classes</h1>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDevice.DeviceCapability.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCDevice.DeviceCapability</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDevice.DeviceState.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCDevice.DeviceState</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCDeviceListener.html" title="interface in org.mobicents.restcomm.android.client.sdk"><i>RCDeviceListener</i></a></li>
+<li><a href="org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCDeviceListener.RCConnectivityStatus</a></li>
 <li><a href="org/mobicents/restcomm/android/client/sdk/RCPresenceEvent.html" title="class in org.mobicents.restcomm.android.client.sdk">RCPresenceEvent</a></li>
 </ul>
 </div>

diff --git a/doc/constant-values.html b/doc/constant-values.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:52:59 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>Constant Field Values</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>Deprecated List</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/help-doc.html b/doc/help-doc.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>API Help</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>A-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>S-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>
@@ -67,12 +67,16 @@ <h2 class="title">S</h2>
 <dl>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#sendDigits(java.lang.String)">sendDigits(String)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
 <dd>
-<div class="block">Send DTMF digits over the connection (<b>Not Implemented yet</b>)</div>
+<div class="block">Send DTMF digits over the connection</div>
 </dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html#sendMessage(java.lang.String,%20java.util.Map)">sendMessage(String, Map&lt;String, String&gt;)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html" title="class in org.mobicents.restcomm.android.client.sdk">RCDevice</a></dt>
 <dd>
 <div class="block">Send an instant message to a an endpoint</div>
 </dd>
+<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#setAudioMuted(boolean)">setAudioMuted(boolean)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
+<dd>
+<div class="block">Mute connection so that the other party cannot hear local audio</div>
+</dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#setConnectionListener(org.mobicents.restcomm.android.client.sdk.RCConnectionListener)">setConnectionListener(RCConnectionListener)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
 <dd>
 <div class="block">Update connection listener to be receiving Connection related events.</div>
@@ -89,10 +93,8 @@ <h2 class="title">S</h2>
 <dd>
 <div class="block">Should a ringing sound be played in a incoming connection or message</div>
 </dd>
-<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#setMuted(boolean)">setMuted(boolean)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
-<dd>
-<div class="block">Mute connection so that the other party cannot local audio</div>
-</dd>
+<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCClient.html#setLogLevel(int)">setLogLevel(int)</a></span> - Static method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCClient.html" title="class in org.mobicents.restcomm.android.client.sdk">RCClient</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html#setOutgoingSoundEnabled(boolean)">setOutgoingSoundEnabled(boolean)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html" title="class in org.mobicents.restcomm.android.client.sdk">RCDevice</a></dt>
 <dd>
 <div class="block">Should a ringing sound be played in an outgoing connection or message</div>
@@ -103,6 +105,10 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#setupWebrtcAndCall(java.lang.String,%20java.util.HashMap,%20boolean)">setupWebrtcAndCall(String, HashMap&lt;String, String&gt;, boolean)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#setVideoMuted(boolean)">setVideoMuted(boolean)</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
+<dd>
+<div class="block">Mute connection so that the other party cannot see local video</div>
+</dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCClient.html#shutdown()">shutdown()</a></span> - Static method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCClient.html" title="class in org.mobicents.restcomm.android.client.sdk">RCClient</a></dt>
 <dd>
 <div class="block">Shut down the Restcomm Client</div>

diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>T-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>U-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>V-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>
@@ -81,6 +81,10 @@ <h2 class="title">V</h2>
 <dd>
 <div class="block">Returns the enum constant of this type with the specified name.</div>
 </dd>
+<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCDeviceListener.RCConnectivityStatus</a></dt>
+<dd>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCClient.ErrorCodes.html#values()">values()</a></span> - Static method in enum org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCClient.ErrorCodes.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCClient.ErrorCodes</a></dt>
 <dd>
 <div class="block">Returns an array containing the constants of this enum type, in
@@ -101,6 +105,11 @@ <h2 class="title">V</h2>
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared.</div>
 </dd>
+<dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html#values()">values()</a></span> - Static method in enum org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCDeviceListener.RCConnectivityStatus.html" title="enum in org.mobicents.restcomm.android.client.sdk">RCDeviceListener.RCConnectivityStatus</a></dt>
+<dd>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</dd>
 </dl>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">O</a>&nbsp;<a href="index-9.html">R</a>&nbsp;<a href="index-10.html">S</a>&nbsp;<a href="index-11.html">T</a>&nbsp;<a href="index-12.html">U</a>&nbsp;<a href="index-13.html">V</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->

diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>C-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>D-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>E-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Sep 08 17:53:00 EEST 2015 -->
+<!-- Generated by javadoc (version 1.7.0_79) on Fri Dec 04 14:59:16 EET 2015 -->
 <title>G-Index</title>
-<meta name="date" content="2015-09-08">
+<meta name="date" content="2015-12-04">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 </head>
 <body>
@@ -81,7 +81,7 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html#getParameters()">getParameters()</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCConnection.html" title="class in org.mobicents.restcomm.android.client.sdk">RCConnection</a></dt>
 <dd>
-<div class="block">Retrieves the set of application parameters associated with this connection <b>Not Implemented yet</b></div>
+<div class="block">Retrieves the set of application parameters associated with this connection (<b>Not Implemented yet</b>)</div>
 </dd>
 <dt><span class="strong"><a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html#getPendingConnection()">getPendingConnection()</a></span> - Method in class org.mobicents.restcomm.android.client.sdk.<a href="../org/mobicents/restcomm/android/client/sdk/RCDevice.html" title="class in org.mobicents.restcomm.android.client.sdk">RCDevice</a></dt>
 <dd>&nbsp;</dd>