UNPKG

@kandy-io/uc-sdk-3.x

Version:
1,034 lines (838 loc) 493 kB
<!doctype html> <html> <head> <meta charset='utf-8' /> <title>kandy-uc-js-sdk-3.x 3.28.0 | Documentation</title> <meta name='viewport' content='width=device-width,initial-scale=1'> <link href='assets/bass.css' type='text/css' rel='stylesheet' /> <link href='assets/style.css' type='text/css' rel='stylesheet' /> <link href='assets/github.css' type='text/css' rel='stylesheet' /> <link href='assets/split.css' type='text/css' rel='stylesheet' /> </head> <body class='documentation m0'> <div class='flex'> <div id='split-left' class='overflow-auto fs0 height-viewport-100'> <div class='py1 px2'> <h3 class='mb0 no-anchor'>kandy-uc-js-sdk-3.x</h3> <div class='mb1'><code>3.28.0</code></div> <input placeholder='Filter' id='filter-input' class='col12 block input' type='text' /> <div id='toc'> <ul class='list-reset h5 py1-ul'> <li><div style="color:black;font-size:14px;font-weight:bold;">Functions</div><span style="color:green">ⓕ</span><a href='#create' class=""> create</a> </li> <li><div style="color:black;font-size:14px;font-weight:bold;">Types</div><span style="color:blue">ⓣ</span><a href='#config' class=" toggle-sibling"> config <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Instance members</span></li> <li><a href='#configconfiglogs' class='regular pre-open'> #config.logs </a></li> <li><a href='#configconfigauthentication' class='regular pre-open'> #config.authentication </a></li> <li><a href='#configconfigcall' class='regular pre-open'> #config.call </a></li> <li><a href='#configconfigconnectivity' class='regular pre-open'> #config.connectivity </a></li> <li><a href='#configconfignotifications' class='regular pre-open'> #config.notifications </a></li> </ul> </div> </li> <li><a href='#eventcallerror' class=""> call:error</a> </li> <li><a href='#eventcallforward' class=""> call:forward</a> </li> <li><a href='#eventcalljoin' class=""> call:join</a> </li> <li><a href='#eventcallmediastatechange' class=""> call:mediaStateChange</a> </li> <li><a href='#eventcallreceive' class=""> call:receive</a> </li> <li><a href='#eventcallscreensharechange' class=""> call:screenshareChange</a> </li> <li><a href='#eventcallstart' class=""> call:start</a> </li> <li><a href='#eventcallstatechange' class=""> call:stateChange</a> </li> <li><a href='#eventdeviceschange' class=""> devices:change</a> </li> <li><a href='#eventdevicesdefaultschange' class=""> devices:defaultsChange</a> </li> <li><a href='#eventmediainitialize' class=""> media:initialize</a> </li> <li><a href='#eventvideopreviewchange' class=""> videoPreview:change</a> </li> <li><a href='#eventvideopreviewerror' class=""> videoPreview:error</a> </li> <li><span style="color:blue">ⓣ</span><a href='#api' class=" toggle-sibling"> api <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Types</span></li> <li><a href='#apibasicerror' class='regular pre-open'> <span style="color:blue">ⓣ</span> BasicError </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#apigetversion' class='regular pre-open'> <span style="color:green">ⓕ</span> .getVersion </a></li> <li><a href='#apidestroy' class='regular pre-open'> <span style="color:green">ⓕ</span> .destroy </a></li> <li><a href='#apigetconfig' class='regular pre-open'> <span style="color:green">ⓕ</span> .getConfig </a></li> <li><a href='#apiupdateconfig' class='regular pre-open'> <span style="color:green">ⓕ</span> .updateConfig </a></li> <li><a href='#apion' class='regular pre-open'> <span style="color:green">ⓕ</span> .on </a></li> <li><a href='#apioff' class='regular pre-open'> <span style="color:green">ⓕ</span> .off </a></li> <li><a href='#apisubscribe' class='regular pre-open'> <span style="color:green">ⓕ</span> .subscribe </a></li> <li><a href='#apiunsubscribe' class='regular pre-open'> <span style="color:green">ⓕ</span> .unsubscribe </a></li> <li><a href='#apiconnect' class='regular pre-open'> <span style="color:green">ⓕ</span> .connect </a></li> <li><a href='#apiconnect' class='regular pre-open'> <span style="color:green">ⓕ</span> .connect </a></li> <li><a href='#apiconnect' class='regular pre-open'> <span style="color:green">ⓕ</span> .connect </a></li> <li><a href='#apiconnect' class='regular pre-open'> <span style="color:green">ⓕ</span> .connect </a></li> <li><a href='#apidisconnect' class='regular pre-open'> <span style="color:green">ⓕ</span> .disconnect </a></li> <li><a href='#apiupdatetoken' class='regular pre-open'> <span style="color:green">ⓕ</span> .updateToken </a></li> <li><a href='#apiupdatetoken' class='regular pre-open'> <span style="color:green">ⓕ</span> .updateToken </a></li> <li><a href='#apigetuserinfo' class='regular pre-open'> <span style="color:green">ⓕ</span> .getUserInfo </a></li> <li><a href='#apigetconnection' class='regular pre-open'> <span style="color:green">ⓕ</span> .getConnection </a></li> <li><a href='#apigetservices' class='regular pre-open'> <span style="color:green">ⓕ</span> .getServices </a></li> <li><a href='#apisubscriptionstates' class='regular pre-open'> <span style="color:green">ⓕ</span> .subscriptionStates </a></li> <li><a href='#apidisconnectreasons' class='regular pre-open'> <span style="color:green">ⓕ</span> .disconnectReasons </a></li> <li><a href='#apisetcredentials' class='regular pre-open'> <span style="color:green">ⓕ</span> .setCredentials </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#apieventauthchange' class='regular pre-open'> <span style="color:orange">ⓔ</span> auth:change </a></li> <li><a href='#apieventautherror' class='regular pre-open'> <span style="color:orange">ⓔ</span> auth:error </a></li> <li><a href='#apieventauthresub' class='regular pre-open'> <span style="color:orange">ⓔ</span> auth:resub </a></li> <li><a href='#apieventauthcredentialsset' class='regular pre-open'> <span style="color:orange">ⓔ</span> auth:credentialsSet </a></li> </ul> </div> </li> <li><span style="color:blue">ⓣ</span><a href='#audiobridge' class=" toggle-sibling"> AudioBridge <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#audiobridgecreate' class='regular pre-open'> <span style="color:green">ⓕ</span> .create </a></li> <li><a href='#audiobridgeclose' class='regular pre-open'> <span style="color:green">ⓕ</span> .close </a></li> <li><a href='#audiobridgeaddcall' class='regular pre-open'> <span style="color:green">ⓕ</span> .addCall </a></li> <li><a href='#audiobridgeremovecall' class='regular pre-open'> <span style="color:green">ⓕ</span> .removeCall </a></li> <li><a href='#audiobridgemute' class='regular pre-open'> <span style="color:green">ⓕ</span> .mute </a></li> <li><a href='#audiobridgeunmute' class='regular pre-open'> <span style="color:green">ⓕ</span> .unmute </a></li> <li><a href='#audiobridgesilence' class='regular pre-open'> <span style="color:green">ⓕ</span> .silence </a></li> <li><a href='#audiobridgeunsilence' class='regular pre-open'> <span style="color:green">ⓕ</span> .unsilence </a></li> <li><a href='#audiobridgegetall' class='regular pre-open'> <span style="color:green">ⓕ</span> .getAll </a></li> <li><a href='#audiobridgegetbridgecalls' class='regular pre-open'> <span style="color:green">ⓕ</span> .getBridgeCalls </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#audiobridgeeventaudiobridgechange' class='regular pre-open'> <span style="color:orange">ⓔ</span> audioBridge:change </a></li> <li><a href='#audiobridgeeventaudiobridgeerror' class='regular pre-open'> <span style="color:orange">ⓔ</span> audioBridge:error </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#callhistory' class=" toggle-sibling"> api.callHistory <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#callhistoryfetch' class='regular pre-open'> <span style="color:green">ⓕ</span> .fetch </a></li> <li><a href='#callhistoryremove' class='regular pre-open'> <span style="color:green">ⓕ</span> .remove </a></li> <li><a href='#callhistoryclear' class='regular pre-open'> <span style="color:green">ⓕ</span> .clear </a></li> <li><a href='#callhistoryget' class='regular pre-open'> <span style="color:green">ⓕ</span> .get </a></li> <li><a href='#callhistorygetcache' class='regular pre-open'> <span style="color:green">ⓕ</span> .getCache </a></li> <li><a href='#callhistorysetcache' class='regular pre-open'> <span style="color:green">ⓕ</span> .setCache </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#callhistoryeventcallhistorychange' class='regular pre-open'> <span style="color:orange">ⓔ</span> callHistory:change </a></li> <li><a href='#callhistoryeventcallhistoryerror' class='regular pre-open'> <span style="color:orange">ⓔ</span> callHistory:error </a></li> <li><a href='#callhistoryeventcallhistorycachechange' class='regular pre-open'> <span style="color:orange">ⓔ</span> callHistoryCache:change </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#calls' class=" toggle-sibling"> api.Calls <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#callsgetall' class='regular pre-open'> <span style="color:green">ⓕ</span> .getAll </a></li> <li><a href='#callsgetbyid' class='regular pre-open'> <span style="color:green">ⓕ</span> .getById </a></li> <li><a href='#callschangeinputdevices' class='regular pre-open'> <span style="color:green">ⓕ</span> .changeInputDevices </a></li> <li><a href='#callschangespeaker' class='regular pre-open'> <span style="color:green">ⓕ</span> .changeSpeaker </a></li> <li><a href='#callsstates' class='regular pre-open'> <span style="color:green">ⓕ</span> .states </a></li> <li><a href='#callsmediastates' class='regular pre-open'> <span style="color:green">ⓕ</span> .mediaStates </a></li> <li><a href='#callsmake' class='regular pre-open'> <span style="color:green">ⓕ</span> .make </a></li> <li><a href='#callsanswer' class='regular pre-open'> <span style="color:green">ⓕ</span> .answer </a></li> <li><a href='#callsignore' class='regular pre-open'> <span style="color:green">ⓕ</span> .ignore </a></li> <li><a href='#callsreject' class='regular pre-open'> <span style="color:green">ⓕ</span> .reject </a></li> <li><a href='#callsend' class='regular pre-open'> <span style="color:green">ⓕ</span> .end </a></li> <li><a href='#callsmute' class='regular pre-open'> <span style="color:green">ⓕ</span> .mute </a></li> <li><a href='#callsunmute' class='regular pre-open'> <span style="color:green">ⓕ</span> .unmute </a></li> <li><a href='#callssilence' class='regular pre-open'> <span style="color:green">ⓕ</span> .silence </a></li> <li><a href='#callsunsilence' class='regular pre-open'> <span style="color:green">ⓕ</span> .unsilence </a></li> <li><a href='#callsgetcustomparameters' class='regular pre-open'> <span style="color:green">ⓕ</span> .getCustomParameters </a></li> <li><a href='#callssetcustomparameters' class='regular pre-open'> <span style="color:green">ⓕ</span> .setCustomParameters </a></li> <li><a href='#callsstartvideo' class='regular pre-open'> <span style="color:green">ⓕ</span> .startVideo </a></li> <li><a href='#callsstopvideo' class='regular pre-open'> <span style="color:green">ⓕ</span> .stopVideo </a></li> <li><a href='#callshold' class='regular pre-open'> <span style="color:green">ⓕ</span> .hold </a></li> <li><a href='#callsunhold' class='regular pre-open'> <span style="color:green">ⓕ</span> .unhold </a></li> <li><a href='#callsstartscreenshare' class='regular pre-open'> <span style="color:green">ⓕ</span> .startScreenshare </a></li> <li><a href='#callsstopscreenshare' class='regular pre-open'> <span style="color:green">ⓕ</span> .stopScreenshare </a></li> <li><a href='#callssenddtmf' class='regular pre-open'> <span style="color:green">ⓕ</span> .sendDTMF </a></li> <li><a href='#callssendcustomparameters' class='regular pre-open'> <span style="color:green">ⓕ</span> .sendCustomParameters </a></li> <li><a href='#callsforwardcall' class='regular pre-open'> <span style="color:green">ⓕ</span> .forwardCall </a></li> <li><a href='#callsdirecttransfer' class='regular pre-open'> <span style="color:green">ⓕ</span> .directTransfer </a></li> <li><a href='#callsconsultativetransfer' class='regular pre-open'> <span style="color:green">ⓕ</span> .consultativeTransfer </a></li> <li><a href='#callsjoin' class='regular pre-open'> <span style="color:green">ⓕ</span> .join </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#clicktocall' class=" toggle-sibling"> api.clickToCall <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#clicktocallmake' class='regular pre-open'> <span style="color:green">ⓕ</span> .make </a></li> <li><a href='#clicktocallget' class='regular pre-open'> <span style="color:green">ⓕ</span> .get </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#clicktocalleventclicktocallstart' class='regular pre-open'> <span style="color:orange">ⓔ</span> clickToCall:start </a></li> <li><a href='#clicktocalleventclicktocallerror' class='regular pre-open'> <span style="color:orange">ⓔ</span> clickToCall:error </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#connection' class=" toggle-sibling"> api.connection <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#connectiongetsocketstate' class='regular pre-open'> <span style="color:green">ⓕ</span> .getSocketState </a></li> <li><a href='#connectionenableconnectivitychecking' class='regular pre-open'> <span style="color:green">ⓕ</span> .enableConnectivityChecking </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#connectioneventwschange' class='regular pre-open'> <span style="color:orange">ⓔ</span> ws:change </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#contacts' class=" toggle-sibling"> api.contacts <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#contactsadd' class='regular pre-open'> <span style="color:green">ⓕ</span> .add </a></li> <li><a href='#contactsget' class='regular pre-open'> <span style="color:green">ⓕ</span> .get </a></li> <li><a href='#contactsgetall' class='regular pre-open'> <span style="color:green">ⓕ</span> .getAll </a></li> <li><a href='#contactsrefresh' class='regular pre-open'> <span style="color:green">ⓕ</span> .refresh </a></li> <li><a href='#contactsremove' class='regular pre-open'> <span style="color:green">ⓕ</span> .remove </a></li> <li><a href='#contactsupdate' class='regular pre-open'> <span style="color:green">ⓕ</span> .update </a></li> <li><a href='#contactsfetch' class='regular pre-open'> <span style="color:green">ⓕ</span> .fetch </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#contactseventcontactsnew' class='regular pre-open'> <span style="color:orange">ⓔ</span> contacts:new </a></li> <li><a href='#contactseventcontactserror' class='regular pre-open'> <span style="color:orange">ⓔ</span> contacts:error </a></li> <li><a href='#contactseventcontactschange' class='regular pre-open'> <span style="color:orange">ⓔ</span> contacts:change </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#conversation' class=" toggle-sibling"> api.conversation <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Types</span></li> <li><a href='#conversationconversation' class='regular pre-open'> <span style="color:blue">ⓣ</span> Conversation </a></li> <li><a href='#conversationmessage' class='regular pre-open'> <span style="color:blue">ⓣ</span> Message </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#conversationfetch' class='regular pre-open'> <span style="color:green">ⓕ</span> .fetch </a></li> <li><a href='#conversationget' class='regular pre-open'> <span style="color:green">ⓕ</span> .get </a></li> <li><a href='#conversationcreate' class='regular pre-open'> <span style="color:green">ⓕ</span> .create </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#conversationeventconversationsnew' class='regular pre-open'> <span style="color:orange">ⓔ</span> conversations:new </a></li> <li><a href='#conversationeventconversationschange' class='regular pre-open'> <span style="color:orange">ⓔ</span> conversations:change </a></li> <li><a href='#conversationeventmessageschange' class='regular pre-open'> <span style="color:orange">ⓔ</span> messages:change </a></li> <li><a href='#conversationeventmessageserror' class='regular pre-open'> <span style="color:orange">ⓔ</span> messages:error </a></li> </ul> </div> </li> <li><a href='#device_error' class=""> DEVICE_ERROR</a> </li> <li><span style="color:green">ⓕ</span><a href='#getdevices' class=""> getDevices</a> </li> <li><span style="color:magenta">ⓝ</span><a href='#logger' class=" toggle-sibling"> api.logger <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Types</span></li> <li><a href='#loggerlogentry' class='regular pre-open'> <span style="color:blue">ⓣ</span> LogEntry </a></li> <li><a href='#loggerloghandler' class='regular pre-open'> <span style="color:blue">ⓣ</span> LogHandler </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#loggerlevels' class='regular pre-open'> <span style="color:green">ⓕ</span> .levels </a></li> </ul> </div> </li> <li><span style="color:blue">ⓣ</span><a href='#media' class=""> Media</a> </li> <li><span style="color:magenta">ⓝ</span><a href='#notification' class=" toggle-sibling"> api.notification <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#notificationprocess' class='regular pre-open'> <span style="color:green">ⓕ</span> .process </a></li> <li><a href='#notificationregisterapplepush' class='regular pre-open'> <span style="color:green">ⓕ</span> .registerApplePush </a></li> <li><a href='#notificationregisterandroidpush' class='regular pre-open'> <span style="color:green">ⓕ</span> .registerAndroidPush </a></li> <li><a href='#notificationunregisterapplepush' class='regular pre-open'> <span style="color:green">ⓕ</span> .unregisterApplePush </a></li> <li><a href='#notificationunregisterandroidpush' class='regular pre-open'> <span style="color:green">ⓕ</span> .unregisterAndroidPush </a></li> <li><a href='#notificationenablewebsocket' class='regular pre-open'> <span style="color:green">ⓕ</span> .enableWebsocket </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#notificationeventnotificationschange' class='regular pre-open'> <span style="color:orange">ⓔ</span> notifications:change </a></li> <li><a href='#notificationeventnotificationserror' class='regular pre-open'> <span style="color:orange">ⓔ</span> notifications:error </a></li> </ul> </div> </li> <li><span style="color:magenta">ⓝ</span><a href='#presence' class=" toggle-sibling"> api.presence <span class='icon'>▸</span> </a><div class='toggle-target display-none'> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Types</span></li> <li><a href='#presencepresencestatus' class='regular pre-open'> <span style="color:blue">ⓣ</span> PresenceStatus </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'><span>Functions</span></li> <li><a href='#presencestatuses' class='regular pre-open'> <span style="color:green">ⓕ</span> .statuses </a></li> <li><a href='#presenceactivities' class='regular pre-open'> <span style="color:green">ⓕ</span> .activities </a></li> <li><a href='#presenceupdate' class='regular pre-open'> <span style="color:green">ⓕ</span> .update </a></li> <li><a href='#presenceget' class='regular pre-open'> <span style="color:green">ⓕ</span> .get </a></li> <li><a href='#presencegetall' class='regular pre-open'> <span style="color:green">ⓕ</span> .getAll </a></li> <li><a href='#presencegetself' class='regular pre-open'> <span style="color:green">ⓕ</span> .getSelf </a></li> <li><a href='#presencefetch' class='regular pre-open'> <span style="color:green">ⓕ</span> .fetch </a></li> <li><a href='#presencesubscribe' class='regular pre-open'> <span style="color:green">ⓕ</span> .subscribe </a></li> <li><a href='#presenceunsubscribe' class='regular pre-open'> <span style="color:green">ⓕ</span> .unsubscribe </a></li> </ul> <ul class='list-reset py1-ul pl1'> <li class='h5'>Events</li> <li><a href='#presenceeventpresencechange' class='regular pre-open'> <span style="color:orange">ⓔ</span> presence:change </a></li> <li><a href='#presenceeventpresenceselfchange' class='regular pre-open'> <span style="color:orange">ⓔ</span> presence:selfChange </a></li> <li><a href='#presenceeventpresencesubscribe' class='regular pre-open'> <span style="color:orange">ⓔ</span> presence:subscribe </a></li> <li><a href='#presenceeventpresenceunsubscribe' class='regular pre-open'> <span style="color:orange">ⓔ</span> presence:unsubscribe </a></li> <li><a href='#presenceeventpresenceerror' class='regular pre-open'> <span style="color:orange">ⓔ</span> presence:error </a></li> </ul> </div> </li> <li><span style="color:green">ⓕ</span><a href='#promptusermedia' class=""> promptUserMedia</a> </li> <li><span style="color:green">ⓕ</span><a href='#setdefaultdevices' class=""> setDefaultDevices</a> </li>