openvidu-browser: docs extended for property "reason" of events

2018-05-07 16:54:19 +02:00 · 2018-05-07 16:54:19 +02:00 · 818f824553
parent bc1fbed7e1
commit 818f824553
9 changed files with 40 additions and 30 deletions
--- a/openvidu-browser/docs/classes/connectionevent.html
+++ b/openvidu-browser/docs/classes/connectionevent.html
@ -161,8 +161,8 @@
 						<div class="lead">
 							<p>For &#39;connectionDestroyed&#39; event:</p>
 							<ul>
-								<li>&quot;disconnect&quot;</li>
-								<li>&quot;networkDisconnect&quot;</li>
+								<li>&quot;disconnect&quot;: the remote user has called <code>Session.disconnect()</code></li>
+								<li>&quot;networkDisconnect&quot;: the remote user network connection has dropped</li>
 							</ul>
 						</div>
 						<p>For &#39;connectionCreated&#39; empty string</p>
--- a/openvidu-browser/docs/classes/openviduerror.html
+++ b/openvidu-browser/docs/classes/openviduerror.html
@ -104,7 +104,7 @@
 					<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L41">OpenViduInternal/Enums/OpenViduError.ts:41</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L44">OpenViduInternal/Enums/OpenViduError.ts:44</a></li>
 						</ul>
 					</aside>
 				</section>
@ -114,7 +114,7 @@
 					<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <a href="../enums/openviduerrorname.html" class="tsd-signature-type">OpenViduErrorName</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L40">OpenViduInternal/Enums/OpenViduError.ts:40</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L43">OpenViduInternal/Enums/OpenViduError.ts:43</a></li>
 						</ul>
 					</aside>
 				</section>
--- a/openvidu-browser/docs/classes/sessiondisconnectedevent.html
+++ b/openvidu-browser/docs/classes/sessiondisconnectedevent.html
@ -140,8 +140,8 @@
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
 							<ul>
-								<li>&quot;disconnect&quot;</li>
-								<li>&quot;networkDisconnect&quot;</li>
+								<li>&quot;disconnect&quot;: you have called <code>Session.disconnect()</code></li>
+								<li>&quot;networkDisconnect&quot;: your network connection has dropped</li>
 							</ul>
 						</div>
 					</div>
--- a/openvidu-browser/docs/classes/streamevent.html
+++ b/openvidu-browser/docs/classes/streamevent.html
@ -146,9 +146,9 @@
 						<div class="lead">
 							<p>For &#39;streamDestroyed&#39; event:</p>
 							<ul>
-								<li>&quot;disconnect&quot;</li>
-								<li>&quot;networkDisconnect&quot;</li>
-								<li>&quot;unpublish&quot;</li>
+								<li>&quot;unpublish&quot;: method <code>Session.unpublish()</code> has been called</li>
+								<li>&quot;disconnect&quot;: method <code>Session.disconnect()</code> has been called</li>
+								<li>&quot;networkDisconnect&quot;: the user&#39;s network connection has dropped</li>
 							</ul>
 						</div>
 						<p>For &#39;streamCreated&#39; empty string</p>
--- a/openvidu-browser/docs/enums/openviduerrorname.html
+++ b/openvidu-browser/docs/enums/openviduerrorname.html
@ -67,6 +67,13 @@
 <div class="container container-main">
 	<div class="row">
 		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-comment">
+				<div class="tsd-comment tsd-typography">
+					<div class="lead">
+						<p>Defines property <a href="../classes/openviduerror.html#name">OpenViduError.name</a></p>
+					</div>
+				</div>
+			</section>
 			<section class="tsd-panel-group tsd-index-group">
 				<h2>Index</h2>
 				<section class="tsd-panel tsd-index-panel">
@ -101,7 +108,7 @@
 					<div class="tsd-signature tsd-kind-icon">BROWSER_<wbr>NOT_<wbr>SUPPORTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;BROWSER_NOT_SUPPORTED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L19">OpenViduInternal/Enums/OpenViduError.ts:19</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L22">OpenViduInternal/Enums/OpenViduError.ts:22</a></li>
 						</ul>
 					</aside>
 				</section>
@ -111,7 +118,7 @@
 					<div class="tsd-signature tsd-kind-icon">CAMERA_<wbr>ACCESS_<wbr>DENIED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;CAMERA_ACCESS_DENIED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L20">OpenViduInternal/Enums/OpenViduError.ts:20</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L23">OpenViduInternal/Enums/OpenViduError.ts:23</a></li>
 						</ul>
 					</aside>
 				</section>
@ -121,7 +128,7 @@
 					<div class="tsd-signature tsd-kind-icon">GENERIC_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;GENERIC_ERROR&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L32">OpenViduInternal/Enums/OpenViduError.ts:32</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L35">OpenViduInternal/Enums/OpenViduError.ts:35</a></li>
 						</ul>
 					</aside>
 				</section>
@ -131,7 +138,7 @@
 					<div class="tsd-signature tsd-kind-icon">INPUT_<wbr>AUDIO_<wbr>DEVICE_<wbr>NOT_<wbr>FOUND<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;INPUT_AUDIO_DEVICE_NOT_FOUND&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L27">OpenViduInternal/Enums/OpenViduError.ts:27</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L30">OpenViduInternal/Enums/OpenViduError.ts:30</a></li>
 						</ul>
 					</aside>
 				</section>
@ -141,7 +148,7 @@
 					<div class="tsd-signature tsd-kind-icon">INPUT_<wbr>VIDEO_<wbr>DEVICE_<wbr>NOT_<wbr>FOUND<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;INPUT_VIDEO_DEVICE_NOT_FOUND&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L26">OpenViduInternal/Enums/OpenViduError.ts:26</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L29">OpenViduInternal/Enums/OpenViduError.ts:29</a></li>
 						</ul>
 					</aside>
 				</section>
