npm - @telegenta/webclient - Versions diffs - 2.0.12 → 3.0.0 - Mend

@telegenta/webclient 2.0.12 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (104) hide show

package/README.md +102 -81
package/demos/add_phone_number.html +8 -7
package/demos/calldata_available.html +5 -5
package/demos/embedded_config.html +3 -3
package/demos/event_client.html +4 -4
package/demos/phone_client.html +16 -10
package/demos/styles.css +0 -0
package/dist/telegenta.js +3627 -0
package/dist/telegenta.min.js +1 -0
package/docs/EventClient.html +3 -1093
package/docs/InvalidMediaDevice.html +3 -0
package/docs/InvalidOptions.html +3 -0
package/docs/InvalidParameter.html +3 -0
package/docs/LogHandler.html +7 -0
package/docs/MediaNotPrepared.html +3 -0
package/docs/NoActiveSession.html +3 -0
package/docs/NotAllowed.html +3 -0
package/docs/NotReady.html +3 -0
package/docs/Phone.html +4 -2837
package/docs/Request.html +3 -0
package/docs/Requestor.html +3 -0
package/docs/Session.html +3 -2599
package/docs/UnableToConnect.html +3 -0
package/docs/data/search.json +1 -0
package/docs/event-client.js.html +346 -0
package/docs/exceptions.js.html +94 -0
package/docs/fonts/Inconsolata-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Regular.ttf +0 -0
package/docs/fonts/WorkSans-Bold.ttf +0 -0
package/docs/global.html +5 -4950
package/docs/index.html +3 -66
package/docs/logger.js.html +106 -0
package/docs/phone-client.js.html +2155 -0
package/docs/requestor.js.html +223 -0
package/docs/scripts/core.js +726 -0
package/docs/scripts/core.min.js +23 -0
package/docs/scripts/resize.js +90 -0
package/docs/scripts/search.js +265 -0
package/docs/scripts/search.min.js +6 -0
package/docs/scripts/{prettify → third-party}/Apache-License-2.0.txt +202 -202
package/docs/scripts/third-party/fuse.js +9 -0
package/docs/scripts/third-party/hljs-line-num-original.js +369 -0
package/docs/scripts/third-party/hljs-line-num.js +1 -0
package/docs/scripts/third-party/hljs-original.js +5171 -0
package/docs/scripts/third-party/hljs.js +1 -0
package/docs/scripts/third-party/popper.js +5 -0
package/docs/scripts/third-party/tippy.js +1 -0
package/docs/scripts/third-party/tocbot.js +672 -0
package/docs/scripts/third-party/tocbot.min.js +1 -0
package/docs/styles/clean-jsdoc-theme-base.css +1159 -0
package/docs/styles/clean-jsdoc-theme-dark.css +412 -0
package/docs/styles/clean-jsdoc-theme-light.css +482 -0
package/docs/styles/clean-jsdoc-theme-scrollbar.css +30 -0
package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
package/docs/styles/clean-jsdoc-theme.min.css +1 -0
package/package.json +46 -34
package/babel.config.js +0 -16
package/browser/telegenta.min.js +0 -1
package/demos/telegenta.min.js +0 -1
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/styles/jsdoc-default.css +0 -692
package/docs/styles/prettify-jsdoc.css +0 -111
package/docs/styles/prettify-tomorrow.css +0 -132
package/embedded_client/embedded_phone.js +0 -325
package/embedded_client/index.html +0 -201
package/embedded_client/server.php +0 -28
package/embedded_client/styles.css +0 -310
package/embedded_client/tiny_rest_client.php +0 -73
package/embedded_client/webphone_sprites.png +0 -0
package/es5/event-client.js +0 -277
package/es5/index.js +0 -44
package/es5/phone-client.js +0 -1336
package/src/event-client.js +0 -1
package/src/index.js +0 -10
package/src/phone-client.js +0 -1
package/webpack.config.js +0 -39

package/docs/EventClient.html CHANGED Viewed

