openvidu-java-client JavaDoc defines http status

openvidu-java-client/src/main/java/io/openvidu/java/client/OpenVidu.java

@@ -124,6 +124,13 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>409</code>: you are trying to assign an already-in-use
+	 *             custom sessionId to the session. See
+	 *             {@link io.openvidu.java.client.SessionProperties#customSessionId()}</li>
+	 *             </ul>
 	 */
 	public Session createSession(SessionProperties properties)
 			throws OpenViduJavaClientException, OpenViduHttpException {
@@ -147,6 +154,20 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no session exists for the passed
+	 *             <i>sessionId</i></li>
+	 *             <li><code>400</code>: the session has no connected
+	 *             participants</li>
+	 *             <li><code>409</code>: the session is not configured for using
+	 *             {@link io.openvidu.java.client.MediaMode#ROUTED} or it is already
+	 *             being recorded</li>
+	 *             <li><code>501</code>: OpenVidu Server recording module is
+	 *             disabled (<i>openvidu.recording</i> property set to
+	 *             <i>false</i>)</li>
+	 *             </ul>
 	 */
 	@SuppressWarnings("unchecked")
 	public Recording startRecording(String sessionId, RecordingProperties properties)
@@ -200,6 +221,20 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no session exists for the passed
+	 *             <i>sessionId</i></li>
+	 *             <li><code>400</code>: the session has no connected
+	 *             participants</li>
+	 *             <li><code>409</code>: the session is not configured for using
+	 *             {@link io.openvidu.java.client.MediaMode#ROUTED} or it is already
+	 *             being recorded</li>
+	 *             <li><code>501</code>: OpenVidu Server recording module is
+	 *             disabled (<i>openvidu.recording</i> property set to
+	 *             <i>false</i>)</li>
+	 *             </ul>
 	 */
 	public Recording startRecording(String sessionId, String name)
 			throws OpenViduJavaClientException, OpenViduHttpException {
@@ -221,6 +256,20 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no session exists for the passed
+	 *             <i>sessionId</i></li>
+	 *             <li><code>400</code>: the session has no connected
+	 *             participants</li>
+	 *             <li><code>409</code>: the session is not configured for using
+	 *             {@link io.openvidu.java.client.MediaMode#ROUTED} or it is already
+	 *             being recorded</li>
+	 *             <li><code>501</code>: OpenVidu Server recording module is
+	 *             disabled (<i>openvidu.recording</i> property set to
+	 *             <i>false</i>)</li>
+	 *             </ul>
 	 */
 	public Recording startRecording(String sessionId) throws OpenViduJavaClientException, OpenViduHttpException {
 		return this.startRecording(sessionId, "");
@@ -236,6 +285,14 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no recording exists for the passed
+	 *             <i>recordingId</i></li>
+	 *             <li><code>406</code>: recording has <i>starting</i> status. Wait
+	 *             until <i>started</i> status before stopping the recording</li>
+	 *             </ul>
 	 */
 	public Recording stopRecording(String recordingId) throws OpenViduJavaClientException, OpenViduHttpException {
 		HttpPost request = new HttpPost(
@@ -263,6 +320,12 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no recording exists for the passed
+	 *             <i>recordingId</i></li>
+	 *             </ul>
 	 */
 	public Recording getRecording(String recordingId) throws OpenViduJavaClientException, OpenViduHttpException {
 		HttpGet request = new HttpGet(this.urlOpenViduServer + API_RECORDINGS + "/" + recordingId);
@@ -322,6 +385,14 @@ public class OpenVidu {
 	 * 
 	 * @throws OpenViduJavaClientException
 	 * @throws OpenViduHttpException
+	 *             Value returned from
+	 *             {@link io.openvidu.java.client.OpenViduHttpException#getStatus()}
+	 *             <ul>
+	 *             <li><code>404</code>: no recording exists for the passed
+	 *             <i>recordingId</i></li>
+	 *             <li><code>409</code>: the recording has <i>started</i> status.
+	 *             Stop it before deletion</li>
+	 *             </ul>
 	 */
 	public void deleteRecording(String recordingId) throws OpenViduJavaClientException, OpenViduHttpException {
 		HttpDelete request = new HttpDelete(this.urlOpenViduServer + API_RECORDINGS + "/" + recordingId);

openvidu-node-client/docs/classes/openvidu.html

@@ -185,7 +185,7 @@
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L308">OpenVidu.ts:308</a></li>
+									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L309">OpenVidu.ts:309</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -220,7 +220,7 @@
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L209">OpenVidu.ts:209</a></li>
+									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L210">OpenVidu.ts:210</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -255,7 +255,7 @@
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L254">OpenVidu.ts:254</a></li>
+									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L255">OpenVidu.ts:255</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -305,6 +305,7 @@
 								<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
 								<li><code>400</code>: the session has no connected participants</li>
 								<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
+								<li><code>501</code>: OpenVidu Server recording module is disabled (<code>openvidu.recording</code> property set to <code>false</code>)</li>
 							</ul>
 						</li>
 						<li class="tsd-description">
@@ -343,6 +344,7 @@
 								<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
 								<li><code>400</code>: the session has no connected participants</li>
 								<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
+								<li><code>501</code>: OpenVidu Server recording module is disabled (<code>openvidu.recording</code> property set to <code>false</code>)</li>
 							</ul>
 						</li>
 						<li class="tsd-description">
@@ -376,6 +378,7 @@
 								<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
 								<li><code>400</code>: the session has no connected participants</li>
 								<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
+								<li><code>501</code>: OpenVidu Server recording module is disabled (<code>openvidu.recording</code> property set to <code>false</code>)</li>
 							</ul>
 						</li>
 					</ul>
@@ -390,7 +393,7 @@
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L161">OpenVidu.ts:161</a></li>
+									<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L162">OpenVidu.ts:162</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

openvidu-node-client/lib/OpenVidu.js

@@ -62,6 +62,7 @@ var OpenVidu = /** @class */ (function () {
      * - `404`: no session exists for the passed `sessionId`
      * - `400`: the session has no connected participants
      * - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
+     * - `501`: OpenVidu Server recording module is disabled (`openvidu.recording` property set to `false`)
      */
     OpenVidu.prototype.startRecording = function (sessionId, param2) {
         var _this = this;

openvidu-node-client/src/OpenVidu.ts

@@ -79,6 +79,7 @@ export class OpenVidu {
    * - `404`: no session exists for the passed `sessionId`
    * - `400`: the session has no connected participants
    * - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
+   * - `501`: OpenVidu Server recording module is disabled (`openvidu.recording` property set to `false`)
    */
   public startRecording(sessionId: string, param2?: string | RecordingProperties): Promise<Recording> {
     return new Promise<Recording>((resolve, reject) => {