@ -151,7 +158,7 @@
 					<div class="tsd-signature tsd-kind-icon">MICROPHONE_<wbr>ACCESS_<wbr>DENIED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;MICROPHONE_ACCESS_DENIED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L21">OpenViduInternal/Enums/OpenViduError.ts:21</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L24">OpenViduInternal/Enums/OpenViduError.ts:24</a></li>
 						</ul>
 					</aside>
 				</section>
@ -161,7 +168,7 @@
 					<div class="tsd-signature tsd-kind-icon">NO_<wbr>INPUT_<wbr>SOURCE_<wbr>SET<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;NO_INPUT_SOURCE_SET&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L28">OpenViduInternal/Enums/OpenViduError.ts:28</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L31">OpenViduInternal/Enums/OpenViduError.ts:31</a></li>
 						</ul>
 					</aside>
 				</section>
@ -171,7 +178,7 @@
 					<div class="tsd-signature tsd-kind-icon">OPENVIDU_<wbr>NOT_<wbr>CONNECTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;OPENVIDU_NOT_CONNECTED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L31">OpenViduInternal/Enums/OpenViduError.ts:31</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L34">OpenViduInternal/Enums/OpenViduError.ts:34</a></li>
 						</ul>
 					</aside>
 				</section>
@ -181,7 +188,7 @@
 					<div class="tsd-signature tsd-kind-icon">OPENVIDU_<wbr>PERMISSION_<wbr>DENIED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;OPENVIDU_PERMISSION_DENIED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L30">OpenViduInternal/Enums/OpenViduError.ts:30</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L33">OpenViduInternal/Enums/OpenViduError.ts:33</a></li>
 						</ul>
 					</aside>
 				</section>
@ -191,7 +198,7 @@
 					<div class="tsd-signature tsd-kind-icon">PUBLISHER_<wbr>PROPERTIES_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;PUBLISHER_PROPERTIES_ERROR&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L29">OpenViduInternal/Enums/OpenViduError.ts:29</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L32">OpenViduInternal/Enums/OpenViduError.ts:32</a></li>
 						</ul>
 					</aside>
 				</section>
@ -201,7 +208,7 @@
 					<div class="tsd-signature tsd-kind-icon">SCREEN_<wbr>CAPTURE_<wbr>DENIED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;SCREEN_CAPTURE_DENIED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L22">OpenViduInternal/Enums/OpenViduError.ts:22</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L25">OpenViduInternal/Enums/OpenViduError.ts:25</a></li>
 						</ul>
 					</aside>
 				</section>
@ -211,7 +218,7 @@
 					<div class="tsd-signature tsd-kind-icon">SCREEN_<wbr>EXTENSION_<wbr>DISABLED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;SCREEN_EXTENSION_DISABLED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L25">OpenViduInternal/Enums/OpenViduError.ts:25</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L28">OpenViduInternal/Enums/OpenViduError.ts:28</a></li>
 						</ul>
 					</aside>
 				</section>
@ -221,7 +228,7 @@
 					<div class="tsd-signature tsd-kind-icon">SCREEN_<wbr>EXTENSION_<wbr>NOT_<wbr>INSTALLED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;SCREEN_EXTENSION_NOT_INSTALLED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L24">OpenViduInternal/Enums/OpenViduError.ts:24</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L27">OpenViduInternal/Enums/OpenViduError.ts:27</a></li>
 						</ul>
 					</aside>
 				</section>
@ -231,7 +238,7 @@
 					<div class="tsd-signature tsd-kind-icon">SCREEN_<wbr>SHARING_<wbr>NOT_<wbr>SUPPORTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;SCREEN_SHARING_NOT_SUPPORTED&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L23">OpenViduInternal/Enums/OpenViduError.ts:23</a></li>
+							<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L26">OpenViduInternal/Enums/OpenViduError.ts:26</a></li>
 						</ul>
 					</aside>
 				</section>
--- a/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts
+++ b/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts
@ -15,6 +15,9 @@
 *
 */

+/**
+ * Defines property [[OpenViduError.name]]
+ */
 export enum OpenViduErrorName {
    BROWSER_NOT_SUPPORTED = 'BROWSER_NOT_SUPPORTED',
    CAMERA_ACCESS_DENIED = 'CAMERA_ACCESS_DENIED',
--- a/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts
@ -33,8 +33,8 @@ export class ConnectionEvent extends Event {

    /**
     * For 'connectionDestroyed' event:
-     * - "disconnect"
-     * - "networkDisconnect"
+     * - "disconnect": the remote user has called `Session.disconnect()`
+     * - "networkDisconnect": the remote user network connection has dropped
     *
     * For 'connectionCreated' empty string
     */
--- a/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts
@ -24,8 +24,8 @@ import { Session, Connection } from '../..';
 export class SessionDisconnectedEvent extends Event {

    /**
-     * - "disconnect"
-     * - "networkDisconnect"
+     * - "disconnect": you have called `Session.disconnect()`
+     * - "networkDisconnect": your network connection has dropped
     */
    reason: string;

--- a/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts
@ -33,9 +33,9 @@ export class StreamEvent extends Event {

    /**
     * For 'streamDestroyed' event:
-     * - "disconnect"
-     * - "networkDisconnect"
-     * - "unpublish"
+     * - "unpublish": method `Session.unpublish()` has been called
+     * - "disconnect": method `Session.disconnect()` has been called
+     * - "networkDisconnect": the user's network connection has dropped
     *
     * For 'streamCreated' empty string
     */