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

@telegenta/webclient 2.0.12 → 3.0.1

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 (105) 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 +226 -211
package/demos/phone_client.html +540 -514
package/demos/styles.css +0 -0
package/dist/telegenta.js +3663 -0
package/dist/telegenta.min.js +1 -0
package/docs/EventClient.html +3 -1093
package/docs/EventServiceNotConnected.html +3 -0
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 +352 -0
package/docs/exceptions.js.html +104 -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 +2175 -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 +38 -26
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/Session.html CHANGED Viewed

@@ -1,2599 +1,3 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>Session - 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">Session</h1>
-<section>
-<header>
-        <h2>
-        Session
-        </h2>
-            <div class="class-description">Session class created for every active call. You should use either call() or event incomingCall() to get new sessions</div>
-</header>
-<article>
-    <div class="container-overview">
-<div class="section-method">
-    <h2>Constructor</h2>
-    <h4 class="name" id="Session"><span class="type-signature"></span>new Session<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-</dl>
-<h5>Fires:</h5>
-<ul>
-    <li>event:callEnded Receive basic information about call after call has been terminated</li>
-    <li>callDurationUpdate Regular updates on call duration (every second)</li>
-    <li>event:sessionStateChange Changes to session state</li>
-    <li>event:recordingStateChange When recording state changes</li>
-    <li>event:muteStateChange When mute state changes</li>
-    <li>event:holdStateChange When call is hold/unload</li>
-</ul>
-</div>
-    </div>
-        <h3 class="subsection-title">Classes</h3>
-        <dl>
-            <dt><a href="Session.html">Session</a></dt>
-            <dd></dd>
-        </dl>
-        <h3 class="subsection-title">Members</h3>
-<div class="section-members">
-<h4 class="name" id="destinationNumber"><span class="type-signature"></span>destinationNumber<span class="type-signature"></span></h4>
-<div class="description">
-    Destination number called
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="direction"><span class="type-signature"></span>direction<span class="type-signature"></span></h4>
-<div class="description">
-    Session call direction
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="isMuted"><span class="type-signature"></span>isMuted<span class="type-signature"></span></h4>
-<div class="description">
-    Return mute state
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="isOnHold"><span class="type-signature"></span>isOnHold<span class="type-signature"></span></h4>
-<div class="description">
-    Return call hold status
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="isRecording"><span class="type-signature"></span>isRecording<span class="type-signature"></span></h4>
-<div class="description">
-    Return recording state
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="localNumberName"><span class="type-signature"></span>localNumberName<span class="type-signature"></span></h4>
-<div class="description">
-    Name of local number (for inbound)
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="originatingNumber"><span class="type-signature"></span>originatingNumber<span class="type-signature"></span></h4>
-<div class="description">
-    Originating number
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="state"><span class="type-signature"></span>state<span class="type-signature"></span></h4>
-<div class="description">
-    Session state
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-members">
-<h4 class="name" id="uuid"><span class="type-signature"></span>uuid<span class="type-signature"></span></h4>
-<div class="description">
-    Return UUID of call
-</div>
-<dl class="details">
-</dl>
-</div>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id="answer"><span class="type-signature"></span>answer<span class="signature">(metaInfo)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Answer incoming call
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>metaInfo</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last">
-                Add meta info to this call
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-<div class="section-method">
-    <h4 class="name" id="getOtherSessions"><span class="type-signature"></span>getOtherSessions<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Return a list of all sessions except this session
-Mostly used when transferring call
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="hangup"><span class="type-signature"></span>hangup<span class="signature">(disposition)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Hangup call
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>disposition</code></td>
-            <td class="type">
-<span class="param-type"><code><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></code></span>
-            </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last">
-                Hangup call with specific disposition
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        NoActiveSession - If no active session / call exists
-    </div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="hold"><span class="type-signature"></span>hold<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Hold call
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="muteMic"><span class="type-signature"></span>muteMic<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Mute microphone
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="playback"><span class="type-signature"></span>playback<span class="signature">(media_file_id, hangup_after)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Playback media file into call. You must be connected the event service to use this feature (set connectEventService=true)
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>media_file_id</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                </td>
-            <td class="description last">
-                Media file to playback
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>hangup_after</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    false
-                </td>
-            <td class="description last">
-                Hangup call after playback ends
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        NotAllowed - If event service is not enabled
-    </div>
-</div>
-<div class="section-returns">
-<h5>Returns:</h5>
-<div class="param-desc">
-    Promise that resolves when playback has started
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="reject"><span class="type-signature"></span>reject<span class="signature">(statusCode, reasonPhrase)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Reject incoming call
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>statusCode</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    603
-                </td>
-            <td class="description last">
-                SIP Status code
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>reasonPhrase</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    Rejected call
-                </td>
-            <td class="description last">
-                Reason phrase
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-<div class="section-method">
-    <h4 class="name" id="sendDTMF"><span class="type-signature"></span>sendDTMF<span class="signature">(code, playLocal)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Send DTMF tone on call
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>code</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                </td>
-            <td class="description last">
-                What DTMF code to send (valid: 0-9,*,#,d)
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>playLocal</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    True
-                </td>
-            <td class="description last">
-                Play DTMF sound locally also
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-    <div class="param-desc">
-        InvalidParameter - On incorrect DTMF codes
-    </div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="setWhisperMode"><span class="type-signature"></span>setWhisperMode<span class="signature">(mode)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Set whisper mode on "listen" calls
-</div>
-<dl class="details">
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>mode</code></td>
-            <td class="type">
-            </td>
-                <td class="default">
-                    0
-                </td>
-            <td class="description last">
-                Whisper mode 0 = No whisper / 1 = local peer only / 2 = Three way (both local and remote)
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-<ul>
-        <li>
-    <div class="param-desc">
-        NotAllowed - If call is not listen call
-    </div>
-</li>
-        <li>
-    <div class="param-desc">
-        InvalidOptions - If invalid mode given
-    </div>
-</li>
-    </ul>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="startRecording"><span class="type-signature"></span>startRecording<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Start recording
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="stopRecording"><span class="type-signature"></span>stopRecording<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Stop recording
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="toggleHold"><span class="type-signature"></span>toggleHold<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Toggle call hold
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="toggleMute"><span class="type-signature"></span>toggleMute<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Toggle microphone mute state
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="toggleRecording"><span class="type-signature"></span>toggleRecording<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Toogle recording ON/OFF
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="transfer"><span class="type-signature"></span>transfer<span class="signature">(dstSession)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Transfer call to another session (attended transfer)
-</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>dstSession</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                Destination session
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-<div class="section-method">
-    <h4 class="name" id="unhold"><span class="type-signature"></span>unhold<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Unhold call
-</div>
-<dl class="details">
-</dl>
-</div>
-<div class="section-method">
-    <h4 class="name" id="unmuteMic"><span class="type-signature"></span>unmuteMic<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    Unmute microphone
-</div>
-<dl class="details">
-</dl>
-</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: Session</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="EventServiceNotConnected.html">EventServiceNotConnected</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="Session-title" class="has-anchor">Session</h1><div class="class-description">Session class created for every active call. You should use either call() or event incomingCall() to get new sessions</div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="Session"><span class="type-signature"></span>new Session<span class="signature">()</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line885">line 885</a></li></ul></dd></div></dl><div class="method-member-container flex w-100 overflow-auto mt-20"><strong>Fires:</strong><ul><li>event:callEnded Receive basic information about call after call has been terminated</li><li>callDurationUpdate Regular updates on call duration (every second)</li><li>event:sessionStateChange Changes to session state</li><li>event:recordingStateChange When recording state changes</li><li>event:muteStateChange When mute state changes</li><li>event:holdStateChange When call is hold/unload</li></ul></div></div><h2 id="classes" class="subsection-title has-anchor">Classes</h2><dl><dt><a href="Session.html">Session</a></dt><dd></dd></dl><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="destinationNumber"><span class="type-signature"></span>destinationNumber<span class="type-signature"></span></h3><div class="description">Destination number called</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1321">line 1321</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="direction"><span class="type-signature"></span>direction<span class="type-signature"></span></h3><div class="description">Session call direction</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1359">line 1359</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="isMuted"><span class="type-signature"></span>isMuted<span class="type-signature"></span></h3><div class="description">Return mute 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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1499">line 1499</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="isOnHold"><span class="type-signature"></span>isOnHold<span class="type-signature"></span></h3><div class="description">Return call hold status</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1536">line 1536</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="isRecording"><span class="type-signature"></span>isRecording<span class="type-signature"></span></h3><div class="description">Return recording 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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1463">line 1463</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="localNumberName"><span class="type-signature"></span>localNumberName<span class="type-signature"></span></h3><div class="description">Name of local number (for inbound)</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1329">line 1329</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="originatingNumber"><span class="type-signature"></span>originatingNumber<span class="type-signature"></span></h3><div class="description">Originating number</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1337">line 1337</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="state"><span class="type-signature"></span>state<span class="type-signature"></span></h3><div class="description">Session 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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1351">line 1351</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="uuid"><span class="type-signature"></span>uuid<span class="type-signature"></span></h3><div class="description">Return UUID of call</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1313">line 1313</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="answer"><span class="type-signature"></span>answer<span class="signature">(metaInfo)</span></h3><div class="description">Answer incoming call</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>metaInfo</code></td><td class="type"></td><td class="default">null</td><td class="description last">Add meta info to this call</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1276">line 1276</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="getOtherSessions"><span class="type-signature"></span>getOtherSessions<span class="signature">()</span></h3><div class="description">Return a list of all sessions except this session Mostly used when transferring call</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1040">line 1040</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="hangup"><span class="type-signature"></span>hangup<span class="signature">(disposition)</span></h3><div class="description">Hangup call</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>disposition</code></td><td class="type"><span class="param-type"><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></span></td><td class="default">null</td><td class="description last">Hangup call with specific disposition</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1259">line 1259</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">NoActiveSession - If no active session / call exists</div></div><h3 class="name has-anchor" id="hold"><span class="type-signature"></span>hold<span class="signature">()</span></h3><div class="description">Hold call</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1507">line 1507</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="muteMic"><span class="type-signature"></span>muteMic<span class="signature">()</span></h3><div class="description">Mute microphone</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1471">line 1471</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="playback"><span class="type-signature"></span>playback<span class="signature">(media_file_id, hangup_after)</span></h3><div class="description">Playback media file into call. You must be connected the event service to use this feature (set connectEventService=true)</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>media_file_id</code></td><td class="type"></td><td class="default"></td><td class="description last">Media file to playback</td></tr><tr><td class="name"><code>hangup_after</code></td><td class="type"></td><td class="default">false</td><td class="description last">Hangup call after playback ends</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1614">line 1614</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">NotAllowed - If event service is not enabled</div></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">Promise that resolves when playback has started</div></div><h3 class="name has-anchor" id="reject"><span class="type-signature"></span>reject<span class="signature">(statusCode, reasonPhrase)</span></h3><div class="description">Reject incoming call</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>statusCode</code></td><td class="type"></td><td class="default">603</td><td class="description last">SIP Status code</td></tr><tr><td class="name"><code>reasonPhrase</code></td><td class="type"></td><td class="default">Rejected call</td><td class="description last">Reason phrase</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1301">line 1301</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="sendDTMF"><span class="type-signature"></span>sendDTMF<span class="signature">(code, playLocal)</span></h3><div class="description">Send DTMF tone on call</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>code</code></td><td class="type"></td><td class="default"></td><td class="description last">What DTMF code to send (valid: 0-9,*,#,d)</td></tr><tr><td class="name"><code>playLocal</code></td><td class="type"></td><td class="default">True</td><td class="description last">Play DTMF sound locally also</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1546">line 1546</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><div class="param-desc">InvalidParameter - On incorrect DTMF codes</div></div><h3 class="name has-anchor" id="setWhisperMode"><span class="type-signature"></span>setWhisperMode<span class="signature">(mode)</span></h3><div class="description">Set whisper mode on "listen" calls</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>mode</code></td><td class="type"></td><td class="default">0</td><td class="description last">Whisper mode 0 = No whisper / 1 = local peer only / 2 = Three way (both local and remote)</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1655">line 1655</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Throws:</strong><ul><li><div class="param-desc">NotAllowed - If call is not listen call</div></li><li><div class="param-desc">InvalidOptions - If invalid mode given</div></li></ul></div><h3 class="name has-anchor" id="startRecording"><span class="type-signature"></span>startRecording<span class="signature">()</span></h3><div class="description">Start recording</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1379">line 1379</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="stopRecording"><span class="type-signature"></span>stopRecording<span class="signature">()</span></h3><div class="description">Stop recording</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1413">line 1413</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="toggleHold"><span class="type-signature"></span>toggleHold<span class="signature">()</span></h3><div class="description">Toggle call hold</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1524">line 1524</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="toggleMute"><span class="type-signature"></span>toggleMute<span class="signature">()</span></h3><div class="description">Toggle microphone mute 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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1487">line 1487</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="toggleRecording"><span class="type-signature"></span>toggleRecording<span class="signature">()</span></h3><div class="description">Toogle recording ON/OFF</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1449">line 1449</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="transfer"><span class="type-signature"></span>transfer<span class="signature">(dstSession)</span></h3><div class="description">Transfer call to another session (attended transfer)</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>dstSession</code></td><td class="type"></td><td class="description last">Destination session</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="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1580">line 1580</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="unhold"><span class="type-signature"></span>unhold<span class="signature">()</span></h3><div class="description">Unhold call</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1515">line 1515</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="unmuteMic"><span class="type-signature"></span>unmuteMic<span class="signature">()</span></h3><div class="description">Unmute microphone</div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="phone-client.js.html">phone-client.js</a>, <a href="phone-client.js.html#line1479">line 1479</a></li></ul></dd></div></dl></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="EventServiceNotConnected.html">EventServiceNotConnected</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>