@@ -1,1093 +1,3 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>EventClient - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav>
-    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="EventClient.html">EventClient</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#connect">connect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#disconnect">disconnect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#fireEvent">fireEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#isConnected">isConnected</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#subscribe">subscribe</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventClient.html#unsubscribe">unsubscribe</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Phone.html">Phone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#call">call</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#getSessionByUUID">getSessionByUUID</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#holdAllCalls">holdAllCalls</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#listen">listen</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#playTone">playTone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#prepareMedia">prepareMedia</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#start">start</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#stop">stop</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Phone.html#stopTone">stopTone</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Session.html">Session</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#answer">answer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#getOtherSessions">getOtherSessions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#hangup">hangup</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#hold">hold</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#muteMic">muteMic</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#playback">playback</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#reject">reject</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#sendDTMF">sendDTMF</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#setWhisperMode">setWhisperMode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#startRecording">startRecording</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#stopRecording">stopRecording</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#toggleHold">toggleHold</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#toggleMute">toggleMute</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#toggleRecording">toggleRecording</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#transfer">transfer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#unhold">unhold</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Session.html#unmuteMic">unmuteMic</a></span></li><li class="nav-heading">Events</li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:callDataInfo">callDataInfo</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:callDurationUpdate">callDurationUpdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:callEnded">callEnded</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:callQualityReportUpdate">callQualityReportUpdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:connectionStateChange">connectionStateChange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:holdStateChange">holdStateChange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:incomingCall">incomingCall</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:muteStateChange">muteStateChange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:recordingStateChange">recordingStateChange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:sessionCreated">sessionCreated</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:sessionRemoved">sessionRemoved</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:sessionStateChange">sessionStateChange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="global.html#event:whisperModeChange">whisperModeChange</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li>
-</nav>
-<div id="main">
-    <h1 class="page-title">EventClient</h1>
-<section>
-<header>
-        <h2>
-        EventClient
-        </h2>
-            <div class="class-description">Class is responsible for handling real time server events over websockets <br>
-Using this class you can subscribe to a list of useful remote events</div>
-</header>
-<article>
-    <div class="container-overview">
-<div class="section-method">
-    <h2>Constructor</h2>
-    <h4 class="name" id="EventClient"><span class="type-signature"></span>new EventClient<span class="signature">(logger<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>logger</code></td>
-            <td class="type">
-<span class="param-type"><code>LogHandler</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                Custom log instance
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-    </div>
-        <h3 class="subsection-title">Classes</h3>
-        <dl>
-            <dt><a href="EventClient.html">EventClient</a></dt>
-            <dd></dd>
-        </dl>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(Event<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Establish a connecting to the event service
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>Event</code></td>
-            <td class="type">
-<span class="param-type"><code>string</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                service address URL
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<div class="param-desc">
-    object Connection promise
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Disconnect from event service and clear all active subscriptions
-</div>
-<dl class="details">
-</dl>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        NoActiveSession if not connected
-    </div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="fireEvent"><span class="type-signature"></span>fireEvent<span class="signature">(type, payload)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Fire event message
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>type</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                Event type to fire
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>payload</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                Event payload
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        NoActiveSession
-    </div>
-</div>
-<div class="section-returns">
-<h5>Returns:</h5>
-<div class="param-desc">
-    object Promise on event
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="isConnected"><span class="type-signature"></span>isConnected<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-<div class="description">
-    Return service connection state
-</div>
-<dl class="details">
-</dl>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>boolean</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(eventSpecification, callback)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Subscribe to event
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>eventSpecification</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                object Event parameters (please check docs for further description)
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>callback</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                object Callback function (will be called when event is received)
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        InvalidParameter
-    </div>
-</div>
-<div class="section-returns">
-<h5>Returns:</h5>
-<div class="param-desc">
-    object Promise on subscription
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">(subscriptionId)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Unsubscribe event messages
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>subscriptionId</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                Object Event specification to unsubscribe (must match specification used on subscribe)
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        InvalidParameter
-    </div>
-</div>
-<div class="section-returns">
-<h5>Returns:</h5>
-<div class="param-desc">
-    object Promise on unsubscribe
-</div>
-</div>
-</div>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Oct 06 2023 14:19:15 GMT+0200 (Central European Summer Time) using the Minami theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Class: EventClient</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="EventClient.html">EventClient</a></div><div class="sidebar-section-children"><a href="InvalidMediaDevice.html">InvalidMediaDevice</a></div><div class="sidebar-section-children"><a href="InvalidOptions.html">InvalidOptions</a></div><div class="sidebar-section-children"><a href="InvalidParameter.html">InvalidParameter</a></div><div class="sidebar-section-children"><a href="LogHandler.html">LogHandler</a></div><div class="sidebar-section-children"><a href="MediaNotPrepared.html">MediaNotPrepared</a></div><div class="sidebar-section-children"><a href="NoActiveSession.html">NoActiveSession</a></div><div class="sidebar-section-children"><a href="NotAllowed.html">NotAllowed</a></div><div class="sidebar-section-children"><a href="NotReady.html">NotReady</a></div><div class="sidebar-section-children"><a href="Phone.html">Phone</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Requestor.html">Requestor</a></div><div class="sidebar-section-children"><a href="Session.html">Session</a></div><div class="sidebar-section-children"><a href="UnableToConnect.html">UnableToConnect</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-events"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#event:callDataInfo">callDataInfo</a></div><div class="sidebar-section-children"><a href="global.html#event:callDurationUpdate">callDurationUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:callEnded">callEnded</a></div><div class="sidebar-section-children"><a href="global.html#event:callQualityReportUpdate">callQualityReportUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:connectionStateChange">connectionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:holdStateChange">holdStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:incomingCall">incomingCall</a></div><div class="sidebar-section-children"><a href="global.html#event:muteStateChange">muteStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:recordingStateChange">recordingStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionCreated">sessionCreated</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionRemoved">sessionRemoved</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionStateChange">sessionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:whisperModeChange">whisperModeChange</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#CALL_DIRECTION">CALL_DIRECTION</a></div><div class="sidebar-section-children"><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></div><div class="sidebar-section-children"><a href="global.html#CONNECTION_STATE">CONNECTION_STATE</a></div><div class="sidebar-section-children"><a href="global.html#LOGLVL">LOGLVL</a></div><div class="sidebar-section-children"><a href="global.html#SESSION_STATE">SESSION_STATE</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="EventClient-title" class="has-anchor">EventClient</h1><div class="class-description">Class is responsible for handling real time server events over websockets<br>Using this class you can subscribe to a list of useful remote events</div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="EventClient"><span class="type-signature"></span>new EventClient<span class="signature">(logger<span class="signature-attributes">opt</span>)</span></h3><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>logger</code></td><td class="type"><span class="param-type"><a href="LogHandler.html">LogHandler</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last">Custom log instance</td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line49">line 49</a></li></ul></dd></div></dl></div><h2 id="classes" class="subsection-title has-anchor">Classes</h2><dl><dt><a href="EventClient.html">EventClient</a></dt><dd></dd></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="connect"><span class="type-signature"></span>connect<span class="signature">(Event<span class="signature-attributes">opt</span>)</span></h3><div class="description">Establish a connecting to the event service</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>Event</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes">&lt;optional><br></td><td class="description last">service address URL</td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line70">line 70</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">object Connection promise</div></div><h3 class="name has-anchor" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span></h3><div class="description">Disconnect from event service and clear all active subscriptions</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line85">line 85</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">NoActiveSession if not connected</div></div><h3 class="name has-anchor" id="fireEvent"><span class="type-signature"></span>fireEvent<span class="signature">(type, payload)</span></h3><div class="description">Fire event message</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>type</code></td><td class="type"></td><td class="description last">Event type to fire</td></tr><tr><td class="name"><code>payload</code></td><td class="type"></td><td class="description last">Event payload</td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line183">line 183</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">NoActiveSession</div></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">object Promise on event</div></div><h3 class="name has-anchor" id="isConnected"><span class="type-signature"></span>isConnected<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description">Return service connection state</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line99">line 99</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(eventSpecification, callback)</span></h3><div class="description">Subscribe to event</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>eventSpecification</code></td><td class="type"></td><td class="description last">object Event parameters (please check docs for further description)</td></tr><tr><td class="name"><code>callback</code></td><td class="type"></td><td class="description last">object Callback function (will be called when event is received)</td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line114">line 114</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">InvalidParameter</div></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">object Promise on subscription</div></div><h3 class="name has-anchor" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">(subscriptionId)</span></h3><div class="description">Unsubscribe event messages</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>subscriptionId</code></td><td class="type"></td><td class="description last">Object Event specification to unsubscribe (must match specification used on subscribe)</td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="event-client.js.html">event-client.js</a>, <a href="event-client.js.html#line149">line 149</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">InvalidParameter</div></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">object Promise on unsubscribe</div></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="EventClient.html">EventClient</a></div><div class="sidebar-section-children"><a href="InvalidMediaDevice.html">InvalidMediaDevice</a></div><div class="sidebar-section-children"><a href="InvalidOptions.html">InvalidOptions</a></div><div class="sidebar-section-children"><a href="InvalidParameter.html">InvalidParameter</a></div><div class="sidebar-section-children"><a href="LogHandler.html">LogHandler</a></div><div class="sidebar-section-children"><a href="MediaNotPrepared.html">MediaNotPrepared</a></div><div class="sidebar-section-children"><a href="NoActiveSession.html">NoActiveSession</a></div><div class="sidebar-section-children"><a href="NotAllowed.html">NotAllowed</a></div><div class="sidebar-section-children"><a href="NotReady.html">NotReady</a></div><div class="sidebar-section-children"><a href="Phone.html">Phone</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Requestor.html">Requestor</a></div><div class="sidebar-section-children"><a href="Session.html">Session</a></div><div class="sidebar-section-children"><a href="UnableToConnect.html">UnableToConnect</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-events"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#event:callDataInfo">callDataInfo</a></div><div class="sidebar-section-children"><a href="global.html#event:callDurationUpdate">callDurationUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:callEnded">callEnded</a></div><div class="sidebar-section-children"><a href="global.html#event:callQualityReportUpdate">callQualityReportUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:connectionStateChange">connectionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:holdStateChange">holdStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:incomingCall">incomingCall</a></div><div class="sidebar-section-children"><a href="global.html#event:muteStateChange">muteStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:recordingStateChange">recordingStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionCreated">sessionCreated</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionRemoved">sessionRemoved</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionStateChange">sessionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:whisperModeChange">whisperModeChange</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#CALL_DIRECTION">CALL_DIRECTION</a></div><div class="sidebar-section-children"><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></div><div class="sidebar-section-children"><a href="global.html#CONNECTION_STATE">CONNECTION_STATE</a></div><div class="sidebar-section-children"><a href="global.html#LOGLVL">LOGLVL</a></div><div class="sidebar-section-children"><a href="global.html#SESSION_STATE">SESSION_STATE</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>