diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..dd352154 --- /dev/null +++ b/404.html @@ -0,0 +1,1834 @@ + + + + + + + + + + + + + + + + + + + App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.88dd0f4e.min.js b/assets/javascripts/bundle.88dd0f4e.min.js new file mode 100644 index 00000000..fb8f3109 --- /dev/null +++ b/assets/javascripts/bundle.88dd0f4e.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Wi=Object.create;var gr=Object.defineProperty;var Di=Object.getOwnPropertyDescriptor;var Vi=Object.getOwnPropertyNames,Vt=Object.getOwnPropertySymbols,Ni=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,ao=Object.prototype.propertyIsEnumerable;var io=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,$=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&io(e,r,t[r]);if(Vt)for(var r of Vt(t))ao.call(t,r)&&io(e,r,t[r]);return e};var so=(e,t)=>{var r={};for(var o in e)yr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Vt)for(var o of Vt(e))t.indexOf(o)<0&&ao.call(e,o)&&(r[o]=e[o]);return r};var xr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var zi=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Vi(t))!yr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=Di(t,n))||o.enumerable});return e};var Mt=(e,t,r)=>(r=e!=null?Wi(Ni(e)):{},zi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var co=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var lo=xr((Er,po)=>{(function(e,t){typeof Er=="object"&&typeof po!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function p(k){var ft=k.type,qe=k.tagName;return!!(qe==="INPUT"&&a[ft]&&!k.readOnly||qe==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function c(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(k){o=!1}function d(k){s(k.target)&&(o||p(k.target))&&c(k.target)}function y(k){s(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function L(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function te(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,te())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",L,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",y,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var qr=xr((hy,On)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var $a=/["'&<>]/;On.exports=Pa;function Pa(e){var t=""+e,r=$a.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof It=="object"&&typeof Yr=="object"?Yr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof It=="object"?It.ClipboardJS=r():t.ClipboardJS=r()})(It,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ui}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(A){return!1}}var d=function(A){var M=f()(A);return u("cut"),M},y=d;function L(V){var A=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[A?"right":"left"]="-9999px";var F=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(F,"px"),M.setAttribute("readonly",""),M.value=V,M}var X=function(A,M){var F=L(A);M.container.appendChild(F);var D=f()(F);return u("copy"),F.remove(),D},te=function(A){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},F="";return typeof A=="string"?F=X(A,M):A instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(A==null?void 0:A.type)?F=X(A.value,M):(F=f()(A),u("copy")),F},J=te;function k(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(M){return typeof M}:k=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},k(V)}var ft=function(){var A=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=A.action,F=M===void 0?"copy":M,D=A.container,Y=A.target,$e=A.text;if(F!=="copy"&&F!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&k(Y)==="object"&&Y.nodeType===1){if(F==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(F==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if($e)return J($e,{container:D});if(Y)return F==="cut"?y(Y):J(Y,{container:D})},qe=ft;function Fe(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Fe=function(M){return typeof M}:Fe=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Fe(V)}function ki(V,A){if(!(V instanceof A))throw new TypeError("Cannot call a class as a function")}function no(V,A){for(var M=0;M0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Fe(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function($e){return Y.onClick($e)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,$e=this.action(Y)||"copy",Dt=qe({action:$e,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Dt?"success":"error",{action:$e,text:Dt,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return y(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,$e=!!document.queryCommandSupported;return Y.forEach(function(Dt){$e=$e&&!!document.queryCommandSupported(Dt)}),$e}}]),M}(s()),Ui=Fi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,d,y){var L=c.apply(this,arguments);return l.addEventListener(u,L,y),{destroy:function(){l.removeEventListener(u,L,y)}}}function p(l,f,u,d,y){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(L){return s(L,f,u,d,y)}))}function c(l,f,u,d){return function(y){y.delegateTarget=a(y.target,f),y.delegateTarget&&d.call(l,y)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,d,y){if(!u&&!d&&!y)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(y))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,d,y);if(a.nodeList(u))return l(u,d,y);if(a.string(u))return f(u,d,y);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,d,y){return u.addEventListener(d,y),{destroy:function(){u.removeEventListener(d,y)}}}function l(u,d,y){return Array.prototype.forEach.call(u,function(L){L.addEventListener(d,y)}),{destroy:function(){Array.prototype.forEach.call(u,function(L){L.removeEventListener(d,y)})}}}function f(u,d,y){return s(document.body,u,d,y)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||p(d,L)})},y&&(n[d]=y(n[d])))}function p(d,y){try{c(o[d](y))}catch(L){u(i[0][3],L)}}function c(d){d.value instanceof nt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){p("next",d)}function f(d){p("throw",d)}function u(d,y){d(y),i.shift(),i.length&&p(i[0][0],i[0][1])}}function uo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof he=="function"?he(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function H(e){return typeof e=="function"}function ut(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ut(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ue=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=he(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(L){t={error:L}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(H(l))try{l()}catch(L){i=L instanceof zt?L.errors:[L]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=he(f),d=u.next();!d.done;d=u.next()){var y=d.value;try{ho(y)}catch(L){i=i!=null?i:[],L instanceof zt?i=q(q([],N(i)),N(L.errors)):i.push(L)}}}catch(L){o={error:L}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ho(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Ue.EMPTY;function qt(e){return e instanceof Ue||e&&"closed"in e&&H(e.remove)&&H(e.add)&&H(e.unsubscribe)}function ho(e){H(e)?e():e.unsubscribe()}var Pe={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var dt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Ue(function(){o.currentObservers=null,Qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new To(r,o)},t}(j);var To=function(e){oe(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){oe(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var At={now:function(){return(At.delegate||Date).now()},delegate:void 0};var Ct=function(e){oe(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=At);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(gt);var Lo=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(yt);var kr=new Lo(Oo);var Mo=function(e){oe(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=vt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(vt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(gt);var _o=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(yt);var me=new _o(Mo);var S=new j(function(e){return e.complete()});function Yt(e){return e&&H(e.schedule)}function Hr(e){return e[e.length-1]}function Xe(e){return H(Hr(e))?e.pop():void 0}function ke(e){return Yt(Hr(e))?e.pop():void 0}function Bt(e,t){return typeof Hr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return H(e==null?void 0:e.then)}function Jt(e){return H(e[bt])}function Xt(e){return Symbol.asyncIterator&&H(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Zi();function tr(e){return H(e==null?void 0:e[er])}function rr(e){return fo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return H(e==null?void 0:e.getReader)}function U(e){if(e instanceof j)return e;if(e!=null){if(Jt(e))return ea(e);if(xt(e))return ta(e);if(Gt(e))return ra(e);if(Xt(e))return Ao(e);if(tr(e))return oa(e);if(or(e))return na(e)}throw Zt(e)}function ea(e){return new j(function(t){var r=e[bt]();if(H(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function ta(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?De(t):Qo(function(){return new ir}))}}function jr(e){return e<=0?function(){return S}:E(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,d=0,y=!1,L=!1,X=function(){f==null||f.unsubscribe(),f=void 0},te=function(){X(),l=u=void 0,y=L=!1},J=function(){var k=l;te(),k==null||k.unsubscribe()};return E(function(k,ft){d++,!L&&!y&&X();var qe=u=u!=null?u:r();ft.add(function(){d--,d===0&&!L&&!y&&(f=Ur(J,p))}),qe.subscribe(ft),!l&&d>0&&(l=new at({next:function(Fe){return qe.next(Fe)},error:function(Fe){L=!0,X(),f=Ur(te,n,Fe),qe.error(Fe)},complete:function(){y=!0,X(),f=Ur(te,a),qe.complete()}}),U(k).subscribe(l))})(c)}}function Ur(e,t){for(var r=[],o=2;oe.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function R(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Ie(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var wa=O(h(document.body,"focusin"),h(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Ie()||document.body),G(1));function et(e){return wa.pipe(m(t=>e.contains(t)),K())}function $t(e,t){return C(()=>O(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Le(+!r*t)):le,Q(e.matches(":hover"))))}function Jo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Jo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Jo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function Tt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),O(h(t,"load"),h(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),Te(1))))}var Xo=new g,Ta=C(()=>typeof ResizeObserver=="undefined"?Tt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Xo.next(t)))),v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ta.pipe(w(r=>r.observe(t)),v(r=>Xo.pipe(b(o=>o.target===t),_(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function St(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Zo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ve(e){return{x:e.offsetLeft,y:e.offsetTop}}function en(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function tn(e){return O(h(window,"load"),h(window,"resize")).pipe(Me(0,me),m(()=>Ve(e)),Q(Ve(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ne(e){return O(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe(Me(0,me),m(()=>pr(e)),Q(pr(e)))}var rn=new g,Sa=C(()=>I(new IntersectionObserver(e=>{for(let t of e)rn.next(t)},{threshold:0}))).pipe(v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function tt(e){return Sa.pipe(w(t=>t.observe(e)),v(t=>rn.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function on(e,t=16){return Ne(e).pipe(m(({y:r})=>{let o=ce(e),n=St(e);return r>=n.height-o.height-t}),K())}var lr={drawer:R("[data-md-toggle=drawer]"),search:R("[data-md-toggle=search]")};function nn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function ze(e){let t=lr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function Oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function La(){return O(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function an(){let e=h(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:nn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Ie();if(typeof o!="undefined")return!Oa(o,r)}return!0}),pe());return La().pipe(v(t=>t?S:e))}function ye(){return new URL(location.href)}function lt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function sn(){return new g}function cn(){return location.hash.slice(1)}function pn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Ma(e){return O(h(window,"hashchange"),e).pipe(m(cn),Q(cn()),b(t=>t.length>0),G(1))}function ln(e){return Ma(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function Pt(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function mn(){let e=matchMedia("print");return O(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():S))}function zr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function je(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function fn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function un(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function dn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function hn(){return O(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(dn),Q(dn()))}function bn(){return{width:innerWidth,height:innerHeight}}function vn(){return h(window,"resize",{passive:!0}).pipe(m(bn),Q(bn()))}function gn(){return z([hn(),vn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(ee("size")),n=z([o,r]).pipe(m(()=>Ve(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function _a(e){return h(e,"message",t=>t.data)}function Aa(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function yn(e,t=new Worker(e)){let r=_a(t),o=Aa(t),n=new g;n.subscribe(o);let i=o.pipe(Z(),ie(!0));return n.pipe(Z(),Re(r.pipe(W(i))),pe())}var Ca=R("#__config"),Ot=JSON.parse(Ca.textContent);Ot.base=`${new URL(Ot.base,ye())}`;function xe(){return Ot}function B(e){return Ot.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?Ot.translations[e].replace("#",t.toString()):Ot.translations[e]}function Se(e,t=document){return R(`[data-md-component=${e}]`,t)}function ae(e,t=document){return P(`[data-md-component=${e}]`,t)}function ka(e){let t=R(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>R(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function xn(e){if(!B("announce.dismiss")||!e.childElementCount)return S;if(!e.hidden){let t=R(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),ka(e).pipe(w(r=>t.next(r)),_(()=>t.complete()),m(r=>$({ref:e},r)))})}function Ha(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function En(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Ha(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))}function Rt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Tn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Sn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}var Ln=Mt(qr());function Qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,(0,Ln.default)(c))," "],[]).slice(0,-1),i=xe(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=xe();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Mn(e){let t=e[0].score,r=[...e],o=xe(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreQr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>Qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function _n(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Kr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function An(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ra(e){var o;let t=xe(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Cn(e,t){var o;let r=xe();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ra)))}var Ia=0;function ja(e){let t=z([et(e),$t(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Zo(e)).pipe(ne(Ne),pt(1),He(t),m(()=>en(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function Fa(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ia++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(Z(),ie(!1)).subscribe(a);let s=a.pipe(Ht(c=>Le(+!c*250,kr)),K(),v(c=>c?r:S),w(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>$t(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),re(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),d=u.width/2;if(l.role==="tooltip")return{x:d,y:8+u.height};if(u.y>=f.height/2){let{height:y}=ce(l);return{x:d,y:-16-y}}else return{x:d,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),re(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(R(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),ve(me),re(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ja(e).pipe(w(c=>i.next(c)),_(()=>i.complete()),m(c=>$({ref:e},c)))})}function mt(e,{viewport$:t},r=document.body){return Fa(e,{content$:new j(o=>{let n=e.title,i=wn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Ua(e,t){let r=C(()=>z([tn(e),Ne(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function kn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(W(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),O(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),h(n,"mousedown").pipe(W(a),re(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Ie())==null||c.blur()}}),r.pipe(W(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Ua(e,t).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function Wa(e){return e.tagName==="CODE"?P(".c, .c1, .cm",e):[e]}function Da(e){let t=[];for(let r of Wa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function Hn(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Da(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,Tn(p,i)),s.replaceWith(a.get(p)))}return a.size===0?S:C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=[];for(let[l,f]of a)c.push([R(".md-typeset",f),R(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?Hn(f,u):Hn(u,f)}),O(...[...a].map(([,l])=>kn(l,t,{target$:r}))).pipe(_(()=>s.complete()),pe())})}function $n(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return $n(t)}}function Pn(e,t){return C(()=>{let r=$n(e);return typeof r!="undefined"?fr(r,e,t):S})}var Rn=Mt(Br());var Va=0;function In(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return In(t)}}function Na(e){return ge(e).pipe(m(({width:t})=>({scrollable:St(e).width>t})),ee("scrollable"))}function jn(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(jr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Rn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Va++}`;let l=Sn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(mt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=In(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(W(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:S)))}}return P(":scope > span[id]",e).length&&e.classList.add("md-code__content"),Na(e).pipe(w(c=>n.next(c)),_(()=>n.complete()),m(c=>$({ref:e},c)),Re(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function za(e,{target$:t,print$:r}){let o=!0;return O(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),w(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Fn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),za(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}var Un=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.entityTitleText{fill:var(--md-mermaid-label-fg-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Gr,Qa=0;function Ka(){return typeof mermaid=="undefined"||mermaid instanceof Element?Tt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):I(void 0)}function Wn(e){return e.classList.remove("mermaid"),Gr||(Gr=Ka().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Un,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Gr.subscribe(()=>co(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Qa++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Gr.pipe(m(()=>({ref:e})))}var Dn=x("table");function Vn(e){return e.replaceWith(Dn),Dn.replaceWith(An(e)),I({ref:e})}function Ya(e){let t=e.find(r=>r.checked)||e[0];return O(...e.map(r=>h(r,"change").pipe(m(()=>R(`label[for="${r.id}"]`))))).pipe(Q(R(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Nn(e,{viewport$:t,target$:r}){let o=R(".tabbed-labels",e),n=P(":scope > input",e),i=Kr("prev");e.append(i);let a=Kr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(Z(),ie(!0));z([s,ge(e),tt(e)]).pipe(W(p),Me(1,me)).subscribe({next([{active:c},l]){let f=Ve(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=pr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ne(o),ge(o)]).pipe(W(p)).subscribe(([c,l])=>{let f=St(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),O(h(i,"click").pipe(m(()=>-1)),h(a,"click").pipe(m(()=>1))).pipe(W(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(W(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=R(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(p),b(f=>!(f.metaKey||f.ctrlKey)),w(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),re(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let y of P("[data-tabs]"))for(let L of P(":scope > input",y)){let X=R(`label[for="${L.id}"]`);if(X!==c&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),L.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),s.pipe(W(p)).subscribe(()=>{for(let c of P("audio, video",e))c.pause()}),Ya(n).pipe(w(c=>s.next(c)),_(()=>s.complete()),m(c=>$({ref:e},c)))}).pipe(Ke(se))}function zn(e,{viewport$:t,target$:r,print$:o}){return O(...P(".annotate:not(.highlight)",e).map(n=>Pn(n,{target$:r,print$:o})),...P("pre:not(.mermaid) > code",e).map(n=>jn(n,{target$:r,print$:o})),...P("pre.mermaid",e).map(n=>Wn(n)),...P("table:not([class])",e).map(n=>Vn(n)),...P("details",e).map(n=>Fn(n,{target$:r,print$:o})),...P("[data-tabs]",e).map(n=>Nn(n,{viewport$:t,target$:r})),...P("[title]",e).filter(()=>B("content.tooltips")).map(n=>mt(n,{viewport$:t})))}function Ba(e,{alert$:t}){return t.pipe(v(r=>O(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function qn(e,t){let r=R(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ba(e,t).pipe(w(n=>o.next(n)),_(()=>o.complete()),m(n=>$({ref:e},n)))})}var Ga=0;function Ja(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?Ne(o):I({x:0,y:0}),i=O(et(t),$t(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ve(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Qn(e){let t=e.title;if(!t.length)return S;let r=`__tooltip_${Ga++}`,o=Rt(r,"inline"),n=R(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),O(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ja(o,e).pipe(w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))}).pipe(Ke(se))}function Xa({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Be(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=ze("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Kn(e,t){return C(()=>z([ge(e),Xa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function Yn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(Z(),ie(!0));o.pipe(ee("active"),He(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue(P("[title]",e)).pipe(b(()=>B("content.tooltips")),ne(a=>Qn(a)));return r.subscribe(o),t.pipe(W(n),m(a=>$({ref:e},a)),Re(i.pipe(W(n))))})}function Za(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),ee("active"))}function Bn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?S:Za(o,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))})}function Gn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ee("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function es(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(ne(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Jn(e){let t=P("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Pt("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),re(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(ve(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),es(t).pipe(W(n.pipe(Ce(1))),ct(),w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))})}function Xn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(w(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Jr=Mt(Br());function ts(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Zn({alert$:e}){Jr.default.isSupported()&&new j(t=>{new Jr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ts(R(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function ei(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function rs(e,t){let r=new Map;for(let o of P("url",e)){let n=R("loc",o),i=[ei(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(ei(new URL(s),t))}}return r}function ur(e){return un(new URL("sitemap.xml",e)).pipe(m(t=>rs(t,new URL(e))),de(()=>I(new Map)))}function os(e,t){if(!(e.target instanceof Element))return S;let r=e.target.closest("a");if(r===null)return S;if(r.target||e.metaKey||e.ctrlKey)return S;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):S}function ti(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function ri(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function ns(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=ti(document);for(let[o,n]of ti(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return We(P("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),S}),Z(),ie(document))}function oi({location$:e,viewport$:t,progress$:r}){let o=xe();if(location.protocol==="file:")return S;let n=ur(o.base);I(document).subscribe(ri);let i=h(document.body,"click").pipe(He(n),v(([p,c])=>os(p,c)),pe()),a=h(window,"popstate").pipe(m(ye),pe());i.pipe(re(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),O(i,a).subscribe(e);let s=e.pipe(ee("pathname"),v(p=>fn(p,{progress$:r}).pipe(de(()=>(lt(p,!0),S)))),v(ri),v(ns),pe());return O(s.pipe(re(e,(p,c)=>c)),s.pipe(v(()=>e),ee("pathname"),v(()=>e),ee("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),w(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",pn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(ee("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ni=Mt(qr());function ii(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ni.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function jt(e){return e.type===1}function dr(e){return e.type===3}function ai(e,t){let r=yn(e);return O(I(location.protocol!=="file:"),ze("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function si(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=Xr(n))==null?void 0:l.pathname;if(i===void 0)return;let a=ss(o.pathname,i);if(a===void 0)return;let s=ps(t.keys());if(!t.has(s))return;let p=Xr(a,s);if(!p||!t.has(p.href))return;let c=Xr(a,r);if(c)return c.hash=o.hash,c.search=o.search,c}function Xr(e,t){try{return new URL(e,t)}catch(r){return}}function ss(e,t){if(e.startsWith(t))return e.slice(t.length)}function cs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oS)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),re(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?S:(i.preventDefault(),I(new URL(p)))}}return S}),v(i=>ur(i).pipe(m(a=>{var s;return(s=si({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:ye(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(n=>lt(n,!0)),z([r,o]).subscribe(([n,i])=>{R(".md-header__topic").appendChild(Cn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ls(e,{worker$:t}){let{searchParams:r}=ye();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),ze("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=ye();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=O(t.pipe(Ae(jt)),h(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function pi(e,{worker$:t}){let r=new g,o=r.pipe(Z(),ie(!0));z([t.pipe(Ae(jt)),r],(i,a)=>a).pipe(ee("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ee("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=R("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ls(e,{worker$:t}).pipe(w(i=>r.next(i)),_(()=>r.complete()),m(i=>$({ref:e},i)),G(1))}function li(e,{worker$:t,query$:r}){let o=new g,n=on(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=R(":scope > :first-child",e),s=R(":scope > :last-child",e);ze("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(re(r),Wr(t.pipe(Ae(jt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(w(()=>s.innerHTML=""),v(({items:l})=>O(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Be(4),Vr(n),v(([f])=>f)))),m(Mn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(ne(l=>{let f=fe("details",l);return typeof f=="undefined"?S:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(w(l=>o.next(l)),_(()=>o.complete()),m(l=>$({ref:e},l)))}function ms(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ye();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function mi(e,t){let r=new g,o=r.pipe(Z(),ie(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),ms(e,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))}function fi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=O(h(n,"keydown"),h(n,"focus")).pipe(ve(se),m(()=>n.value),K());return o.pipe(He(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(w(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ui(e,{index$:t,keyboard$:r}){let o=xe();try{let n=ai(o.search,t),i=Se("search-query",e),a=Se("search-result",e);h(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Ie();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of P(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...P(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Ie()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=pi(i,{worker$:n});return O(s,li(a,{worker$:n,query$:s})).pipe(Re(...ae("search-share",e).map(p=>mi(p,{query$:s})),...ae("search-suggest",e).map(p=>fi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ye}}function di(e,{index$:t,location$:r}){return z([t,r.pipe(Q(ye()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>ii(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function fs(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Zr(e,o){var n=o,{header$:t}=n,r=so(n,["header$"]);let i=R(".md-sidebar__scrollwrap",e),{y:a}=Ve(i);return C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=s.pipe(Me(0,me));return c.pipe(re(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of P(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2})}}}),ue(P("label[tabindex]",e)).pipe(ne(l=>h(l,"click").pipe(ve(se),m(()=>l),W(p)))).subscribe(l=>{let f=R(`[id="${l.htmlFor}"]`);R(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),fs(e,r).pipe(w(l=>s.next(l)),_(()=>s.complete()),m(l=>$({ref:e},l)))})}function hi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return st(je(`${r}/releases/latest`).pipe(de(()=>S),m(o=>({version:o.tag_name})),De({})),je(r).pipe(de(()=>S),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return je(r).pipe(m(o=>({repositories:o.public_repos})),De({}))}}function bi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return st(je(`${r}/releases/permalink/latest`).pipe(de(()=>S),m(({tag_name:o})=>({version:o})),De({})),je(r).pipe(de(()=>S),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}function vi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return hi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return bi(r,o)}return S}var us;function ds(e){return us||(us=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return S}return vi(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(de(()=>S),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function gi(e){let t=R(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(_n(o)),t.classList.add("md-source__repository--active")}),ds(e).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function hs(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ee("hidden"))}function yi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):hs(e,t)).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function bs(e,{viewport$:t,header$:r}){let o=new Map,n=P(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(ee("height"),m(({height:s})=>{let p=Se("main"),c=R(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(ee("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),He(i),v(([p,c])=>t.pipe(Fr(([l,f],{offset:{y:u},size:d})=>{let y=u+d.height>=Math.floor(s.height);for(;f.length;){let[,L]=f[0];if(L-c=u&&!y)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Be(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(Z(),ie(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=O(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),He(o.pipe(ve(se))),re(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(W(a),ee("offset"),_e(250),Ce(1),W(n.pipe(Ce(1))),ct({delay:250}),re(i)).subscribe(([,{prev:s}])=>{let p=ye(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),bs(e,{viewport$:t,header$:r}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function vs(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Be(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),W(o.pipe(Ce(1))),ie(!0),ct({delay:250}),m(a=>({hidden:a})))}function Ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(a),ee("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),h(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),vs(e,{viewport$:t,main$:o,target$:n}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))}function wi({document$:e,viewport$:t}){e.pipe(v(()=>P(".md-ellipsis")),ne(r=>tt(r).pipe(W(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?mt(n,{viewport$:t}).pipe(W(e.pipe(Ce(1))),_(()=>n.removeAttribute("title"))):S})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>P(".md-status")),ne(r=>mt(r,{viewport$:t}))).subscribe()}function Ti({document$:e,tablet$:t}){e.pipe(v(()=>P(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),ne(r=>h(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),re(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function gs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Si({document$:e}){e.pipe(v(()=>P("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),b(gs),ne(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Oi({viewport$:e,tablet$:t}){z([ze("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),re(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ys(){return location.protocol==="file:"?Tt(`${new URL("search/search_index.js",eo.base)}`).pipe(m(()=>__index),G(1)):je(new URL("search/search_index.json",eo.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Go(),Ut=sn(),Lt=ln(Ut),to=an(),Oe=gn(),hr=Pt("(min-width: 960px)"),Mi=Pt("(min-width: 1220px)"),_i=mn(),eo=xe(),Ai=document.forms.namedItem("search")?ys():Ye,ro=new g;Zn({alert$:ro});var oo=new g;B("navigation.instant")&&oi({location$:Ut,viewport$:Oe,progress$:oo}).subscribe(ot);var Li;((Li=eo.version)==null?void 0:Li.provider)==="mike"&&ci({document$:ot});O(Ut,Lt).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});to.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&<(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&<(r);break;case"Enter":let o=Ie();o instanceof HTMLLabelElement&&o.click()}});wi({viewport$:Oe,document$:ot});Ti({document$:ot,tablet$:hr});Si({document$:ot});Oi({viewport$:Oe,tablet$:hr});var rt=Kn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Gn(e,{viewport$:Oe,header$:rt})),G(1)),xs=O(...ae("consent").map(e=>En(e,{target$:Lt})),...ae("dialog").map(e=>qn(e,{alert$:ro})),...ae("palette").map(e=>Jn(e)),...ae("progress").map(e=>Xn(e,{progress$:oo})),...ae("search").map(e=>ui(e,{index$:Ai,keyboard$:to})),...ae("source").map(e=>gi(e))),Es=C(()=>O(...ae("announce").map(e=>xn(e)),...ae("content").map(e=>zn(e,{viewport$:Oe,target$:Lt,print$:_i})),...ae("content").map(e=>B("search.highlight")?di(e,{index$:Ai,location$:Ut}):S),...ae("header").map(e=>Yn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("header-title").map(e=>Bn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Mi,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>yi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>xi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})),...ae("top").map(e=>Ei(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})))),Ci=ot.pipe(v(()=>Es),Re(xs),G(1));Ci.subscribe();window.document$=ot;window.location$=Ut;window.target$=Lt;window.keyboard$=to;window.viewport$=Oe;window.tablet$=hr;window.screen$=Mi;window.print$=_i;window.alert$=ro;window.progress$=oo;window.component$=Ci;})(); +//# sourceMappingURL=bundle.88dd0f4e.min.js.map + diff --git a/assets/javascripts/bundle.88dd0f4e.min.js.map b/assets/javascripts/bundle.88dd0f4e.min.js.map new file mode 100644 index 00000000..dab2a875 --- /dev/null +++ b/assets/javascripts/bundle.88dd0f4e.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for Bullhorn.

+ +

When you login successfully, the Chrome extension will automatically update to show you are connected to Bullhorn. If you are connected, the button next to Bullhorn will say, "logout".

+

And with that, you will be connected to Bullhorn and ready to begin using the integration.

+

Auto log with default Note Action preference setup

+

In Settings, there's a "Bullhorn options" entry button.

+

Bullhorn default Note Action

+

We provide four options to choose from, corresponding to the different communications that can be logged in Bullhorn via App Connect. The values you enter here will be used in two different ways:

+
    +
  1. When logging calls automatically, these note actions will be used when creating the associated notes.
    2. +
  2. When logging calls manually, these note actions will determine which action is selected by default in the logging screen.
    3. +
+

Bullhorn default Note Action page

+

Editing the enumerated list of possible note actions

+

As an admin, navigate inside of Bullhorn to Admin > System Settings. Then filter the list of settings for "commentActionList." There you should fine a comma-delimited list of values that determine the possible/allowed note actions.

+

Bullhorn default Note Action page

+

Placeholder companies when creating contacts

+

Bullhorn requires that every contact be associated with a company. When logging calls for new contacts, App Connect will first look for a company called, "Placeholder company." If a company with that name is not found, one will be created. Then the contact will be associated with that company record. It is the intent that once the call is complete that an agent do one of the following:

+
    +
  1. Edit the company called "Placeholder Company" with a more appropriate name and with additional details.
    2. +
  2. Edit the contact to associate it with a more appropriate company stored in Bullhorn.
    3. +
+

In this way, App Connect ensures that all contacts created by it conform to the requirements of Bullhorn so that all contact records are complete.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/clio/index.html b/crm/clio/index.html new file mode 100644 index 00000000..00341ae2 --- /dev/null +++ b/crm/clio/index.html @@ -0,0 +1,2122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Clio - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setting up App Connect for Clio

+

Clio provides legal client relationship management software to help law firms manage business development functions such as client intake, client scheduling and follow-up, revenue tracking, and more. In short, Clio addresses the client intake process of turning potential new clients into retained clients.

+

RingCentral's integration with Clio helps streamline communications with clients, and helps staff servicing clients to better support them through the entire intake process by helping to manage and store communication history with clients, report on billable time and more.

+

Install the extension

+

If you have not already done so, begin by installing App Connect from the Chrome web store.

+ + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for Clio.

+
    +
  1. +

    Login to Clio.

    +
    2. +
  2. +

    While visiting a Clio application page, click the quick access button to bring the dialer to the foreground.

    +
    3. +
  3. +

    Navigate to the Settings screen in App Connect, and find the option labeled "Clio."

    +

    Connect to Clio

    +
    4. +
  4. +

    Click the "Connect" button.

    +
    5. +
  5. +

    A window will be opened prompting you to enter your Clio username and password. Login to Clio.

    +
    6. +
+

When you login successfully, the Chrome extension will automatically update to show you are connected to Clio. If you are connected, the button next to Clio will say, "logout".

+

And with that, you will be connected to Clio and ready to begin using the integration.

+

Setting up phone number matching to properly match contacts

+

Clio's contact lookup method is very strict. As a result, if the phone numbers in Clio are not stored using the E.164 standard, e.g. +1##########, then App Connect will fail to find the contact record for call logging and call pop.

+

To address this, short of reformatting every phone number stored in Clio, is to go to Phone number format alternatives under the "Contacts" settings and set the phone number formats to conform with the conventions used by your practice.

+

Overriding formats in settings

+

Navigate to App Connect's Contacts settings page and enter in the phone formats used by your practice. Define a format by using an asterix "*" in place of any digit/number. Any other character used in the format string will be interpretted literally.

+

Let's look at a few examples. First, consider the following format string:

+
(***) ***-****
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Phone numberDoes it match?
(555) 123-2334Yes
(555)123-2334No
1 (555) 123-2334No
555-123-2334No
+

Now, let's look at one more example. Consider the format string:

+
1 (***) ***-****
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Phone numberDoes it match?
1 (555) 123-2334Yes
+1 (555) 123-2334No
(555) 123-2334No
555-123-2334No
+

We have found the following formats are commonly used among customers (feel free to copy and paste them into advanced settings):

+
    +
  • (***) ***-****
    • +
  • ***-***-****
    • +
  • ***.***.****
    • +
  • 1 (***) ***-****
    • +
+

Select or enter up to three different formats used by your practice and click "Save."

+
+

Advanced settings with format options +

+
Phone number formats after being properly filled in.
+
+
+

The E.164 format is used by default. You do not need to specify the format 1**********.

+
+

Making this change will improve your experience with the extension considerably. Here are a few things to bear in mind:

+
    +
  • Every phone number format you add results in another search request to Clio, which could lead to performance issues.
    • +
  • Searches are performed using each of the formats in order. The first phone number that is found will stop the search process. So place the formats that are most likely to yield results first in order.
    • +
+

Improving contact lookup speeds

+

Ideally, phone numbers in Clio would all be stored using the E.164 format standard. This would eliminate the need to resort to searching using different formats. Therefore, one thing you can do within your company is socialise with Clio users the value of storing phone numbers in a specific format.

+
+

Use Zapier to automatically format phone numbers

+

Zapier is a great automation tool that can help your organization reformat phone numbers to E.164 for all new contacts moving forward. +Clio number formatter Zap

+
+

Finally, you can improve performance by going back to existing contacts and updating their phone numbers. This can be a laborious process, but will yield the best results in the long term.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/index.html b/crm/index.html new file mode 100644 index 00000000..c722ddc7 --- /dev/null +++ b/crm/index.html @@ -0,0 +1,2009 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Supported CRMs for App Connect - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

CRMs supported by App Connect

+

RingCentral's App Connect for RingEX provides support for a number of different CRMs including the list below. It is also a developer framework that allows companies to quickly and easily build integrations with more niche or proprietary CRMs at a fraction of the cost.

+

Supported CRMs

+
+ +
+

Don't see your CRM listed?

+

If you don't see your CRM listed, contact us via our community and we can help get you in touch with qualified vendors or RingCentral Professional Services to help you build a solution that fits your needs.

+

Are you a developer? Build support for your own CRM

+

App Connect is itself an open source framework that can be used by developers to create a custom CRM integration more easily than building one from scratch.

+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/insightly/index.html b/crm/insightly/index.html new file mode 100644 index 00000000..1204ebfc --- /dev/null +++ b/crm/insightly/index.html @@ -0,0 +1,2093 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Insightly - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setting up App Connect for Insightly

+

Growing businesses across the globe rely on Insightly to help them build lasting customer relationships. Insightly delivers a platform that can take businesses to the next level: a powerful CRM, plus marketing automation, a customer service app, and an integration tool.

+

RingCentral's integration with Insightly helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

+

Install the extension

+

If you have not already done so, begin by installing App Connect from the Chrome web store.

+ + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for Insightly.

+
    +
  1. +

    Login to Insightly.

    +
    2. +
  2. +

    While visiting an Insightly application page, click the quick access button to bring the dialer to the foreground.

    +
    3. +
  3. +

    Navigate to the Settings screen in App Connect, and find the option labeled "Insightly."

    +

    Connect to Insightly

    +
    4. +
  4. +

    Click the "Connect" button.

    +
    5. +
  5. +

    A window will be opened prompting you to enter numerous attributes from Insightly, including:

    +
      +
    • API key
      • +
    • API URL
      • +
    +

    Connect to Insightly

    +
    6. +
  6. +

    Click the "Get API Key" button and the extension will attempt to retrieve these values for you. You may also enter these values manually. In Insightly, navigate to User Settings from the pull down menu in the upper-righthand corner. Scroll down until you see a section labeled "API." Copy and paste your API key and API URL into the corresponding fields.

    +

    Insightly API credentials

    +
    7. +
+

When you login successfully, the Chrome extension will automatically update to show you are connected to Insightly. If you are connected, the button next to Insightly will say, "logout".

+

And with that, you will be connected to Insightly and ready to begin using the integration.

+

Setting up phone number matching to properly match contacts

+

Insightly's contact lookup method is very strict. As a result, if the phone numbers in Insightly are not stored using the E.164 standard, e.g. +1##########, then App Connect will fail to find the contact record for call logging and call pop.

+

To address this, short of reformatting every phone number stored in Insightly, is to go to Phone number format alternatives under the "Contacts" settings and set the phone number formats to conform with the conventions used by your company.

+

Overriding formats in settings

+

Navigate to App Connect's Contacts settings page and enter in the phone formats used by your company. Define a format by using an asterix "*" in place of any digit/number. Any other character used in the format string will be interpretted literally.

+

Let's look at a few examples. First, consider the following format string:

+
(***) ***-****
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Phone numberDoes it match?
(555) 123-2334Yes
(555)123-2334No
1 (555) 123-2334No
555-123-2334No
+

Now, let's look at one more example. Consider the format string:

+
1 (***) ***-****
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Phone numberDoes it match?
1 (555) 123-2334Yes
+1 (555) 123-2334No
(555) 123-2334No
555-123-2334No
+

We have found the following formats are commonly used among customers (feel free to copy and paste them into advanced settings):

+
    +
  • (***) ***-****
    • +
  • ***-***-****
    • +
  • ***.***.****
    • +
  • 1 (***) ***-****
    • +
+

Select or enter up to three different formats used by your company and click "Save."

+
+

Advanced settings with format options +

+
Phone number formats after being properly filled in.
+
+
+

The E.164 format is used by default. You do not need to specify the format 1**********.

+
+

Making this change will improve your experience with the extension considerably. Here are a few things to bear in mind:

+
    +
  • Every phone number format you add results in another search request to Insightly, which could lead to performance issues.
    • +
  • Searches are performed using each of the formats in order. The first phone number that is found will stop the search process. So place the formats that are most likely to yield results first in order.
    • +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/netsuite/index.html b/crm/netsuite/index.html new file mode 100644 index 00000000..f07bbdf8 --- /dev/null +++ b/crm/netsuite/index.html @@ -0,0 +1,2205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + NetSuite - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setting up App Connect for NetSuite

+

NetSuite is a cloud-based business management software that helps organizations manage their financials, operations, and customer relationships.

+

RingCentral's integration with NetSuite helps streamline communications with contacts, and helps staffing agents better support contacts through the entire sales order pipeline by helping to manage and store communication history for all contacts.

+
+

Prerequisites

+
    +
  • The current version of the NetSuite integration requires NetSuite version 2024.1 or later.
    • +
  • NetSuite users must have REST Web Services enabled.
    • +
  • NetSuite OneWorld license holders will need to manually add the "Subsidiaries" permission to the role they use to connect to NetSuite.
    • +
+
+

Install the SuiteApp

+

To begin using the NetSuite integration, users will first need to do the following:

+
    +
  • Login to NetSuite, then visit the RingCentral Suite App page, or:
    • +
  • Click on the "SuiteApps" tab if your role gives you access to it
    • +
  • Search for "RingCentral" in the directory
    • +
  • Click "RingCentral App Connect" in the search results
    • +
  • Click the "Install" button found in the upper right hand corner of the page
    • +
+

If you see, "Not compatible" in place of an "Install" button, then you must be running an older version of NetSuite. You will need to upgrade to 2024.2 or later.

+

Installing the app from the SuiteApp marketplace is a necessary step prior to installing the Chrome extension discussed below.

+

Setup roles and permissions in NetSuite

+

Upon installation of the SuiteApp, a role will be created automatically within your account called "RingCentral App Connect." This role has been specially tuned to contain the bare minimum number access level to fully operate the Chrome extension. You can see a detailed list of permissions below if you would like to incorporate these permissions into a custom role of your own.

+

NetSuite OneWorld instructions

+

Upon installing the SuiteApp from the Marketplace, a new custom role named "RingCentral App Connect" will be automatically created in your account. If you are a OneWorld license holder, you will need to take these additional steps.

+
    +
  1. Clone the "RingCentral App Connect" role by selecting the "Customize" option.
    2. +
  2. While cloning, add the permission "List -> Subsidiaries" to the cloned role.
    3. +
+

Use this cloned role when logging into and connecting App Connect to NetSuite.

+
+

The role is created by SuiteApp locked by default and cannot be edited. If you wish to make modifications, you may duplicate the role by clicking on 'Customize.'

+
+

Turn on REST web services

+

REST Web Services is default to be invisible. We'll need to turn on the feature so to make it selectable for roles. Here's how to do it:

+
    +
  1. From NetSuite homepage, go to Setup -> Company -> Enable Features
    2. +
  2. Go to sub-tab, "SuiteCloud"
    3. +
  3. Tick on "REST Web Services" and save
    4. +
+

Create role with required permissions

+

We recommend using the "RingCentral App Connect" role created for you when you install the SuiteApp. However, if you would like to create a custom role that includes the permissions necessary to allow this extension to operate fully, consult the table below.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CategoryPermissionLevel
ListsContactsFull
ListsCustomersFull
ListsPhone CallsFull
ListsSubsidiariesView (OneWorld users only)
ReportsSuiteAnalytics WorkbookEdit
SetupLog in using OAuth 2.0 Access TokensFull
SetupREST Web ServicesFull
SetupUser Access TokensFull
TransactionsSales OrderFull
+

Install the Chrome/Edge extension

+

If you have not already done so, begin by installing App Connect from the Chrome web store.

+ + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for NetSuite.

+
    +
  1. +

    Login to NetSuite.

    +
    2. +
  2. +

    While visiting a NetSuite web page, click the quick access button to bring the dialer to the foreground.

    +
    3. +
  3. +

    Navigate to the Settings screen in App Connect, and find the option labeled "Netsuite".

    +

    Connect to NetSuite

    +
    4. +
  4. +

    Click the "Connect" button.

    +
    5. +
  5. +

    A window will be opened prompting you to allow OAuth scopes. Allow it.

    +
    6. +
+

When you login successfully, the Chrome extension will automatically update to show you are connected to NetSuite. If you are connected, the button next to NetSuite will say, "logout".

+

And with that, you will be connected to NetSuite and ready to begin using the integration.

+

Placeholder companies when creating contacts

+

NetSuite requires that every contact be associated with a company. When logging calls for new contacts, App Connect will first look for a company called, "Placeholder company." If a company with that name is not found, one will be created. Then the contact will be associated with that company record. It is the intent that once the call is complete that an agent do one of the following:

+
    +
  1. Edit the company called "Placeholder Company" with a more appropriate name and with additional details.
    2. +
  2. Edit the contact to associate it with a more appropriate company stored in NetSuite.
    3. +
+

In this way, App Connect ensures that all contacts created by it conform to the requirements of NetSuite so that all contact records are complete.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/pipedrive/index.html b/crm/pipedrive/index.html new file mode 100644 index 00000000..9791ad9e --- /dev/null +++ b/crm/pipedrive/index.html @@ -0,0 +1,2005 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Pipedrive - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setting up App Connect for Pipedrive

+

Pipedrive is designed to help small businesses grow. For over ten years, Pipedrive has been committed to building the best CRM – a CRM by and for salespeople. The result is an easy-to-use, effective sales tool that centralizes your data, helping you visualize your entire sales process and win more deals.

+

RingCentral's integration with Pipedrive helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

+

Install the extension

+

If you have not already done so, begin by installing App Connect from the Chrome web store.

+ + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for Pipedrive.

+
    +
  1. +

    Make sure you are logged in to Pipedrive.

    +
    2. +
  2. +

    Navigate to the RingCentral App Connect in the Pipedrive Marketplace.

    +
    3. +
  3. +

    From the marketplace listing, initiate the authorization process by clicking the "Install Now" button.

    +

    Install Pipedrive ext

    +
    4. +
  4. +

    On the authorization screen, scroll to the bottom and click "Allow and Install." App Connect should automatically come to the foreground and show that you are now connected to Pipedrive.

    +
    5. +
+

When you login successfully, the Chrome extension will automatically update to show you are connected to Pipedrive. If you are connected, the button next to Pipedrive will say, "logout".

+
+

Connected to pipedrive +

+
Settings once you have connected to Pipedrive
+
+

And with that, you will be connected to Pipedrive and ready to begin using the integration.

+

Tailoring your configuration

+

Pipedrive's system exhibits a relatively uncommon behavior that is the result of a perfectly normal function of the frameworks used by their engineers. However, this behavior is unfortunate because it causes the dialer to be removed from the page after it has loaded. You may see it appear briefly, and then POOF! It is gone.

+

To address this, go our advanced settings and set the config option called "Click-to-dial inject delay" to 2 or 3. Depending upon network latencies, you may need to increase this number, but usually a value of 2 is sufficient.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/crm/redtail/index.html b/crm/redtail/index.html new file mode 100644 index 00000000..0ea3e01b --- /dev/null +++ b/crm/redtail/index.html @@ -0,0 +1,1982 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Redtail CRM - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setting up App Connect for Redtail CRM

+

Whether you are looking to strengthen your client relationships, improve your team’s collaboration efforts and overall efficiency, increase your revenues and profitability, decrease client attrition, or engage in any number of other business-building activities, Redtail CRM offers tools to assist in your efforts.

+

RingCentral's integration with Redtail CRM helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

+

Install the extension

+

If you have not already done so, begin by installing App Connect from the Chrome web store.

+ + +

Setup the extension

+

Once the extension has been installed, follow these steps to setup and configure the extension for Redtail.

+
    +
  1. +

    Login to Redtail.

    +
    2. +
  2. +

    While visiting a Redtail application page, click the quick access button to bring the dialer to the foreground.

    +
    3. +
  3. +

    Navigate to the Settings screen in App Connect, and find the option labeled "Redtail."

    +

    Connect to Redtail

    +
    4. +
  4. +

    Click the "Connect" button.

    +
    5. +
  5. +

    A window will be opened prompting you to enter your Redtail username and password. Login to Redtail.

    +
    6. +
+

When you login successfully, the Chrome extension will automatically update to show you are connected to Redtail. If you are connected, the button next to Redtail will say, "logout".

+

And with that, you will be connected to Redtail and ready to begin using the integration.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/adapter/index.html b/developers/adapter/index.html new file mode 100644 index 00000000..284ade0a --- /dev/null +++ b/developers/adapter/index.html @@ -0,0 +1,2096 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Technical overview - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Implementing your CRM adapter

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

App Connect's developer framework comes with everything you need to build an adapter for virtually any target CRM platform. While the sample adapter that is provided through this framework is implemented in Javascript, you are free to implement your server in whatever language you prefer -- provided that it implements the interface properly. However, we recommend most developers utilize this framework directly, as it will dramatically decrease your time to market.

+

Every adapter contains two key files or elements:

+
    +
  1. A manifest file that defines and governs app behaviors
    2. +
  2. A server that the Unfied Chrome extension interfaces with to communicate with the target CRM
    3. +
+

How the Chrome extension interfaces with an adapter to talk to a CRM

+

One can think of an adapter as nothing more than an intermediary service that is responsible for translating actions performed by a user of the Chrome extension, into API calls made to a target CRM that fulfill a user's intent. Take for example when a user logs a call:

+
    +
  1. A user clicks "Log call" from the call history page.
    2. +
  2. The user fills out a form in which they enter notes and other data related to the call.
    3. +
  3. The user clicks "Save."
    4. +
  4. The Chrome extension then packages up the user's input, and sends it to the adapter.
    5. +
  5. The adapter's server receives a request stating, "a user wants to log a call."
    6. +
  6. The adapter's server then calls the target CRM's API to log a call.
    7. +
+

This basic pattern is repeated for every action the framework enables. For those who want to nerd-out on this pattern, the following sequence diagram will describe the process more thoroughly.

+

Sequence diagram

+

Flow

+

Working examples

+

The framework currently contains a total of five natively supported CRMs. These adapters are useful reference implementations for developers to learn from. The following table lists these adapters and what sets them apart from one another technically:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CRMAuth typeContact typeNote
ClioOAuthContactClio API only supports exact match for contact match by phone number, so users need to use overriding formats
PipedriveOAuthContactPipedrive has unique auth process behind OAuth, it's not recommended to be used as OAuth reference
Insightlyapi keyLead and ContactInsightly API only supports exact match for contact match by phone number, so users need to use overriding formats
BullhornOAuthCandidate and ContactBullhorn has unique auth process behind OAuth, it's not recommended to be used as OAuth reference
Redtailapi key (username & password)ContactNone
NetSuiteOAuthContactNetSuite API only supports exact match for contact match by phone number, so users need to use overriding formats
+

Development process

+

This guide will walk you through the process of creating an adapter step-by-step. At a high-level however, developers will be expected to do the following:

+ +

Let's get started.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/advanced/openapi/index.html b/developers/advanced/openapi/index.html new file mode 100644 index 00000000..436ee1b5 --- /dev/null +++ b/developers/advanced/openapi/index.html @@ -0,0 +1,2018 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Building your own server - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Building a custom adapter server

+

This developer guide is optimized and intended for Javascript developers who are implementing new adapters using the server that comes bundled with the framework. Using this built in server can save developers a ton of time because it abstracts developers away from the underlying protocol used by the Chrome extension to talk to an adapter.

+

If you would like to build your own server framework, perhaps because you personally prefer a programming language other than Javascript, you are welcome to. To implement your own server, you will need to fully implement the OpenAPI specification below.

+

JWT tokens

+

The frontend client helps to maintain a user's current authentication context, and transmits to the server with every API call a jwtToken parameter that encodes the data associated with the user making the current request. A JWT token, once decoded looks like this:

+
{
+  id: "<User ID in CRM>",
+  platform: "<the CRM being integrated with>"
+}
+
+

With this information, server can validate and identify users so to perform API actions under their accounts on CRM platforms.

+

Decoding JWT tokens

+

The JWT token created by the framework uses the APP_SERVER_SECRET_KEY environment variable as the secret to encode the token. To decode a token, we recommend using a third party library accordingly.

+
+
+
+
const { verify } = require('jsonwebtoken');
+function decodeJwt(token) {
+  try {
+    return verify(token, process.env.APP_SERVER_SECRET_KEY);
+  } catch (e) {
+    return null;
+  }
+}
+
+
+
+
+

Adapter Server OpenAPI specification

+

The OpenAPI specification below defines the interfaces that a developer must implement when creating an adapter for App Connect. Once implemented, your adapter's manifest file will specify the serverURL for your adapter's server that has implemented the interfaces defined by the OpenAPI specification below.

+

As a user uses the Chrome extension, when a CRM-specific function is engaged, the Chrome extension will compose a request the corresponding adapter's endpoint implemented by that adapter's server. The server will perform the corresponding action in the associated CRM, and return results in a prescribed format so the Chrome extension can display the results of the user's action.

+

Download OpenAPI spec

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/auth/index.html b/developers/auth/index.html new file mode 100644 index 00000000..fa20584a --- /dev/null +++ b/developers/auth/index.html @@ -0,0 +1,2299 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Authorization - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Authorization and authenticating users with their CRM

+

App Connect's framework currently supports two different authentication modalities:

+
    +
  • OAuth. This is the most common form of authentication and authorization supported by most CRMs.
    • +
  • API keys. This less common method typically requires a CRM user to retrieve an auth string, often called an "API key," and saving it within the framework. This key is then transmitted with each API request to the CRM.
    • +
+

Start by editing the platforms object within your adapter's manifest, and setting the type property under auth to either:

+
    +
  • oauth
    • +
  • apiKey
    • +
+

Connecting to a CRM via OAuth

+

When implementing OAuth, you will need to login to the target CRM as a developer to retrieve a client ID and client secret. Every CRM is different, so please consult the CRM's API documentation to learn how to generate these two values to uniquely identify your application that will be calling the CRM's APIs.

+

Once you have obtained these values, you will need to set the following values in your adapter's manifest:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
platforms.{crmName}.auth.oauth.authUrlstringThe auth URL to initiate the OAuth process with the CRM. Eg. https://app.clio.com/oauth/authorize
platforms.{crmName}.auth.oauth.clientIdstringOnly used with authType equal to oauth. The client ID of the application registered with the CRM to access it's API.
platforms.{crmName}.auth.oauth.redirectUristringYou can use your own uri, but the default one https://ringcentral.github.io/ringcentral-embeddable/redirect.html should work in most cases.
platforms.{crmName}.auth.oauth.scopestring(Optional) Only if you want to specify scopes in OAuth url. eg. "scope":"scopes=write,read"
platforms.{crmName}.auth.oauth.customStatestring(Optional) Only if you want to override state query string in OAuth url. The state query string will be state={customState} instead.
+

Generating an Auth URL

+

The framework will compose an OAuth compliant auth URL for you by appending to the authUrl the following query string:

+
{authUrl}?responseType=code&client_id={clientId}&{scope}&state=platform={name}
+    &redirect_uri=https://ringcentral.github.io/ringcentral-embeddable/redirect.html
+
+

Setting the redirect URI

+

App Connect's framework utilizes a a fixed redirect URI for OAuth. This redirect URI is:

+
https://ringcentral.github.io/ringcentral-embeddable/redirect.html
+
+

It should suffice standard OAuth use cases. If there's any special case, please contact us.

+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Connecting to a CRM using an API key

+

Some CRMs provide developers access to their API via an API key. An API key is a slightly more cumbersome connection process for users, in that they must go into a technical part of the CRM to retrieve an obscure text string. But, the App Connect framework does what it can to make the process as easy as possible for users.

+

To auth a user via an API key, you need to present them with a form in which they will enter all needed credentials. The user will save those values and the framework will stash them a secure database for you.

+

Setup the auth page in the extension

+

Sample CRM adapter

+
+
+
+
            "auth": {
+                "type": "apiKey",
+                "apiKey": {
+                    "page": {
+                        "title": "test CRM",
+                        "content": [
+                            {
+                                "const": "apiKey",
+                                "title": "apiKey",
+                                "type": "string",
+                                "required": true
+                            }
+                        ]
+                    }
+                },
+
+
+
+

Auth page

+
+
+
+

Insightly adapter

+
+
+
+
                                    "title": "5"
+                                },
+                                {
+                                    "const": "6",
+                                    "title": "6"
+                                },
+                                {
+                                    "const": "7",
+                                    "title": "7"
+                                },
+                                {
+                                    "const": "8",
+                                    "title": "8"
+                                },
+                                {
+                                    "const": "9",
+                                    "title": "9"
+                                },
+                                {
+                                    "const": "10",
+                                    "title": "10"
+                                }
+                            ],
+                            "required": true
+                        },
+                        {
+                            "const": "feedback",
+                            "title": "Feedback",
+                            "type": "inputField",
+                            "placeholder": "Please share your feedback...",
+                            "required": true
+                        }
+                    ]
+
+
+
+

Auth page

+
+
+
+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Deauthorizing users

+

Just as one needs to log someone in, they need to log someone out.

+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Testing your authorization implementation

+

Now that the necessary server endpoints have been implemented, and the manifest updated, let's test authorization.

+
    +
  1. Refresh and or save the Custom CRM config url setting under the extension's options.
    2. +
  2. Access the Chrome extension.
    3. +
  3. Log out and log back into your CRM using the "Connect" button under the Settings tab, or by going through the appropriate CRM login and authorization flow for your adapter.
    4. +
  4. Finally, check to see if any user info was saved in the database (CHECK.1)
    5. +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/beta_notice.inc b/developers/beta_notice.inc new file mode 100644 index 00000000..cf2d287a --- /dev/null +++ b/developers/beta_notice.inc @@ -0,0 +1,2 @@ +!!! tip "The developer framework is currently in BETA" + This framework is in beta. Please [submit a Github issue](https://github.com/ringcentral/rc-unified-crm-extension/issues) if you encounter any problems or have a question. diff --git a/developers/contact-matching/index.html b/developers/contact-matching/index.html new file mode 100644 index 00000000..807d6399 --- /dev/null +++ b/developers/contact-matching/index.html @@ -0,0 +1,2009 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Contact matching - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Loading a contact record

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

A critical function performed by the server is looking up a contact record in the target CRM given a phone number, and returning a list of matches for that phone number. In addition, the framework will transmit a list of alternative phone number formats to search for.

+
+

Alternative phone number formats

+

Some CRMs expose a contact search API that is very strict with regards to phone number lookup. For example, if a CRM only supports an EXACT MATCH then searching for an E.164 phone number may not yield any results if the phone number is stored in any other format.

+

As a workaround, the CRM framework allows users to specify additional phone number formats that they typically store phone numbers in. This list of phone numbers is transmitted to the adapter's server, so that the associated adapter can search for a contact using multiple phone number formats until one is found.

+
+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Test

+
    +
  1. Create a new contact on CRM platform and make a call to it
    2. +
  2. In extension, near call record, click Refresh contact to check if console prints correct results (CHECK.3)
    3. +
+

Multiple contact types

+

The framework supports multiple contact types at basic levels. Please refer to existing bullhorn or insightly code implementation and manifest for more details.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/crm-server-openapi.json b/developers/crm-server-openapi.json new file mode 100644 index 00000000..6fdbc2b4 --- /dev/null +++ b/developers/crm-server-openapi.json @@ -0,0 +1,1235 @@ +{ + "openapi": "3.1.0", + "x-stoplight": { + "id": "ax9bati9jfiia" + }, + "info": { + "title": "CRM Server", + "version": "1.0" + }, + "servers": [ + { + "url": "http://localhost:3000" + } + ], + "paths": { + "/is-alive": { + "get": { + "summary": "Check alive", + "tags": [], + "responses": { + "200": { + "description": "OK" + } + }, + "operationId": "get-is-alive", + "x-stoplight": { + "id": "wsrp3bw48gyo5" + }, + "description": "Check if the service is alive" + } + }, + "/apiKeyLogin": { + "post": { + "summary": "API Key login", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jwtToken": { + "type": "string", + "x-stoplight": { + "id": "10qqb5ehrljhk" + } + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "4vq6f6mqq6zsa" + }, + "description": "user name" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "post-apiKeyLogin", + "x-stoplight": { + "id": "crildy7xiek3f" + }, + "description": "Login with api key", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "platform", + "apiKey", + "rcUserNumber" + ], + "properties": { + "platform": { + "type": "string", + "x-stoplight": { + "id": "n05gfacsxrdip" + } + }, + "apiKey": { + "type": "string", + "x-stoplight": { + "id": "i5wityc2cmuel" + } + }, + "hostname": { + "type": "string", + "x-stoplight": { + "id": "h1t2viitn4xj5" + } + }, + "addiotionalInfo": { + "type": "object", + "x-stoplight": { + "id": "j0220db63h14m" + } + }, + "rcUserNumber": { + "type": "string", + "x-stoplight": { + "id": "oebn0qtnvkopd" + } + } + } + } + } + } + } + } + }, + "/oauth-callback": { + "get": { + "summary": "OAuth callback", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jwtToken": { + "type": "string", + "x-stoplight": { + "id": "5vxbz26z6l9oy" + } + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "tfe69r2iqiwvx" + }, + "description": "user name" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "get-oauth-callback", + "x-stoplight": { + "id": "ehkb42r05v7e2" + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "callbackUri", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "state", + "description": "platform={platformName}", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "hostname", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "tokenUrl", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "apiUrl" + }, + { + "name": "apiUrl" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "rcUserNumber" + } + ] + } + }, + "/unAuthorize": { + "post": { + "summary": "Unauthorize", + "tags": [], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "post-unAuthorize", + "x-stoplight": { + "id": "nacapxxr3q4il" + }, + "description": "Disconnect user from CRM platform and this server", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + } + ] + } + }, + "/contact": { + "get": { + "summary": "Get contact by phone number", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "2f52v91xunc4i" + } + }, + "message": { + "type": "string", + "x-stoplight": { + "id": "exzrm4pbywter" + } + }, + "contact": { + "type": "array", + "x-stoplight": { + "id": "r9cjdaan7yyh7" + }, + "items": { + "$ref": "#/components/schemas/Contact", + "x-stoplight": { + "id": "gy35197gthefq" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "get-contact", + "x-stoplight": { + "id": "ys0wfqnv9umky" + }, + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + }, + { + "$ref": "#/components/parameters/phoneNumber" + }, + { + "$ref": "#/components/parameters/overridingFormat" + } + ], + "description": "Get matched contact by phone number" + }, + "post": { + "summary": "Create new contact", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "6fdsa8bl8bhbu" + } + }, + "message": { + "type": "string", + "x-stoplight": { + "id": "9u77teo9zp0cb" + } + }, + "contact": { + "type": "object", + "x-stoplight": { + "id": "qxv3apix2otos" + }, + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "6cy9w8szm97xm" + } + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "ijrdza44ug58r" + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "post-contact", + "x-stoplight": { + "id": "r0q1du1ktryl3" + }, + "description": "Create a new contact", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + }, + { + "$ref": "#/components/parameters/phoneNumber" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "newContactName", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "newContactType" + } + ] + } + }, + "/callLog": { + "get": { + "summary": "Get call log", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "jct667j77gql5" + } + }, + "logs": { + "type": "array", + "x-stoplight": { + "id": "dlzvgv9rz8xgf" + }, + "items": { + "$ref": "#/components/schemas/CallLog", + "x-stoplight": { + "id": "vohdhwnc0p8bx" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "get-callLog", + "x-stoplight": { + "id": "woyocv23ekr6i" + }, + "description": "Get a call log", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "sessionIds", + "description": "rc call session ids, separated by ','" + } + ] + }, + "post": { + "summary": "Create call log", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "739cjrgtqqlr8" + } + }, + "message": { + "type": "string", + "x-stoplight": { + "id": "5m354yj9nehu9" + } + }, + "logId": { + "type": "string", + "x-stoplight": { + "id": "zguuos0ut9hsx" + }, + "description": "crm log id" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "post-callLog", + "x-stoplight": { + "id": "a8qukn395u0u2" + }, + "description": "Create a call log", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logInfo": { + "$ref": "#/components/schemas/LogInfo", + "x-stoplight": { + "id": "23wbzs8vvmh58" + } + }, + "additionalSubmission": { + "type": "object", + "x-stoplight": { + "id": "ahhkqiplywoz6" + } + }, + "note": { + "type": "string", + "x-stoplight": { + "id": "oe8sm13mqvh1f" + } + }, + "contactId": { + "type": "string", + "x-stoplight": { + "id": "2xegvtrsxurpo" + } + }, + "contactType": { + "type": "string", + "x-stoplight": { + "id": "e01zhn6e7gk2k" + } + }, + "contactName": { + "type": "string", + "x-stoplight": { + "id": "6reewjsinuupk" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update call log", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "l6aholr3se9r6" + } + }, + "logId": { + "type": "string", + "x-stoplight": { + "id": "87oorc4x9q7x4" + }, + "description": "CRM log id" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "patch-callLog", + "x-stoplight": { + "id": "9nx2iv9vlwl4p" + }, + "description": "Update an existing call log", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sessionId": { + "type": "string", + "x-stoplight": { + "id": "to6ajlgvdpn3w" + } + }, + "recordingLink": { + "type": "string", + "x-stoplight": { + "id": "oi0k450vd58e4" + } + }, + "subject": { + "type": "string", + "x-stoplight": { + "id": "4n2v45ot95zqh" + } + }, + "note": { + "type": "string", + "x-stoplight": { + "id": "7vmsmt3oc2bbk" + } + } + } + } + } + } + } + } + }, + "/messageLog": { + "post": { + "summary": "Create message log", + "tags": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "successful": { + "type": "boolean", + "x-stoplight": { + "id": "9k5zkbk6t9n36" + } + }, + "message": { + "type": "string", + "x-stoplight": { + "id": "2zvj6yhjtfkqu" + } + }, + "logs": { + "type": "array", + "x-stoplight": { + "id": "hetojdzchqx5p" + }, + "items": { + "x-stoplight": { + "id": "cwoiq3b9ig1hb" + }, + "type": "string" + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + } + }, + "operationId": "post-messageLog", + "x-stoplight": { + "id": "x01j7m5l5zyo9" + }, + "description": "Create message log for conversation grouped by day", + "parameters": [ + { + "$ref": "#/components/parameters/jwtToken" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logInfo": { + "$ref": "#/components/schemas/MessageLogInfo", + "x-stoplight": { + "id": "h7cd988gldzy3" + } + }, + "additionalSubmission": { + "type": "string", + "x-stoplight": { + "id": "kqr92h2m6db7s" + } + }, + "contactId": { + "type": "string", + "x-stoplight": { + "id": "yjw1jt7u81c7o" + } + }, + "contactName": { + "type": "string", + "x-stoplight": { + "id": "gecaa62dam73k" + } + }, + "contactType": { + "type": "string", + "x-stoplight": { + "id": "uk3pmbi4mqmr4" + } + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Contact": { + "title": "Contact", + "x-stoplight": { + "id": "3ymdfye4pri44" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "9560cbe1rf235" + } + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "0nv6pkgvnq4e3" + } + }, + "phone": { + "type": "string", + "x-stoplight": { + "id": "p71pyljk4izb3" + } + }, + "additionalInfo": { + "type": "object", + "x-stoplight": { + "id": "szzyct04i03rx" + } + } + } + }, + "CallLog": { + "title": "CallLog", + "x-stoplight": { + "id": "al5qijw6fx9kp" + }, + "type": "object", + "properties": { + "matched": { + "type": "boolean", + "x-stoplight": { + "id": "aueuh8t7f01cc" + } + }, + "sessionId": { + "type": "string", + "x-stoplight": { + "id": "djjfc32adp6vc" + } + }, + "logId": { + "type": "string", + "x-stoplight": { + "id": "kvia31dbfp0h5" + }, + "description": "crm log id" + }, + "logData": { + "type": "object", + "x-stoplight": { + "id": "l9tqlw40il91r" + } + } + } + }, + "CallLogInfo": { + "type": "object", + "x-stoplight": { + "id": "16d06b2d7dc24" + }, + "properties": { + "id": { + "type": "string" + }, + "sessionId": { + "type": "string" + }, + "startTime": { + "type": "integer" + }, + "duration": { + "type": "integer" + }, + "durationMs": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "internalType": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "action": { + "type": "string" + }, + "result": { + "type": "string" + }, + "to": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "location": { + "type": "string" + } + } + }, + "from": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "extensionId": { + "type": "string" + } + } + }, + "extension": { + "type": "object", + "properties": { + "uri": { + "type": "string" + }, + "id": { + "type": "integer" + } + } + }, + "delegationType": { + "type": "string" + }, + "telephonySessionId": { + "type": "string" + }, + "partyId": { + "type": "string" + }, + "fromName": { + "type": "string" + }, + "toName": { + "type": "string" + }, + "fromMatches": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + }, + "toMatches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "phoneNumbers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "phoneType": { + "type": "string" + } + } + } + }, + "entityType": { + "type": "string" + } + } + } + }, + "activityMatches": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + } + }, + "x-examples": { + "Example 1": { + "id": "LByZ2jyZk-cMzUA", + "sessionId": "533278004020", + "startTime": 1713752379489, + "duration": 13, + "durationMs": 12721, + "type": "Voice", + "internalType": "LongDistance", + "direction": "Outbound", + "action": "VoIP Call", + "result": "Call connected", + "to": { + "phoneNumber": "+16508446672", + "location": "San Mateo, CA" + }, + "from": { + "name": "Da Kong", + "phoneNumber": "+18885287464", + "extensionId": "4024345020" + }, + "extension": { + "uri": "https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/4024345020", + "id": 4024345020 + }, + "delegationType": "Unknown", + "telephonySessionId": "s-a0d7aba0b6f6fz18f039a0f91z1b6725b0000", + "partyId": "p-a0d7aba0b6f6fz18f039a0f91z1b6725b0000-2", + "fromName": "Da Kong", + "toName": "+16508446672", + "fromMatches": [], + "toMatches": [ + { + "id": 2013707553, + "type": "clio", + "name": "Test 123", + "phoneNumbers": [ + { + "phoneNumber": "+16508446672", + "phoneType": "direct" + } + ], + "entityType": "clio" + } + ], + "activityMatches": [] + } + } + }, + "MessageLogInfo": { + "type": "object", + "properties": { + "conversationLogId": { + "type": "string" + }, + "conversationId": { + "type": "string" + }, + "creationTime": { + "type": "integer" + }, + "date": { + "type": "string" + }, + "type": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "to": { + "type": "array", + "items": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "from": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "name": { + "type": "string" + }, + "location": { + "type": "string" + } + } + }, + "type": { + "type": "string" + }, + "creationTime": { + "type": "integer" + }, + "readStatus": { + "type": "string" + }, + "priority": { + "type": "string" + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "uri": { + "type": "string" + }, + "type": { + "type": "string" + }, + "contentType": { + "type": "string" + } + } + } + }, + "direction": { + "type": "string" + }, + "availability": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "messageStatus": { + "type": "string" + }, + "smsSendingAttemptsCount": { + "type": "integer" + }, + "conversationId": { + "type": "string" + }, + "lastModifiedTime": { + "type": "integer" + } + } + } + }, + "conversationLogMatches": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + }, + "self": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "name": { + "type": "string" + }, + "location": { + "type": "string" + } + } + }, + "correspondents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "phoneNumber": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + } + }, + "x-examples": { + "Example 1": { + "conversationLogId": "2052636401630275685/4/17/2024", + "conversationId": "2052636401630275685", + "creationTime": 1713322040000, + "date": "4/17/2024", + "type": "SMS", + "messages": [ + { + "id": 2354773896020, + "to": [ + { + "phoneNumber": "+13133982125", + "location": "Detroit, MI" + } + ], + "from": { + "phoneNumber": "+17206789819", + "name": "Da Kong", + "location": "Denver, CO" + }, + "type": "SMS", + "creationTime": 1713322040000, + "readStatus": "Read", + "priority": "Normal", + "attachments": [ + { + "id": 2354773896020, + "uri": "https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/4024345020/message-store/2354773896020/content/2354773896020", + "type": "Text", + "contentType": "text/plain" + } + ], + "direction": "Outbound", + "availability": "Alive", + "subject": "test 7", + "messageStatus": "DeliveryFailed", + "smsSendingAttemptsCount": 1, + "conversationId": "2052636401630275685", + "lastModifiedTime": 1713322042372 + }, + { + "id": 2354773534020, + "to": [ + { + "phoneNumber": "+13133982125", + "location": "Detroit, MI" + } + ], + "from": { + "phoneNumber": "+17206789819", + "name": "Da Kong", + "location": "Denver, CO" + }, + "type": "SMS", + "creationTime": 1713319980000, + "readStatus": "Read", + "priority": "Normal", + "attachments": [ + { + "id": 2354773534020, + "uri": "https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/4024345020/message-store/2354773534020/content/2354773534020", + "type": "Text", + "contentType": "text/plain" + } + ], + "direction": "Outbound", + "availability": "Alive", + "subject": "test 6", + "messageStatus": "DeliveryFailed", + "smsSendingAttemptsCount": 1, + "conversationId": "2052636401630275685", + "lastModifiedTime": 1713319982724 + } + ], + "conversationLogMatches": [], + "self": { + "phoneNumber": "+17206789819", + "name": "Da Kong", + "location": "Denver, CO" + }, + "correspondents": [ + { + "phoneNumber": "+13133982125", + "location": "Detroit, MI" + } + ] + } + } + } + }, + "parameters": { + "jwtToken": { + "name": "jwtToken", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "auth token between client and server" + }, + "phoneNumber": { + "name": "phoneNumber", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "contact phone number, in E.164 format" + }, + "overridingFormat": { + "name": "overridingFormat", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Formatter to modify number format (eg. (***) ***-****. for +11234567890 -> (123) 456-7890) " + } + } + } +} \ No newline at end of file diff --git a/developers/deploy/index.html b/developers/deploy/index.html new file mode 100644 index 00000000..6e0c00cf --- /dev/null +++ b/developers/deploy/index.html @@ -0,0 +1,2036 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Build and deployment - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Build and deploy a CRM adapter

+

Once you have developed your adapter for a CRM, it is time to try it out. To do that, you will need to deploy your adapter's server to a publicly accessible server

+

Deploying server to AWS

+

Technically your adapter's server could be deployed anywhere. You could host it yourself, or deploy it to a third-party like Heroku or AWS. To assist developers, we have provided a serverless config file for AWS deployment under the serverless-deploy.

+
    +
  1. +

    Customize your environment

    +
    cd rc-unified-crm-extension/serverless-deploy
+cp sample.env.yml env.yml
+
    +

    Then edit env.yml.

    +
    2. +
  2. +

    Customize your serverless deploy config

    +
    cp sample.serverless.yml serverless.yml
+
    +

    Then edit serverless.yml

    +
    3. +
  3. +

    Build and deploy the server

    +
    npm run serverless-build
+npm run serverless-deploy
+
    +
    4. +
+
+

Deploying to another platform

+

If you want to deploy it to other platform. Run npm run build-local and a build folder will be created for you in the build folder. You can then deploy this build folder to any other hosting provider.

+
+

Server environment variables

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VariableDescription
APP_SERVERURL for your backend server
APP_SERVER_SECRET_KEYKey to create secret toke between your server and client
TEST_CRM_CLIENT_IDIf CRM uses OAuth, it should be the client ID for OAuth
TEST_CRM_CLIENT_SECRETIf CRM uses OAuth, it should be the client secret for OAuth
TEST_CRM_ACCESS_TOKEN_URIIf CRM uses OAuth, it should access token url for OAuth
TEST_CRM_REDIRECT_URIYou can use the default redirect URI, or change it to yours
DATABASE_URLURL for your database, the default one is for local sqlite database
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/errors/index.html b/developers/errors/index.html new file mode 100644 index 00000000..1249dc7a --- /dev/null +++ b/developers/errors/index.html @@ -0,0 +1,1978 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Returning errors - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Returning messages to client

+

When implementing your adapter, you will encounter the need to provide feedback to the end user interacting with the adapter. For example you may wish to display:

+
    +
  • an error message
    • +
  • a confirmation message
    • +
  • a warning
    • +
+

Within your adapter, you can cause App Connect to display a message to a user by returning a returnMessage construct in an given interface. Here's a quick example for create call log return in testCRM:

+
return {
+    logId: addLogRes.data.id,
+    returnMessage: {
+        message: 'Call log added.',
+        messageType: 'success',
+        ttl: 3000
+    }
+};
+
+

Return message parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
messageThe message to display.
messageTypeThere are 3 message types: success, warning and danger.
ttlThe length of time to display the message (in milliseconds) before it disappears automatically.
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/flow.puml b/developers/flow.puml new file mode 100644 index 00000000..c6abbcae --- /dev/null +++ b/developers/flow.puml @@ -0,0 +1,44 @@ +@startuml +actor User as u +entity Extension as e +entity Server as s +entity CRM_API as crm + +group CRM Auth + group OAuth + u -> e: click Connect button and allow auth + e -> crm: OAuth request + crm -> e: OAuth callback + e -> s: callback data (auth code) + s -> crm: exchange auth tokens + crm -> s: crm auth tokens + s -> crm: get user info + crm -> s: user info + s -> e: jwt (auth token between extension and server) + group token refresh + note over e, crm: triggered by any CRM API call, contact match here used as example + e -> s: contact match request + s -> s: check if token expired, if yes + s -> crm: refresh token request + crm -> s: new tokens + s -> crm: contact match request + crm -> s: contact info + s -> e: contact info + end + end + group API Key + u -> e: click Connect button and submit API key + e -> s: API key + s -> crm: API key + crm -> s: user info + s -> e: jwt (auth token between extension and server) + end +end + +group Contact creating/matching & Call/Message logging + e -> s: request data and jwt + s -> crm: API request data and accessToken/apiKey + crm -> s: response + s -> e: data +end +@enduml \ No newline at end of file diff --git a/developers/getting-started/index.html b/developers/getting-started/index.html new file mode 100644 index 00000000..01172f7e --- /dev/null +++ b/developers/getting-started/index.html @@ -0,0 +1,2066 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Getting started - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Getting started building a custom CRM adapter

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

Every CRM adapter requires a manifest file which provides developers a way to configure and customize the framework properly for the associated CRM. Via the adapter's manifest, developers can:

+
    +
  • Provide CRM connectivity and authorization details
    • +
  • Define custom fields for:
      +
    • call logging and disposition forms
      • +
    • SMS and messagig logging forms
      • +
    +
    • +
  • Customize the "Connect to CRM" or authorization screen
    • +
  • Define custom contact record types/categories
    • +
  • Customize the welcome screen for a given CRM
    • +
+

Clone or fork the framework's repository

+

Let's begin by downloading the framework to your development machine.

+
> git clone https://github.com/ringcentral/rc-unified-crm-extension.git
+> cd rc-unified-crm-extension
+
+

Next, copy the contents of the test CRM adapter to a new folder where your adapter will be placed.

+
> cp src/adapters/testCRM src/adapters/my-crm-adatper
+
+

Setup and start your server

+

Each adapter requires a server to be running. This server exposes a canonical API to the App Connect framework, and in a sense acts as a broker or proxy between the front-end client, and the CRM. Let's setup and start the sample server bundled with the framework.

+

Open up a console and within it, follow these instructions.

+
    +
  1. +

    Install the necessary prerequisites

    +
    npm i
+
    +
    2. +
  2. +

    Start ngrok

    +
    npm run ngrok
+
    +

    Make note of your personalized ngrok URL (referred as https://xxxx.ngrok.app below).

    +
    3. +
  3. +

    Edit your server's manifest file in the rc-unified-crm-extension/server directory

    +
    cp .env.test .env
+
    +

    Edit .env and set APP_SERVER equal to your personalized ngrok URL above.

    +
    4. +
  4. +

    Edit test CRM manifest file in the rc-unified-crm-extension/src/adapters/testCRM directory

    +

    Change serverUrl in manifest.json to https://xxxx.ngrok.app

    +
    5. +
  5. +

    Start your server from the rc-unified-crm-extension/server directory

    +
    npm run start
+
    +
    6. +
+

Install and configure the client

+

Download Chrome extension from Chrome Web Store

+

Right click extension's icon and go to Options, change Custom CRM manifest url to the following URL:

+

https://xxxx.ngrok.app/crmManifest?platformName=testCRM

+

Click "Save."

+
+

What to do if saving options doesn't work

+

If the option save failed, please try if you can manually open the manifest file from browser. Sometimes there's network policy that blocks web tunnel like ngrok.

+
+

Now, the extension is setup with a manifest that serves testCRM. From the manifest file we can tell that the variable okatforms.testCRM.urlIdentifier = "*.labs.ringcentral.com/*". Let's use https://unified-crm-extension.labs.ringcentral.com/is-alive as the test CRM homepage.

+

Open the extension on the page and login with your RingCentral account. Then you should be able to play with mock data and see how this extension works.

+

Next step: edit your manifest file

+
+

Fork this repo and track changes better

+

Under this framework, there are 1 javascript file and 1 manifest.json file that you'll need to create which are new files therefore won't prevent you from fetching the latest changes from this repo. Please don't change anything outside of that in case of conflicts in pull actions.

+
+

With this step complete, you now have a shell of an adapter in place and you are ready to begin development. Let's start by customizing your adapter's manifest file.

+

Implement an authorization layer

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/index.html b/developers/index.html new file mode 100644 index 00000000..033bda45 --- /dev/null +++ b/developers/index.html @@ -0,0 +1,1975 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Integrating with CRMs using the App Connect framework

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

Welcome to RingCentral's App Connect integration framework. Using this framework, developers can integrate RingCentral into their web-based CRM more easily. The framework is centered around enabling the following features common to many CRM integrations:

+
    +
  • Embedded phone. Injecting a phone into the CRM for a fully-integrated communications experience.
    • +
  • Call pop. Automatically opening up a contact record when a call is received.
    • +
  • Logging calls. Capturing and storing call notes in an activity record linked to an associated contact in the CRM.
    • +
+
+
+

Powered by RingCentral Embeddable

+

RingCentral Embeddable

+

App Connect's integration framework is build on top of RingCentral Embeddable, which itself provides the following capabilities via its unified communications client:

+
    +
  • Make and receive phone calls.
    • +
  • Send and receive SMS.
    • +
  • Read and send team chat messages.
    • +
  • Search your RingCentral address book.
    • +
  • View a history of past calls.
    • +
  • Listen to call recordings.
    • +
  • Access and listen to voicemail.
    • +
+
+
+

Architectural overview

+

Each CRM supported by this framework is required to implement what is referred to as an "adapter." Adapters help broker communications between the client application (the dialer and primary user interface) and the CRM being integrated with.

+

Adapter architecture diagram

+

Each adapter implements the following components:

+
    +
  • A configuration file, or manifest that defines basic metadata and provides a no-code interface for defining common user interactions.
    • +
  • A server that implements a prescribed interface that is invoked by the front-end client to perform more complex interactions with the CRM.
    • +
+

In this guide, you will learn how to build, package and distribute an adapter for a CRM.

+

Get started using the framework

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/createCallLog/index.html b/developers/interfaces/createCallLog/index.html new file mode 100644 index 00000000..c10b98c8 --- /dev/null +++ b/developers/interfaces/createCallLog/index.html @@ -0,0 +1,2257 @@ + + + + + + + + + + + + + + + + + + + + + + + + + createCallLog - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

addCallLog

+

This interface is responsible for creating a new call log record in the associated CRM. The call must be associated with the contact passed in as a request parameter. Other associations may be made depending upon the CRM and the adapter.

+

Input parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
contactInfoAn associative array describing the contact a call is associated with.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
callLogAll the metadata associated with the call to be logged. Call Log schema is described in our API Reference.
noteThe notes saved by the user during and/or after the call.
additionalSubmissionAll of the additional custom fields defined in the manifest and submitted by the user.
timezoneOffsetThe timezone offset of the current user in the event you need to use UTC when calling the CRM's API.
+

Contact Info

+
{ 
+  id: "<string">,
+  type: "<string>", 
+  phoneNumber: "<E.164 Phone Number>",
+  name: "<string>"
+}
+
+

Return value(s)

+

An object with following properties:

+ + + + + + + + + + + + + + + + + +
ParameterDescription
logIdID of the log entry created within the CRM
returnMessagemessage, messageType and ttl
+

Example +

  return {
+    logId: "xxx-xxxxx", // ID of log entity on CRM platform
+    returnMessage:{
+      message: 'Call logged',
+      messageType: 'success', // 'success', 'warning' or 'danger'
+      ttl: 30000 // in miliseconds
+    }
+  }
+

+

Reference

+
+
+
+
    };  //[{id, name, phone, additionalInfo}]
+}
+
+// - contactInfo: { id, type, phoneNumber, name }
+// - callLog: same as in https://developers.ringcentral.com/api-reference/Call-Log/readUserCallRecord
+// - note: note submitted by user
+// - additionalSubmission: all additional fields that are setup in manifest under call log page
+async function createCallLog({ user, contactInfo, authHeader, callLog, note, additionalSubmission }) {
+    // ------------------------------------
+    // ---TODO.4: Implement call logging---
+    // ------------------------------------
+
+    // const postBody = {
+    //     subject: callLog.customSubject ?? `[Call] ${callLog.direction} Call ${callLog.direction === 'Outbound' ? 'to' : 'from'} ${contactInfo.name} [${contactInfo.phone}]`,
+    //     body: `\nContact Number: ${contactInfo.phoneNumber}\nCall Result: ${callLog.result}\nNote: ${note}${callLog.recording ? `\n[Call recording link] ${callLog.recording.link}` : ''}\n\n--- Created via RingCentral App Connect`,
+    //     type: 'PhoneCommunication',
+    //     received_at: moment(callLog.startTime).toISOString()
+    // }
+    // const addLogRes = await axios.post(
+    //     `https://api.crm.com/activity`,
+    //     postBody,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+    console.log(`adding call log... \n${JSON.stringify(callLog, null, 2)}`);
+    console.log(`with note... \n${note}`);
+    console.log(`with additional info... \n${JSON.stringify(additionalSubmission, null, 2)}`);
+    mockCallLog = {
+        id: 'testCallLogId',
+        subject: callLog.customSubject,
+        note,
+        contactName: contactInfo.name
+    }
+    const addLogRes = {
+        data: {
+            id: mockCallLog.id
+        }
+    }
+    //----------------------------------------------------------------------------
+    //---CHECK.4: Open db.sqlite and CRM website to check if call log is saved ---
+    //----------------------------------------------------------------------------
+    return {
+        logId: addLogRes.data.id,
+
+
+
+
        returnMessage: {
+            message: `New contact created.`,
+            messageType: 'success',
+            ttl: 3000
+        }
+    }
+}
+
+async function createCallLog({ user, contactInfo, authHeader, callLog, note, additionalSubmission }) {
+    const dealId = additionalSubmission ? additionalSubmission.deals : '';
+    const personResponse = await axios.get(`https://${user.hostname}/v1/persons/${contactInfo.id}`, { headers: { 'Authorization': authHeader } });
+    const orgId = personResponse.data.data.org_id?.value ?? '';
+    const timeUtc = moment(callLog.startTime).utcOffset(0).format('HH:mm')
+    const dateUtc = moment(callLog.startTime).utcOffset(0).format('YYYY-MM-DD');
+    let noteBody = '<b>Agent notes</b>';;
+    if (user.userSettings?.addCallLogNote?.value ?? true) { noteBody = upsertCallAgentNote({ body: noteBody, note }); }
+    noteBody += '<b>Call details</b><ul>';
+    if (user.userSettings?.addCallLogContactNumber?.value ?? true) { noteBody = upsertContactPhoneNumber({ body: noteBody, phoneNumber: contactInfo.phoneNumber, direction: callLog.direction }); }
+    if (user.userSettings?.addCallLogDateTime?.value ?? true) { noteBody = upsertCallDateTime({ body: noteBody, startTime: callLog.startTime, timezoneOffset: user.timezoneOffset }); }
+    if (user.userSettings?.addCallLogDuration?.value ?? true) { noteBody = upsertCallDuration({ body: noteBody, duration: callLog.duration }); }
+    if (user.userSettings?.addCallLogResult?.value ?? true) { noteBody = upsertCallResult({ body: noteBody, result: callLog.result }); }
+    if (!!callLog.recording?.link && (user.userSettings?.addCallLogRecording?.value ?? true)) { noteBody = upsertCallRecording({ body: noteBody, recordingLink: callLog.recording.link }); }
+    noteBody += '</ul>';
+    const postBody = {
+        user_id: user.id,
+        subject: callLog.customSubject ?? `${callLog.direction} Call ${callLog.direction === 'Outbound' ? 'to' : 'from'} ${contactInfo.name}`,
+        duration: callLog.duration,    // secs
+        person_id: contactInfo.id,
+        org_id: orgId,
+        deal_id: dealId,
+        note: noteBody,
+        done: true,
+        due_date: dateUtc,
+
+
+
+
+

Example Call Log Schema

+
{
+  "uri" : "https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AvJPtwNQbNQA?view=Detailed",
+  "id" : "X2AvJPtwNQbNQA",
+  "sessionId" : "4503991004",
+  "telephonySessionId": "s-9a03590172ea4d39a7cf7d5b6dba6a3b",
+  "startTime" : "2018-09-11T13:24:09.000Z",
+  "duration" : 7,
+  "type" : "Voice",
+  "direction" : "Inbound",
+  "action" : "Phone Call",
+  "result" : "Accepted",
+  "to" : {
+    "phoneNumber" : "+18662019834",
+    "name" : "Jane Smith"
+  },
+  "from" : {
+    "phoneNumber" : "+16504445566",
+    "name" : "John Smith",
+    "location" : "Palo Alto, CA"
+  },
+  "extension" : {
+    "uri" : "https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004",
+    "id" : 1477535004
+  },
+  "transport" : "PSTN",
+  "lastModifiedTime" : "2018-09-11T13:24:12.003Z",
+  "billing" : {
+    "costIncluded" : 0.000,
+    "costPurchased" : 0.000
+  },
+  "legs" : [ {
+    "startTime" : "2018-09-11T13:24:09.000Z",
+    "duration" : 7,
+    "type" : "Voice",
+    "direction" : "Inbound",
+    "action" : "Phone Call",
+    "result" : "Accepted",
+    "to" : {
+      "phoneNumber" : "+18662019834",
+      "name" : "Jane Smith"
+    },
+    "from" : {
+      "phoneNumber" : "+16504445566",
+      "name" : "John Smith",
+      "location" : "Palo Alto, CA"
+    },
+    "extension" : {
+      "uri" : "https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004",
+      "id" : 1477535004
+    },
+    "transport" : "PSTN",
+    "legType" : "Accept",
+    "master" : true
+  } ]
+}
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/createContact/index.html b/developers/interfaces/createContact/index.html new file mode 100644 index 00000000..36ab5498 --- /dev/null +++ b/developers/interfaces/createContact/index.html @@ -0,0 +1,2178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + createContact - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

createContact

+

This interface is invoked whenever a new contact needs to be created in the target CRM. This happens when a user of App Connect has elected to create a "placeholder contact."

+

This function is to create a placeholder contact, ONLY in the following case: +* User adds a new call/message log against a number with no matched contact. In another words, create placeholder contact is tied to call/message logging action

+

Manifest elements

+

Every CRM can define a different set of contact types, or data elements that can be associated with an activity (call or SMS) log. Within the platforms.[crm name] section of your manifest, provide the list of contact types supported by the target CRM.

+
..snip..
+"contactTypes": [
+  {
+    "display": "TestContactType",
+    "value": "testContact"
+  },
+  {
+    "display": "Contact",
+    "value": "cta"
+  }
+],
+..snip..
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
phoneNumberThe phone number of the contact in E.164 format, e.g. +1231231234.
newContactNameThe name of the contact as entered by the user.
newContactTypeThe contact type the user selected to indicate what kind of contact to create.
+

Return value(s)

+

This interface returns a single object. That object describes the contact that was created. It has following properties:

+ + + + + + + + + + + + + + + + + +
ParameterDescription
contactInfoContain id and name
returnMessagemessage, messageType and ttl
+

Example

+
{
+  contactInfo:{
+    id: "xxxx-xxxxx", // ID of the contact in the target 
+    name: "John Doe" // Display name of the contact. This name will appear and be associated with all users with the same `phoneNumber`.
+  },
+  returnMessage:{
+    message: 'Contact created',
+    messageType: 'success', // 'success', 'warning' or 'danger'
+    ttl: 30000 // in miliseconds
+  }
+}
+
+

Reference

+
+
+
+
    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+    console.log(`update message log with... \n\n${JSON.stringify(message, null, 2)}`);
+
+    //---------------------------------------------------------------------------------------------------------------------------------------------
+    //---CHECK.8: For multiple messages or additional message during the day, open db.sqlite and CRM website to check if message logs are saved ---
+    //---------------------------------------------------------------------------------------------------------------------------------------------
+}
+
+async function createContact({ user, authHeader, phoneNumber, newContactName, newContactType }) {
+    // ----------------------------------------
+    // ---TODO.9: Implement contact creation---
+    // ----------------------------------------
+
+    const postBody = {
+        name: newContactName,
+        type: newContactType,
+        phone_numbers: [
+            {
+                name: "Work",
+                number: phoneNumber,
+                default_number: true
+            }
+        ]
+    }
+    // const contactInfoRes = await axios.post(
+    //     `https://api.crm.com/contacts`,
+    //     postBody,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     }
+    // );
+    mockContact = {
+        id: 'testContactId',
+        name: newContactName,
+        type: newContactType,
+        phone: phoneNumber,
+        additionalInfo: {
+            associatedDeal: [
+                {
+                    const: 'csA351',
+                    title: 'Christmas special A351'
+                },
+                {
+                    const: 'eA22',
+                    title: 'Easter A22'
+                },
+                {
+                    const: 'aC92',
+                    title: 'Anniversary C92'
+                }
+            ],
+            address: ''
+        }
+    }
+
+    const contactInfoRes = {
+        data: {
+            id: mockContact.id,
+            name: mockContact.name
+        }
+    }
+
+    //--------------------------------------------------------------------------------
+    //---CHECK.9: In extension, try create a new contact against an unknown number ---
+    //--------------------------------------------------------------------------------
+    return {
+        contactInfo: {
+
+
+
+
        name: rawContactInfo.name,
+        phone: rawContactInfo.phones[0],
+        organization: rawContactInfo.organization?.name ?? '',
+        additionalInfo: relatedDeals ? { deals: relatedDeals } : null
+
+    }
+}
+
+async function createContact({ user, authHeader, phoneNumber, newContactName }) {
+    const postBody = {
+        name: newContactName,
+        phone: phoneNumber
+    }
+    const createContactRes = await axios.post(
+        `https://${user.hostname}/v1/persons`,
+        postBody,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+    return {
+        contactInfo: {
+            id: createContactRes.data.data.id,
+            name: createContactRes.data.data.name
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/createMessageLog/index.html b/developers/interfaces/createMessageLog/index.html new file mode 100644 index 00000000..647dd9d4 --- /dev/null +++ b/developers/interfaces/createMessageLog/index.html @@ -0,0 +1,2251 @@ + + + + + + + + + + + + + + + + + + + + + + + + + createMessageLog - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

addMessageLog

+

This interface is responsible for creating a new messaging log record in the associated CRM. The message or messages must be associated with the contact passed in as a request parameter. Other associations may be made depending upon the CRM and the adapter. This interface is always invoked for a single SMS message.

+

Creating daily digests of an SMS conversation

+

To prevent SMS conversations with a customer from overwhelming the CRM with a multitude of log entries for each SMS message, App Connect creates a daily digest for each SMS conversation with a customer into which all SMS messages for a 24 hour period are aggregated.

+

Therefore, this interface is only invoked when the daily digest is created. The updateMessageLog interface is invoked for all subsequent SMS messages in that 24 hour period.

+

Input parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
contactInfoAn associative array describing the contact a call is associated with.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
messageAll the metadata associated with the message to be logged. SMS message schema is described in our API Reference.
additionalSubmissionAll of the additional custom fields defined in the manifest and submitted by the user.
recordingLinkIf the call was a voicemail, then this field will contain a link to the voicemail.
timezoneOffsetThe timezone offset of the current user in the event you need to use UTC when calling the CRM's API.
+

message

+
{
+  "uri" : "https://platform.ringcentral.com/restapi/xxxxxxx/message-store/60279564004",
+  "id" : 60279564004,
+  "to" : [ {
+    "phoneNumber" : "+16505553204",
+    "location" : "San Mateo, CA"
+  } ],
+  "from" : {
+    "phoneNumber" : "+18885550052"
+  },
+  "type" : "SMS",
+  "creationTime" : "2015-02-18T13:24:50.000Z",
+  "readStatus" : "Read",
+  "priority" : "Normal",
+  "attachments" : [ {
+    "id" : 60279564004,
+    "uri" : "https://media.ringcentral.com/restapi/xxxxxxxxxxxx/content/60279564004",
+    "type" : "Text",
+    "contentType" : "text/plain"
+  } ],
+  "direction" : "Outbound",
+  "availability" : "Alive",
+  "subject" : "Flight information",
+  "messageStatus" : "Sent",
+  "smsSendingAttemptsCount" : 1,
+  "conversationId" : 5578984350117917661,
+  "lastModifiedTime" : "2015-02-18T13:24:50.300Z"
+}
+
+

Return value(s)

+

An object with following properties:

+ + + + + + + + + + + + + + + + + +
ParameterDescription
logIdID of the log entry created within the CRM
returnMessagemessage, messageType and ttl
+

Example +

  return {
+    logId: "xxxx-xxx", // ID of log entity on CRM platform
+    returnMessage:{
+      message: 'Logged',
+      messageType: 'success', // 'success', 'warning' or 'danger'
+      ttl: 30000 // in miliseconds
+    }
+  }
+

+

Reference

+
+
+
+
            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+// - contactInfo: { id, type, phoneNumber, name }
+// - message : same as in https://developers.ringcentral.com/api-reference/Message-Store/readMessage
+// - recordingLink: recording link of voice mail
+// - additionalSubmission: all additional fields that are setup in manifest under call log page
+async function createMessageLog({ user, contactInfo, authHeader, message, additionalSubmission, recordingLink, faxDocLink }) {
+    // ---------------------------------------
+    // ---TODO.7: Implement message logging---
+    // ---------------------------------------
+
+    // const postBody = {
+    //     data: {
+    //         subject: `[SMS] ${message.direction} SMS - ${message.from.name ?? ''}(${message.from.phoneNumber}) to ${message.to[0].name ?? ''}(${message.to[0].phoneNumber})`,
+    //         body: `${message.direction} SMS - ${message.direction == 'Inbound' ? `from ${message.from.name ?? ''}(${message.from.phoneNumber})` : `to ${message.to[0].name ?? ''}(${message.to[0].phoneNumber})`} \n${!!message.subject ? `[Message] ${message.subject}` : ''} ${!!recordingLink ? `\n[Recording link] ${recordingLink}` : ''}\n\n--- Created via RingCentral App Connect`,
+    //         type: 'Message'
+    //     }
+    // }
+    // const addLogRes = await axios.post(
+    //     `https://api.crm.com/activity`,
+    //     postBody,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+    const messageType = !!recordingLink ? 'Voicemail' : (!!faxDocLink ? 'Fax' : 'SMS');
+    console.log(`adding message log... \n\n${JSON.stringify(message, null, 2)}`);
+    mockMessageLog = {
+        id: 'testMessageLogId'
+    }
+    const addLogRes = {
+        data: {
+            id: mockMessageLog.id
+        }
+    }
+    //-------------------------------------------------------------------------------------------------------------
+    //---CHECK.7: For single message logging, open db.sqlite and CRM website to check if message logs are saved ---
+
+
+
+
        updatedNote: putBody.note,
+        returnMessage: {
+            message: 'Call log updated.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+async function createMessageLog({ user, contactInfo, authHeader, message, additionalSubmission, recordingLink, faxDocLink }) {
+    const userInfoResponse = await axios.get(`https://${user.hostname}/v1/users/me`, {
+        headers: {
+            'Authorization': authHeader
+        }
+    });
+    const userName = userInfoResponse.data.data.name;
+    const dealId = additionalSubmission ? additionalSubmission.deals : '';
+    const orgId = contactInfo.organization ? contactInfo.organization.id : '';
+    const timeUtc = moment(message.creationTime).utcOffset(0).format('HH:mm')
+    const dateUtc = moment(message.creationTime).utcOffset(0).format('YYYY-MM-DD');
+    const activityTypesResponse = await axios.get(`https://${user.hostname}/v1/activityTypes`, { headers: { 'Authorization': authHeader } });
+    const hasSMSType = activityTypesResponse.data.data.some(t => t.name === 'SMS' && t.active_flag);
+
+    const messageType = !!recordingLink ? 'Voicemail' : (!!faxDocLink ? 'Fax' : 'SMS');
+    let subject = '';
+    let note = '';
+    switch (messageType) {
+        case 'SMS':
+            subject = `SMS conversation with ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;
+            note =
+                `<br><b>${subject}</b><br>` +
+                '<b>Conversation summary</b><br>' +
+                `${moment(message.creationTime).utcOffset(user.timezoneOffset).format('dddd, MMMM DD, YYYY')}<br>` +
+                'Participants<br>' +
+                `<ul><li><b>${userName}</b><br></li>` +
+                `<li><b>${contactInfo.name}</b></li></ul><br>` +
+                'Conversation(1 messages)<br>' +
+                'BEGIN<br>' +
+                '------------<br>' +
+                '<ul>' +
+                `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +
+                `<b>${message.subject}</b></li>` +
+                '</ul>' +
+                '------------<br>' +
+                'END<br><br>' +
+                '--- Created via RingCentral App Connect';
+            break;
+        case 'Voicemail':
+            subject = `Voicemail left by ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;
+            note = `<br><b>${subject}</b><br>Voicemail recording link: ${recordingLink} <br><br>--- Created via RingCentral App Connect`;
+            break;
+        case 'Fax':
+            subject = `Fax document sent from ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;
+            note = `<br><b>${subject}</b><br>Fax document link: ${faxDocLink} <br><br>--- Created via RingCentral App Connect`;
+            break;
+    }
+    const postBody = {
+        user_id: user.id,
+        subject,
+        person_id: contactInfo.id,
+        org_id: orgId,
+        deal_id: dealId,
+        note,
+        done: true,
+        due_date: dateUtc,
+        due_time: timeUtc,
+        type: hasSMSType ? 'SMS' : 'Call'
+    }
+    const addLogRes = await axios.post(
+        `https://${user.hostname}/v1/activities`,
+        postBody,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/findContact/index.html b/developers/interfaces/findContact/index.html new file mode 100644 index 00000000..f4b2027f --- /dev/null +++ b/developers/interfaces/findContact/index.html @@ -0,0 +1,2167 @@ + + + + + + + + + + + + + + + + + + + + + + + + + findContact - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

getContact

+

This interface is central to App Connect's framework as it is responsible for matching phone numbers with contacts in the target CRM. This interface powers the following key features:

+
    +
  • call pop
    • +
  • call logging
    • +
  • sms logging
    • +
+

This interface can return one or more contacts. If multiple contacts are returned, App Connect will prompt the end user to select the specific contact to be used when logging calls.

+

This interface is called in the following circumstances:

+
    +
  • When a call is received.
    • +
  • When a user manually clicks the "refresh contact" action for a contact or phone call.
    • +
  • When a user accesses App Connect the first time in an attempt to perform an initial contact match operation for recent phone calls.
    • +
+
+

Manually refresh contact +

+
The "Refresh contact" action in App Connect's contact list
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
phoneNumberThe phone number to search for within the target CRM, provided in an E.164 format, e.g. +11231231234.
overridingFormat(Optional) If defined by the user under advanced settings, this will contain alternative formats the user may wish to use when searching for the phoneNumber
+
+

Alternative formats

+

Some CRM's have very restrictive APIs with regards to searching for phone numbers, meaning they require an exact match in order to find a contact with that phone number. To work around this restriction, users are allowed to specify a list of phone number formats which they often use when entering phone numbers into the CRM. It is the intention that each adapter when provided a list of overridingFormat values to convert the E.164 phone number into each of the overriding formats, and to search for each one until a contact is found.

+

Remember: only a single call the getContact interface will be made. The developer is responsible for searching for each alternative format.

+
+

Return value(s)

+

This interface returns a single object. That object describes the contacts that were found. It has following properties:

+ + + + + + + + + + + + + + + + + +
ParameterDescription
matchedContactInfoAn array of objects containing id, name and optionally additionalInfo and isNewContact.
returnMessagemessage, messageType and ttl
+
+

isNewContact is only used as an extra option in contact list for users to be able to create new contacts

+
+

Example

+
{
+  matchedContactInfo:[
+    {
+      id: 'contact id',
+      name: 'John Doe',
+      additionalInfo: null,
+      isNewContact: false
+    },
+    {
+        id: 'createNewContact',
+        name: 'Create new contact...',
+        additionalInfo: null,
+        isNewContact: true
+    }
+  ],
+  returnMessage:{
+    message: 'Found 1 contact',
+    messageType: 'warning', // 'success', 'warning' or 'danger'
+    ttl: 30000 // in miliseconds
+  }
+}
+
+

Reference

+
+
+
+
async function findContact({ user, authHeader, phoneNumber, overridingFormat, isExtension }) {
+    // ----------------------------------------
+    // ---TODO.3: Implement contact matching---
+    // ----------------------------------------
+
+    console.log(`phone number: ${phoneNumber}`)
+    console.log(`is extesnion number? ${isExtension}`)
+    const numberToQueryArray = [];
+    if (isExtension) {
+        numberToQueryArray.push(phoneNumber);
+    }
+    else {
+        numberToQueryArray.push(phoneNumber.replace(' ', '+'));
+    }
+    // You can use parsePhoneNumber functions to further parse the phone number
+    const matchedContactInfo = [];
+    // for (var numberToQuery of numberToQueryArray) {
+    //     const personInfo = await axios.get(
+    //         `https://api.crm.com/contacts?query=number:${numberToQuery}`,
+    //         {
+    //             headers: { 'Authorization': authHeader }
+    //         });
+    //     if (personInfo.data.length > 0) {
+    //         for (var result of personInfo.data) {
+    //             foundContacts.push({
+    //                 id: result.id,
+    //                 name: result.name,
+    //                 type: result.type,
+    //                 phone: numberToQuery,
+    //                 additionalInfo: null
+    //             })
+    //         }
+    //     }
+    // }
+    if (mockContact != null) {
+        matchedContactInfo.push(mockContact);
+    }
+    console.log(`found contacts... \n\n${JSON.stringify(matchedContactInfo, null, 2)}`);
+
+    // If you want to support creating a new contact from the extension, below placeholder contact should be used
+    matchedContactInfo.push({
+        id: 'createNewContact',
+        name: 'Create new contact...',
+        additionalInfo: null,
+        isNewContact: true
+    });
+    //-----------------------------------------------------
+    //---CHECK.3: In console, if contact info is printed---
+    //-----------------------------------------------------
+    return {
+        matchedContactInfo,
+
+
+
+
async function findContact({ user, authHeader, phoneNumber, overridingFormat }) {
+    phoneNumber = phoneNumber.replace(' ', '+')
+    // without + is an extension, we don't want to search for that
+    if (!phoneNumber.includes('+')) {
+        return {
+            matchedContactInfo: null,
+            returnMessage: {
+                message: 'Logging against internal extension number is not supported.',
+                messageType: 'warning',
+                ttl: 3000
+            }
+        };
+    }
+    const phoneNumberObj = parsePhoneNumber(phoneNumber);
+    let phoneNumberWithoutCountryCode = phoneNumber;
+    if (phoneNumberObj.valid) {
+        phoneNumberWithoutCountryCode = phoneNumberObj.number.significant;
+    }
+    const personInfo = await axios.get(
+        `https://${user.hostname}/v1/persons/search?term=${phoneNumberWithoutCountryCode}&fields=phone`,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+    const matchedContactInfo = [];
+    for (const person of personInfo.data.data.items) {
+        const dealsResponse = await axios.get(
+            `https://${user.hostname}/v1/persons/${person.item.id}/deals?status=open`,
+            {
+                headers: { 'Authorization': authHeader }
+            });
+        const relatedDeals = dealsResponse.data.data ?
+            dealsResponse.data.data.map(d => { return { const: d.id, title: d.title } })
+            : null;
+        matchedContactInfo.push(formatContact(person.item, relatedDeals));
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/getAuthType/index.html b/developers/interfaces/getAuthType/index.html new file mode 100644 index 00000000..c875c151 --- /dev/null +++ b/developers/interfaces/getAuthType/index.html @@ -0,0 +1,1996 @@ + + + + + + + + + + + + + + + + + + + + + + + + + getAuthType - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

getAuthType

+

This method returns either oauth or apiKey.

+

Request parameters

+

None.

+

Return value(s)

+

This interface returns a single string, either oauth or apiKey to indicate what kind of auth is supported by the target CRM.

+

Reference

+
+
+
+
function getAuthType() {
+    return 'apiKey'; // Return either 'oauth' OR 'apiKey'
+}
+
+
+
+
function getAuthType() {
+    return 'oauth';
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/getCallLog/index.html b/developers/interfaces/getCallLog/index.html new file mode 100644 index 00000000..e05b1733 --- /dev/null +++ b/developers/interfaces/getCallLog/index.html @@ -0,0 +1,2099 @@ + + + + + + + + + + + + + + + + + + + + + + + + + getCallLog - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

getCallLog

+

This interface retrieves a previously logged call log record in the target CRM. This information is used to render a form to allow an end user to view or edit that record within the App Connect client.

+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userTODO
callLogIdThe ID of the activity or call log record within the CRM.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
+

Return value(s)

+

This interface should return the associated call log record in a prescribed format.

+ + + + + + + + + + + + + + + + + +
ParameterDescription
callLogInfoContain subject, note and optionally additionalSubmission
returnMessagemessage, messageType and ttl
+

Example

+
{
+  callLogInfo:{
+    subject: "A new call from John Doe",
+    note: "Delivery location changed.",
+    additionalSubmission: {
+      address: "12 Some Street, CA"
+    }
+  },
+  returnMessage:{
+    message: 'Log fetched',
+    messageType: 'success', // 'success', 'warning' or 'danger'
+    ttl: 30000 // in miliseconds
+  }
+}
+
+

Reference

+
+
+
+
            message: 'Call log added.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+async function getCallLog({ user, callLogId, authHeader }) {
+    // -----------------------------------------
+    // ---TODO.5: Implement call log fetching---
+    // -----------------------------------------
+
+    // const getLogRes = await axios.get(
+    //     `https://api.crm.com/activity/${callLogId}`,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+
+    const getLogRes = {
+        subject: mockCallLog.subject,
+        note: mockCallLog.note
+    }
+
+    //-------------------------------------------------------------------------------------
+    //---CHECK.5: In extension, for a logged call, click edit to see if info is fetched ---
+    //-------------------------------------------------------------------------------------
+    return {
+        callLogInfo: {
+            subject: getLogRes.subject,
+            note: getLogRes.note
+        },
+
+
+
+
    const putLogRes = await axios.put(
+        `https://${user.hostname}/v1/activities/${existingLogId}`,
+        putBody,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+}
+
+
+async function getCallLog({ user, callLogId, authHeader }) {
+    const getLogRes = await axios.get(
+        `https://${user.hostname}/v1/activities/${callLogId}`,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+    const logBody = getLogRes.data.data.note;
+    console.log(logBody)
+    const note = logBody.split('<li><b>Summary</b>: ')[1]?.split('<li><b>')[0] ?? '';
+    const relatedContact = getLogRes.data.related_objects?.person;
+    let contactName = 'Unknown';
+    if (!!relatedContact) {
+        const contactKeys = Object.keys(relatedContact);
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/getOauthInfo/index.html b/developers/interfaces/getOauthInfo/index.html new file mode 100644 index 00000000..000cf9a0 --- /dev/null +++ b/developers/interfaces/getOauthInfo/index.html @@ -0,0 +1,2040 @@ + + + + + + + + + + + + + + + + + + + + + + + + + getOauthInfo - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

getOauthInfo

+

This method returns a simple object containing all necessary OAuth values. This method provides developers with a safe and secure way to present to the framework values that are typically considered private, for example a client secret. These values are often stored in environment variables or in a vault.

+

Input parameters

+

None.

+

Return value(s)

+

This method should return an associative array with the following keys and values:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
KeyValue
clientIdThe client ID of the application registered with the CRM provider, used to call the CRM's API.
clientSecretThe client secret of the application registered with the CRM provider.
accessTokenUriThe API endpoint used to retrieve the access token from the CRM provider.
redirectUriThe redirect URI registered with the CRM provider.
+

Example

+
{
+  'clientId': 'xxx-xxxx-xxxxxxxxxx-xxxx',
+  'clientSecret': 'xxxxxxxx-xxxxxxxxxxxxxxxxxx',
+  'accessTokenUri': 'https://auth.crm.com/token',
+  'redirectUri': 'https://ringcentral.github.io/ringcentral-embeddable/redirect.html'
+}
+
+

Reference

+
+
+
+
// async function getOauthInfo() {
+//     return {
+//         clientId: process.env.TEST_CRM_CLIENT_ID,
+//         clientSecret: process.env.TEST_CRM_CLIENT_SECRET,
+//         accessTokenUri: process.env.TEST_CRM_TOKEN_URI,
+//         redirectUri: process.env.TEST_CRM_REDIRECT_URI
+//     }
+// }
+
+
+
+
async function getOauthInfo() {
+    return {
+        clientId: process.env.PIPEDRIVE_CLIENT_ID,
+        clientSecret: process.env.PIPEDRIVE_CLIENT_SECRET,
+        accessTokenUri: process.env.PIPEDRIVE_ACCESS_TOKEN_URI,
+        redirectUri: process.env.PIPEDRIVE_REDIRECT_URI
+    }
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/getUserInfo/index.html b/developers/interfaces/getUserInfo/index.html new file mode 100644 index 00000000..b795b929 --- /dev/null +++ b/developers/interfaces/getUserInfo/index.html @@ -0,0 +1,2043 @@ + + + + + + + + + + + + + + + + + + + + + + + + + getUserInfo - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

getUserInfo

+

This method results in the adapter calling the CRM to retrieve key information about the currently logged in user. This method should return an associative array containing the following keys and values.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyValue
idThe account ID of the user within the CRM. This not the user's personal ID, but that of the parent account.
nameThe name of the user within the CRM. This will be shown in the Chrome extension to indicate who is currentlyly logged into the CRM.
timezoneNameThe three-letter timezone identifier of the user.
timezoneOffsetThe timezone offset of the user, expressed as a positive or negative integer.
platformAdditionalInfoAn associative array of additional information about the user in the CRM. See below.
overridingHostnameSome CRMs provision unique URLs to each account within their service. For example, to access your account one would use a URL such as https://mycompanydomain.crm.com. The property tells the framework your company's unique URL if there is one.
+

platformAdditionalInfo

+ + + + + + + + + + + + + + + + + + + + + +
KeyValue
companyIdThe company or account ID of the user within the CRM.
companyNameThe name of the company or account the user is associated with in the CRM.
companyDomainThe domain of the account within the CRM.
+
+
+
+
async function getUserInfo({ authHeader, additionalInfo }) {
+    // ------------------------------------------------------
+    // ---TODO.1: Implement API call to retrieve user info---
+    // ------------------------------------------------------
+    try {
+        // API call to get logged in user info
+        // const userInfoResponse = await axios.get('https://api.crm.com/user/me', {
+        //     headers: {
+        //         'Authorization': authHeader
+        //     }
+        // });
+        const mockUserInfoResponse = {
+            data: {
+                id: 'testUserId',
+                name: 'Test User',
+                time_zone: 'America/Los_Angeles',
+                time_zone_offset: 0
+            }
+        }
+
+        const id = mockUserInfoResponse.data.id;
+        const name = mockUserInfoResponse.data.name;
+        const timezoneName = mockUserInfoResponse.data.time_zone ?? ''; // Optional. Whether or not you want to log with regards to the user's timezone
+        const timezoneOffset = mockUserInfoResponse.data.time_zone_offset ?? null; // Optional. Whether or not you want to log with regards to the user's timezone. It will need to be converted to a format that CRM platform uses,
+        return {
+            successful: true,
+            platformUserInfo: {
+                id,
+                name,
+                timezoneName,
+                timezoneOffset,
+                platformAdditionalInfo: {}  // this should save whatever extra info you want to save against the user
+            },
+            returnMessage: {
+                messageType: 'success',
+                message: 'Successfully connected to TestCRM.',
+                ttl: 3000
+            }
+        };
+    }
+    catch (e) {
+        return {
+            successful: false,
+            returnMessage: {
+                messageType: 'warning',
+                message: 'Failed to get user info.',
+                ttl: 3000
+            }
+        }
+    }
+
+
+
+
async function getUserInfo({ authHeader, hostname }) {
+    try {
+        const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {
+            headers: {
+                'Authorization': authHeader
+            }
+        });
+        const id = userInfoResponse.data.data.id.toString();
+        const name = userInfoResponse.data.data.name;
+        const timezoneName = userInfoResponse.data.data.timezone_name;
+        const timezoneOffset = userInfoResponse.data.data.timezone_offset;
+        return {
+            successful: true,
+            platformUserInfo: {
+                id,
+                name,
+                timezoneName,
+                timezoneOffset,
+                platformAdditionalInfo: {
+                    companyId: userInfoResponse.data.data.company_id,
+                    companyName: userInfoResponse.data.data.company_name,
+                    companyDomain: userInfoResponse.data.data.company_domain,
+                },
+                overridingHostname: hostname == 'temp' ? `${userInfoResponse.data.data.company_domain}.pipedrive.com` : null
+            },
+            returnMessage: {
+                messageType: 'success',
+                message: 'Successfully connected to Pipedrive.',
+                ttl: 3000
+            }
+        };
+    }
+    catch (e) {
+        return {
+            successful: false,
+            returnMessage: {
+                messageType: 'warning',
+                message: 'Failed to get user info.',
+                ttl: 3000
+            }
+        }
+    }
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/unAuthorize/index.html b/developers/interfaces/unAuthorize/index.html new file mode 100644 index 00000000..f382aa8c --- /dev/null +++ b/developers/interfaces/unAuthorize/index.html @@ -0,0 +1,2080 @@ + + + + + + + + + + + + + + + + + + + + + + + + + unAuthorize - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

unAuthorize

+

It is to remove user data from our database when user chooses to log out. Some CRMs have token invalidation mechanism, if so, please implement that as well.

+

Request parameters

+ + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
+

Return value(s)

+ + + + + + + + + + + + + +
ParameterDescription
returnMessagemessage, messageType and ttl
+

Example

+
{
+  returnMessage:{
+    message: 'Successfully unauthorized',
+    messageType: 'success', // 'success', 'warning' or 'danger'
+    ttl: 30000 // in miliseconds
+  }
+}
+
+

Reference

+
+
+
+
async function unAuthorize({ user }) {
+    // -----------------------------------------------------------------
+    // ---TODO.2: Implement token revocation if CRM platform requires---
+    // -----------------------------------------------------------------
+
+    // const revokeUrl = 'https://api.crm.com/oauth/unauthorize';
+    // const revokeBody = {
+    //     token: user.accessToken
+    // }
+    // const accessTokenRevokeRes = await axios.post(
+    //     revokeUrl,
+    //     revokeBody,
+    //     {
+    //         headers: { 'Authorization': `Basic ${getBasicAuth({ apiKey: user.accessToken })}` }
+    //     });
+    await user.destroy();
+    return {
+        returnMessage: {
+            messageType: 'success',
+            message: 'Successfully logged out from TestCRM account.',
+            ttl: 3000
+        }
+    }
+
+
+
+
async function unAuthorize({ user }) {
+    const revokeUrl = 'https://oauth.pipedrive.com/oauth/revoke';
+    const basicAuthHeader = Buffer.from(`${process.env.PIPEDRIVE_CLIENT_ID}:${process.env.PIPEDRIVE_CLIENT_SECRET}`).toString('base64');
+    const refreshTokenParams = new url.URLSearchParams({
+        token: user.refreshToken
+    });
+    const refreshTokenRevokeRes = await axios.post(
+        revokeUrl,
+        refreshTokenParams,
+        {
+            headers: { 'Authorization': `Basic ${basicAuthHeader}` }
+        });
+    const accessTokenParams = new url.URLSearchParams({
+        token: user.accessToken
+    });
+    const accessTokenRevokeRes = await axios.post(
+        revokeUrl,
+        accessTokenParams,
+        {
+            headers: { 'Authorization': `Basic ${basicAuthHeader}` }
+        });
+    await user.destroy();
+    return {
+        returnMessage: {
+            messageType: 'success',
+            message: 'Successfully logged out from Pipedrive account.',
+            ttl: 3000
+        }
+    }
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/updateCallLog/index.html b/developers/interfaces/updateCallLog/index.html new file mode 100644 index 00000000..de6f6c8b --- /dev/null +++ b/developers/interfaces/updateCallLog/index.html @@ -0,0 +1,2180 @@ + + + + + + + + + + + + + + + + + + + + + + + + + updateCallLog - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

updateCallLog

+

This interface is called when a call log activity record needs to be updated. This interface is invoked in response to the following user actions:

+
    +
  • The user of App Connect's Chrome extension updates the subject or notes associated with a call log.
    • +
  • When a recording has become available for a phone call.
    • +
+

Adding a recording to a call log entry

+

Events are triggers the moment a phone call is completed so that it can be logged properly. However, recordings take additional time to process and encode to make available to users. Therefore, for any given call you will receive an event when the call ends, and a subsequent event when a record is made available (assuming a recording of the call was made).

+

It is the developer's responsibility to update the call log record contents as they see fit to make a call recording available.

+

Input parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
userAn object describing the Chrome extension user associated with the action that triggered this interface.
existingCallLogAll the metadata associated with the call to be logged. Call Log schema is described in our API Reference.
authHeaderThe HTTP Authorization header to be transmitted with the API request to the target CRM.
recordingLinkIf the call has a recording associated with it, then this field will contain a link to the voicemail.
subjectThe subject or summary of the call activity. The value may have been changes by the user.
noteThe notes saved by the user. The value may change if the user has updated the notes they have taken.
+

Contact Info

+
{ 
+  id: "<string">,
+  type: "<string>", 
+  phoneNumber: "<E.164 Phone Number>",
+  name: "<string>"
+}
+
+

Return value(s)

+

An object with following properties:

+ + + + + + + + + + + + + + + + + +
ParameterDescription
updatedNoteupdated note on CRM
returnMessagemessage, messageType and ttl
+

Example +

  return {
+    updatedNote: "Some random notes",
+    returnMessage:{
+      message: 'Call logged',
+      messageType: 'success', // 'success', 'warning' or 'danger'
+      ttl: 30000 // in miliseconds
+    }
+  }
+

+

Reference

+
+
+
+
        logId: addLogRes.data.id,
+        returnMessage: {
+            message: 'Message log added.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+// Used to update existing message log so to group message in the same day together
+async function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {
+    // ---------------------------------------
+    // ---TODO.8: Implement message logging---
+    // ---------------------------------------
+
+    // const existingLogId = existingMessageLog.thirdPartyLogId;
+    // const getLogRes = await axios.get(
+    //     `https://api.crm.com/activity/${existingLogId}`,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+    // const originalNote = getLogRes.data.body;
+    // const updateNote = orginalNote.replace();
+
+    // const patchBody = {
+    //     data: {
+    //         body: updateNote,
+    //     }
+    // }
+    // const updateLogRes = await axios.patch(
+    //     `https://api.crm.com/activity`,
+
+
+
+
        logId: addLogRes.data.data.id,
+        returnMessage: {
+            message: 'Message log added.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+async function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {
+    const existingLogId = existingMessageLog.thirdPartyLogId;
+    const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {
+        headers: {
+            'Authorization': authHeader
+        }
+    });
+    const userName = userInfoResponse.data.data.name;
+    const getLogRes = await axios.get(
+        `https://${user.hostname}/v1/activities/${existingLogId}`,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+    let logBody = getLogRes.data.data.note;
+    let putBody = {};
+    const newMessageLog =
+        `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +
+        `<b>${message.subject}</b></li>`;
+    logBody = logBody.replace('------------<br><ul>', `------------<br><ul>${newMessageLog}`);
+
+    const regex = RegExp('<br>Conversation.(.*) messages.');
+    const matchResult = regex.exec(logBody);
+    logBody = logBody.replace(matchResult[0], `<br>Conversation(${parseInt(matchResult[1]) + 1} messages)`);
+
+    putBody = {
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/interfaces/updateMessageLog/index.html b/developers/interfaces/updateMessageLog/index.html new file mode 100644 index 00000000..f7e6b56d --- /dev/null +++ b/developers/interfaces/updateMessageLog/index.html @@ -0,0 +1,2041 @@ + + + + + + + + + + + + + + + + + + + + + + + + + updateMessageLog - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

updateMessageLog

+

This function is to add following messages on the same day to the same contact. Use case is explained here

+

Params

+

Input: +- user: user entity +- contactInfo: has id, phoneNumber, type, name +- existingMessageLog: existing message log entity +- authHeader: auth header for CRM API call +- message: message text

+

Reference

+
+
+
+
        logId: addLogRes.data.id,
+        returnMessage: {
+            message: 'Message log added.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+// Used to update existing message log so to group message in the same day together
+async function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {
+    // ---------------------------------------
+    // ---TODO.8: Implement message logging---
+    // ---------------------------------------
+
+    // const existingLogId = existingMessageLog.thirdPartyLogId;
+    // const getLogRes = await axios.get(
+    //     `https://api.crm.com/activity/${existingLogId}`,
+    //     {
+    //         headers: { 'Authorization': authHeader }
+    //     });
+    // const originalNote = getLogRes.data.body;
+    // const updateNote = orginalNote.replace();
+
+    // const patchBody = {
+    //     data: {
+    //         body: updateNote,
+    //     }
+    // }
+    // const updateLogRes = await axios.patch(
+    //     `https://api.crm.com/activity`,
+
+
+
+
        logId: addLogRes.data.data.id,
+        returnMessage: {
+            message: 'Message log added.',
+            messageType: 'success',
+            ttl: 3000
+        }
+    };
+}
+
+async function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {
+    const existingLogId = existingMessageLog.thirdPartyLogId;
+    const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {
+        headers: {
+            'Authorization': authHeader
+        }
+    });
+    const userName = userInfoResponse.data.data.name;
+    const getLogRes = await axios.get(
+        `https://${user.hostname}/v1/activities/${existingLogId}`,
+        {
+            headers: { 'Authorization': authHeader }
+        });
+    let logBody = getLogRes.data.data.note;
+    let putBody = {};
+    const newMessageLog =
+        `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +
+        `<b>${message.subject}</b></li>`;
+    logBody = logBody.replace('------------<br><ul>', `------------<br><ul>${newMessageLog}`);
+
+    const regex = RegExp('<br>Conversation.(.*) messages.');
+    const matchResult = regex.exec(logBody);
+    logBody = logBody.replace(matchResult[0], `<br>Conversation(${parseInt(matchResult[1]) + 1} messages)`);
+
+    putBody = {
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/logging-calls/index.html b/developers/logging-calls/index.html new file mode 100644 index 00000000..b9d82581 --- /dev/null +++ b/developers/logging-calls/index.html @@ -0,0 +1,2036 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Logging phone calls - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Working with call log records

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

One of the most used features across all of RingCentral's CRM integrations is the function of logging a phone call and recording a disposition associated with that phone call in the target CRM. To facilitate various user flows that relate to the logging of calls, developers need to implement three different interfaces in their server implementation.

+
    +
  • Load a call log associated with a phone call
    • +
  • Create a call log record
    • +
  • Update a call log record
    • +
+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Test

+
    +
  1. Make a call to a known contact
    2. +
  2. Click + button near a call record to log the call
    3. +
  3. Check if call log is saved on CRM platform and database (CHECK.4)
    4. +
  4. Click Edit button near the call record to update the log
    5. +
  5. Check if call log's subject and note are pulled correctly (CHECK.5)
    6. +
  6. Edit subject and note, then click Update
    7. +
  7. Check if call log is updated on CRM platform (CHECK.6)
    8. +
+

Log page setup

+

Please go to manifest.

+

Internal call logging

+

To enable internal call logging for extension numbers under your main number, please add enableExtensionNumberLoggingSetting under your manifest platform info. Users would need to turn on Allow extension number logging under Contacts settings. Then on server end, isExtension flag will be passed in as in src/adapters/testCRM/index.js - findContact().

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/logging-sms/index.html b/developers/logging-sms/index.html new file mode 100644 index 00000000..0052863e --- /dev/null +++ b/developers/logging-sms/index.html @@ -0,0 +1,2051 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Logging SMS - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Logging an SMS message or conversation

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

App Connect allows users to log in their CRM all forms of communication with a customer, which includes SMS or text messages. This interface describes how to log an SMS conversation within the target CRM.

+

Important note

+

Message logging is slightly different from call logging. Message logs could become pretty messy. This framework applies an idea to group messages together, and here is how:

+

Message logs are grouped per conversation per day, meaning there will be just one CRM activity for all messages that happen under the same conversation on the same day.

+

Therefore, the first message during the day will be logged using createMessageLog to create a new CRM activity, while the following messages are added to the existing activity using updateMessageLog. And the framework already takes care of separating the 1st message and the rest.

+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Test

+
    +
  1. Send a SMS message to a known contact
    2. +
  2. Click + button near a conversation record to log all unlogged messages under this conversation
    3. +
  3. Check if message log is saved on CRM platform and database (CHECK.7)
    4. +
  4. Send another SMS message to the same contact
    5. +
  5. Click + button near a conversation record to log all unlogged messages under this conversation
    6. +
  6. Check if message log is added to previously created log on CRM platform and as a new record in database (CHECK.8)
    7. +
+

Tips

+

The framework checks database to see if there's existing message log on the day. If you want to setup a scenario to test 1st message, you could delete all message log records in database.

+

Log page setup

+

Please go to manifest.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/manifest-pages/index.html b/developers/manifest-pages/index.html new file mode 100644 index 00000000..0afd60a6 --- /dev/null +++ b/developers/manifest-pages/index.html @@ -0,0 +1,2299 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Customizing pages - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Customizing pages

+ +

Customizing the welcome message

+

When a user installs App Connect for the first time and accesses it from their CRM, a welcome page or splash screen appears to the user. This screen can be very effective in educating the end user about how to setup and connect to the associated CRM.

+

Currently welcome pages are relatively simple, providing developers with the ability to direct users to two key resources under embeddedOnCrmPage.welcomePage:

+
    +
  • docLink: A URL to read documentation
    • +
  • videoLink: A URL to watch a video
    • +
+

Customizing pages within the client application

+

There are a number of pages within the App Connect client application that often need to be customized in some way for the corresponding CRM. Those pages are:

+
    +
  • CRM authentication page (ONLY for apiKey auth)
    • +
  • Call logging form
    • +
  • Message logging form
    • +
+

Adding custom fields to logging forms

+

CRMs almost always have a set of fields associated with logging an activity that are relatively unique. Consider for example Clio, a CRM used by legal professionals, in which users link calls to "matters" (e.g. a "legal matter"). Where CRMs like Insightly link calls to opportunities. To account for this, the framework makes it easy to add new custom form fields to two key forms users interact with frequently:

+
    +
  • Call logging page
    • +
  • Create contact page
    • +
+

For each page, you will define an array of additionalFields. Each additional field element consists of the properties below.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
conststringA unique key identifying the field.
titlestringThe display name of the field.
typestringThe data type associated with the field.
contactDependentbooleanSet to true if this field would change when the selected contact is changed, or false if the value is static.
+

Custom call log fields

+

In the following example, a "Deals" pull-down menu with three options, and an "Address" text input is added to the call log form.

+
                {
+                    "id": "testCallLogDetails",
+                    "type": "section",
+                    "name": "Call log details",
+                    "items": [
+                        {
+                            "id": "addCallLogNote",
+                            "type": "boolean",
+                            "name": "Add note to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogSubject",
+                            "type": "boolean",
+                            "name": "Add subject to call log",
+                            "defaultValue": true
+
+

Custom SMS log fields

+

Setup the same fields as above, but associated with the SMS logging page.

+
                        },
+                        {
+                            "id": "addCallLogContactNumber",
+                            "type": "boolean",
+                            "name": "Add contact phone number to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDateTime",
+                            "type": "boolean",
+                            "name": "Add date and time to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDuration",
+                            "type": "boolean",
+
+

Feedback page

+

A feedback page allows you to facilitate the collection of feedback from users. When defined a feedback link will appear in App Connect for users to click. When clicked, a form will be displayed to the user prompting them for feedback. The structure and input elements of the form are configurable.

+

To use feedback page, please create feedback object under page. The feedback object has the following properties:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
urlstringA URL that the feedback form will post data to. Query parameters can be setup. Please refer to below
elementsarrayPage and input elements that will comprise the feedback form. Please refer to below
+

Page elements and query parameters

+

Page elements are defined as similar to log page fields above:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
conststringA unique key identifying the field.
titlestringThe display name of the field.
typestringThe input type associated with the field. string, inputField and selection
boldboolean(Only applicable for string)
selectionsarrayEach element has only const and title
requiredbooleanIf true, the form cannot be submitted until a value has been entered.
placeholderstringA placeholder value to be replaced by the user. Only applicable for inputField.
+

Submitting feedback forms

+

When a user submits the feedback form, the feedback will be submitted to the designated url. The URL supports a number of tokens so that you can encode user submitted form data into the URL being posted to. These tokens are as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameIs nativeDescription
crmNametrueYour crm platform name
userNametrueRingCentral user name
userEmailtrueRingCentral user email
Element const valuefalseAny custom field that you define in your feedback page
+
+

Posting to a Google Form

+

Posting feedback to a Google Form such that the user's input is pre-filled on the resulting Google Form page requires you to encode the Google Form URL with custom values. This is achieved through the use of tokens. For example, consider the need to construct the following URL:

+
https://docs.google.com/forms/d/e/:FORM_ID/viewform?
+   usp=pp_url&entry.912199227={score}&entry.912199228={crmName}
+
+

Prior to the form being posted to the URL, the {score} and {crmName} tokens will be replaced with their corresponding values, using user-provided data when present.

+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/manifest-sample/index.html b/developers/manifest-sample/index.html new file mode 100644 index 00000000..07dfff37 --- /dev/null +++ b/developers/manifest-sample/index.html @@ -0,0 +1,2041 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Sample manifest - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Sample manifest file

+

Here is a sample manifest file that illustrates the full syntax and structure of the manifest file.

+
{
+    "serverUrl": "https://xxxx.ngrok.app",
+    "redirectUri": "https://ringcentral.github.io/ringcentral-embeddable/redirect.html",
+    "author": {
+        "name": "Test Developer",
+        "websiteUrl": ""
+    },
+    "platforms": {
+        "testCRM": {
+            "logoUrl": "https://avatars.githubusercontent.com/u/6549285?s=200&v=4",
+            "documentationUrl": "https://ringcentral.github.io/rc-unified-crm-extension",
+            "releaseNotesUrl": "https://ringcentral.github.io/rc-unified-crm-extension/release-notes/",
+            "getSupportUrl": "https://community.ringcentral.com/topic/new?fid=22",
+            "writeReviewUrl": "https://chromewebstore.google.com/detail/ringcentral-crm-extension/kkhkjhafgdlihndcbnebljipgkandkhh/reviews",
+            "urlIdentifier": "*.labs.ringcentral.com/*",
+            "name": "testCRM",
+            "displayName": "Test CRM",
+            "enableExtensionNumberLoggingSetting": true,
+            "requestConfig": {
+                "timeout": 30
+            },
+            "auth": {
+                "type": "apiKey",
+                "apiKey": {
+                    "page": {
+                        "title": "test CRM",
+                        "content": [
+                            {
+                                "const": "apiKey",
+                                "title": "apiKey",
+                                "type": "string",
+                                "required": true
+                            }
+                        ]
+                    }
+                },
+                "oauth": {
+                    "authUrl": "",
+                    "clientId": "",
+                    "redirectUri": "https://ringcentral.github.io/ringcentral-embeddable/redirect.html",
+                    "customState": "",
+                    "scope": ""
+                }
+            },
+            "canOpenLogPage": false,
+            "contactTypes": [
+                {
+                    "display": "TestContactType",
+                    "value": "testContact"
+                },
+                {
+                    "display": "Contact",
+                    "value": "cta"
+                }
+            ],
+            "embeddedOnCrmPage": {
+                "welcomePage": {
+                    "docLink": "https://ringcentral.github.io/rc-unified-crm-extension/",
+                    "videoLink": "https://youtu.be/pQgdsAR1UCI"
+                }
+            },
+            "settings": [
+                {
+                    "id": "testCallLogDetails",
+                    "type": "section",
+                    "name": "Call log details",
+                    "items": [
+                        {
+                            "id": "addCallLogNote",
+                            "type": "boolean",
+                            "name": "Add note to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogSubject",
+                            "type": "boolean",
+                            "name": "Add subject to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogContactNumber",
+                            "type": "boolean",
+                            "name": "Add contact phone number to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDateTime",
+                            "type": "boolean",
+                            "name": "Add date and time to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDuration",
+                            "type": "boolean",
+                            "name": "Add duration to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogResult",
+                            "type": "boolean",
+                            "name": "Add call result to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogRecording",
+                            "type": "boolean",
+                            "name": "Add recording link to call log",
+                            "defaultValue": true
+                        }
+                    ]
+                }
+            ],
+            "page": {
+                "callLog": {
+                    "additionalFields": [
+                        {
+                            "const": "associatedDeal",
+                            "title": "Deals",
+                            "type": "selection",
+                            "contactDependent": true
+                        },
+                        {
+                            "const": "address",
+                            "title": "Address",
+                            "type": "inputField",
+                            "contactDependent": false
+                        }
+                    ]
+                },
+                "messageLog": {
+                    "additionalFields": [
+                        {
+                            "const": "associatedDeal",
+                            "title": "Deals",
+                            "type": "selection",
+                            "contactDependent": true
+                        },
+                        {
+                            "const": "address",
+                            "title": "Address",
+                            "type": "inputField",
+                            "contactDependent": false
+                        }
+                    ]
+                }
+            },
+            "rcAdditionalSubmission": [
+                {
+                    "id": "departmentName",
+                    "path": "cachedData.extensionInfo.contact.department"
+                }
+            ]
+        }
+    },
+    "version": "1.3.3"
+}
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/manifest/index.html b/developers/manifest/index.html new file mode 100644 index 00000000..b1d6c364 --- /dev/null +++ b/developers/manifest/index.html @@ -0,0 +1,2615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Manifest properties - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Configuring your adapter's manifest

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

An adapter's manifest file helps a developer to instruct the framework on how to interface with your adapter. It enables developers to customize the user interface within certain boundaries, enables authentication and connectivity with the target CRM and more.

+

Below you will find an explanation of the many properties found within a manifest file.

+

Turn on developer mode

+

To use a custom manifest, we'll need to turn on developer mode and assign a custom manifest url to the extension. Here's how:

+
    +
  1. Open DevTools
    2. +
  2. In console, execute window.postMessage({type: 'toggle-developer-mode', toggle: true}) and reload the extension
    3. +
  3. In user settings, there's a section for Developer settings. Input your custom manifest url and save
    4. +
  4. Reload the extension to make it work
    5. +
+

Basic properties

+

These basic properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
authorstringThe author of the adapter. This is displayed to end users within the Chrome extension.
platformsARRAY of objectAn array of platforms being integrated with. Each element of this array defines a different CRM.
serverUrlstringThe base URL the Chrome extension will used when composing requests to your adapter. The URL should utilize HTTPS and should omit the trailing slash (/). For example: https://my-adapter.myserver.com
versionstringThe version of your adapter. This is displayed to end users within the Chrome extension.
+

Platform configuration

+

Each manifest file contains an array of platform objects. This is helpful for developers who manage multiple CRM adapters from the same server.

+

The platforms property is an associative array. Each key should be a unique identifier for the crm. The value of each element is an object with the following properties.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
namestringThe name of the CRM.
displayNamestringThe display name of the CRM.
urlIdentifierstringThe URL for which this CRM will be enabled. When the CRM is enabled for a domain, the extension's orange quick access button will appear. (* for wildcard match is supported)
authobjectContains all info for authorization. Details
canOpenLogPagebooleanSet to true if the corresponding CRM supports permalinks for a given activity/log. When set to true users will have the option view/open the activity log in the CRM from the call history page. When set to false, users will open the contact page instead.
contactTypesARRAY of object(Optional) CRMs often adopt unique vernaculars to describe contacts. Provide the enumerated list of contact types supported by the corresponding CRM. Each object has display and value.
contactPageUrlstringA format string to open a CRM's contact page, e.g.https://{hostname}/person/{contactId}. Supported parameters: {hostname}, {contactId}, {contactType}
embeddedOnCrmPageobjectThe rendering config for embedded page, explained here
logPageUrlstringA format string to open CRM log page. Eg.https://{hostname}/activity/{logId}. Supported parameters: {hostname}, {logId}, {contactType}
pageobjectThe rendering config for all pages, explained here
requestConfigobjectContains http request config for client extension, including timeout (number in seconds)
+

The client-side authorization url that is opened by the extension will be: {authUrl}?responseType=code&client_id={clientId}&{scope}&state=platform={name}&redirect_uri=https://ringcentral.github.io/ringcentral-embeddable/redirect.html

+

Authorization

+

platform has auth object which has following parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
typestringThe authorization mode utilized by the target CRM. Only two values are supported: oauth and apiKey. Setting up auth is covered in more detail in the Authorization section.
oauthobjectOnly used with type equal to oauth. It contains authUrl, clientId and redirectUri.
apiKeyobjectOnly used with type equal to apiKey. It contains page
+

oauth parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
authUrlstringOnly used with authType equal to oauth. The auth URL to initiate the OAuth process with the CRM.
clientIdstringOnly used with authType equal to oauth. The client ID of the application registered with the CRM to access it's API.
redirectUristringThe Redirect URI used when logging into RingCentral (not the CRM). It's recommended to use the default value of https://ringcentral.github.io/ringcentral-embeddable/redirect.html.
customStatestring(Optional) Only if you want to override state query string in OAuth url. The state query string will be state={customState} instead.
scopestring(Optional) Only if you want to specify scopes in OAuth url. eg. "scope":"scopes=write,read"
+

Customizing pages within the client application

+

There are a number of pages within the App Connect client application that often need to be customized in some way for the corresponding CRM. Those pages are:

+
    +
  • CRM authentication page (ONLY for apiKey auth)
    • +
  • Call logging form
    • +
  • Message logging form
    • +
+

apiKey auth page

+
+
+
+
            "auth": {
+                "type": "apiKey",
+                "apiKey": {
+                    "page": {
+                        "title": "test CRM",
+                        "content": [
+                            {
+                                "const": "apiKey",
+                                "title": "apiKey",
+                                "type": "string",
+                                "required": true
+                            }
+                        ]
+                    }
+                },
+
+

Auth page

+
+
+
                                    "title": "5"
+                                },
+                                {
+                                    "const": "6",
+                                    "title": "6"
+                                },
+                                {
+                                    "const": "7",
+                                    "title": "7"
+                                },
+                                {
+                                    "const": "8",
+                                    "title": "8"
+                                },
+                                {
+                                    "const": "9",
+                                    "title": "9"
+                                },
+                                {
+                                    "const": "10",
+                                    "title": "10"
+                                }
+                            ],
+                            "required": true
+                        },
+                        {
+                            "const": "feedback",
+                            "title": "Feedback",
+                            "type": "inputField",
+                            "placeholder": "Please share your feedback...",
+                            "required": true
+                        }
+
+

Auth page

+
+
+
+

Adding custom fields to logging forms

+

CRMs almost always have a set of fields associated with logging an activity that are relatively unique. Consider for example Clio, a CRM used by legal professionals, in which users link calls to "matters" (e.g. a "legal matter"). Where CRMs like Insightly link calls to opportunities. To account for this, the framework makes it easy to add new custom form fields to two key forms users interact with frequently:

+
    +
  • Call logging page
    • +
  • Create contact page
    • +
+

For each page, you will define an array of additionalFields. Each additional field element consists of the properties below.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
conststringA unique key identifying the field.
titlestringThe display name of the field.
typestringThe data type associated with the field.
contactDependentbooleanSet to true if this field would change when the selected contact is changed, or false if the value is static.
+

Custom call log fields

+

Set up associated deals as dropdown options:

+
    +
  1. Christmas special A351
    2. +
  2. Easter A22
    3. +
  3. Anniversary C92
    4. +
+

And then setup "Address" as free input field.

+
            "settings": [
+                {
+                    "id": "testCallLogDetails",
+                    "type": "section",
+                    "name": "Call log details",
+                    "items": [
+                        {
+                            "id": "addCallLogNote",
+                            "type": "boolean",
+                            "name": "Add note to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogSubject",
+                            "type": "boolean",
+                            "name": "Add subject to call log",
+                            "defaultValue": true
+
+

Custom SMS log fields

+

Set up associated deals the same as call log

+
                        },
+                        {
+                            "id": "addCallLogContactNumber",
+                            "type": "boolean",
+                            "name": "Add contact phone number to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDateTime",
+                            "type": "boolean",
+                            "name": "Add date and time to call log",
+                            "defaultValue": true
+                        },
+                        {
+                            "id": "addCallLogDuration",
+                            "type": "boolean",
+
+

Customizing the welcome message

+

When a user installs App Connect for the first time and accesses it from their CRM, a welcome page or splash screen appears to the user. This screen can be very effective in educating the end user about how to setup and connect to the associated CRM.

+

Currently welcome pages are relatively simple, providing developers with the ability to direct users to two key resources under embeddedOnCrmPage.welcomePage:

+
    +
  • docLink: A URL to read documentation
    • +
  • videoLink: A URL to watch a video
    • +
+

User settings for default log form values

+

This topic is closely related to the use of auto log. For manual log cases, using Bullhorn as example, users would need to manually select one of the Note action codes. In auto log scenarios, the extension would refuse to auto log because it misses selection for Note action code value. Now, default log form values would be able to help. It has 4 cases: inbound call, outbound call, message and voicemail where we can predefine default values.

+

Here's the example from Bullhorn. In settings, we want to add a new custom setting, and on log page render, we want to link the default values from user settings.

+

Bullhorn default Note Action page

+
{
+    "settings": 
+        [
+            {
+                "id": "bullhornDefaultNoteAction",
+                "type": "section",
+                "name": "Bullhorn options",
+                "items": [
+                    {
+                        "id": "noteActionMatchWarning",
+                        "name": "Info: note action matching warning",
+                        "type": "warning",
+                        "value": "Note action value match ignores cases and spaces"
+                    },
+                    {
+                        "id": "bullhornInboundCallNoteAction",
+                        "type": "inputField",
+                        "name": "Default action for inbound calls",
+                        "placeholder": "Enter action value"
+                    },
+                    {
+                        "id": "bullhornOutboundCallNoteAction",
+                        "type": "inputField",
+                        "name": "Default action for outbound calls",
+                        "placeholder": "Enter action value"
+                    },
+                    {
+                        "id": "bullhornMessageNoteAction",
+                        "type": "inputField",
+                        "name": "Default action for SMS",
+                        "placeholder": "Enter action value"
+                    },
+                    {
+                        "id": "bullhornVoicemailNoteAction",
+                        "type": "inputField",
+                        "name": "Default action for voicemails",
+                        "placeholder": "Enter action value"
+                    }
+                ]
+            }
+        ]
+}
+
+

Page fields need to be set to use default values mapped from user settings.

+
{
+    "page": {
+        "callLog": {
+            "additionalFields": [
+                {
+                    "const": "noteActions",
+                    "title": "Note action",
+                    "type": "selection",
+                    "contactDependent": false,
+                    "defaultSettingId": "bullhornDefaultNoteAction",
+                    "defaultSettingValues": {
+                        "inboundCall": {
+                            "settingId": "bullhornInboundCallNoteAction"
+                        },
+                        "outboundCall": {
+                            "settingId": "bullhornOutboundCallNoteAction"
+                        }
+                    }
+                }
+            ]
+        },
+        "messageLog": {
+            "additionalFields": [
+                {
+                    "const": "noteActions",
+                    "title": "Note action",
+                    "type": "selection",
+                    "contactDependent": false,
+                    "defaultSettingId": "bullhornDefaultNoteAction",
+                    "defaultSettingValues": {
+                        "message": {
+                            "settingId": "bullhornMessageNoteAction"
+                        },
+                        "voicemail": {
+                            "settingId": "bullhornVoicemailNoteAction"
+                        }
+                    }
+                }
+            ]
+        }
+    }
+}
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/placeholder-contacts/index.html b/developers/placeholder-contacts/index.html new file mode 100644 index 00000000..754068d8 --- /dev/null +++ b/developers/placeholder-contacts/index.html @@ -0,0 +1,1976 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Placeholder contacts - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Creating a placeholder contact

+
+

The developer framework is currently in BETA

+

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

+
+

In the event that no contact could be found with an associated phone number, then the client application will prompt a user to create a placeholder contact.

+

In the framework's logic, contact creation is coupled with call/message logging. It'll only be used in one case: logging a call/message against an unknown contact. Therefore, it can be described as:

+

logging against an unknown contact = create a placeholder contact + logging against it

+

Implement server endpoints

+

Within your adapter's index.js file, implement the following methods.

+ +

Test

+
    +
  1. Make a call to an uknown contact
    2. +
  2. Click + button near a call record to log the call
    3. +
  3. Check if the contact is created on CRM platform (CHECK.9)
    4. +
  4. Check if call log is saved on CRM platform and database (CHECK.9)
    5. +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/proprietary-crm/index.html b/developers/proprietary-crm/index.html new file mode 100644 index 00000000..c5a06242 --- /dev/null +++ b/developers/proprietary-crm/index.html @@ -0,0 +1,1975 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Proprietary CRMs - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Integrating with a proprietary CRM

+

The App Connect framework from RingCentral can be used to build an integration with any CRM, even a home-grown or proprietary one. If you are seeking to build an adapter for a home-grown CRM, here is a check list to see if what you have built is compatible with this framework.

+

Compatibility checklist for proprietary CRMs

+

OAuth 2.0 support

+

Ideally, your proprietary CRM supports the OAuth 2.0 authorization protocol. From the perspective of building the adapter, this will by far be the easiest most turn-key way to connect the App Connect client application to your CRM.

+

Technically, the framework can be made to work with alternative authentication mechanisms, like API keys and other tokenized methods. However, there is no guarantee such mechanisms will work out of the box.

+

A similar API is needed to log a user out. This API would effectively invalidate an access key so that it cannot be used again.

+

API to create a call log, note or activity record

+

Every CRM has its own unique vernacular, but at the end of the day the core function of an adapter is to facilitate the process of recording communications in the CRM in question. To do that, the CRM needs an API that allows the adapter to store in the CRM's database a record of a phone call or SMS message.

+

A similar API will be needed for fetching, and editing/updating call logs as well.

+

API to lookup associations with a phone number

+

To execute a call pop, which describes the process of opening a web page or fetching information about the person or contact one is calling or receiving a call from, the CRM needs an API that can receive as input a phone number, and return information about the person corresponding to that phone number.

+

Ideally, that API will take as input a phone number in E.164 format but search the CRM for phone numbers stored in any other format. The stricter the search syntax is for phone numbers, the less reliably contacts/associations will be found when a search is conducted.

+

API to create a contact

+

When a call is received for which no association or contact exists, users are given the opportunity to create a contact record to associate the activity record with. To facilitate this user flow, an API must exist that allows a contact to be created and associated with a given phone number.

+

API to fetch the name of the currently logged in user

+

Finally, in order to show users that they have connected to the CRM successfully, an API needs to exist that returns the current user's name, and validates that the access key or API key used to authenticate with the CRM is valid.

+

Server recommendations

+

Technically, an adapter's server could be implemented in any language. However, the fastest and easiest way to implement an adapter's server is using our pre-made Javascript adapter server framework.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/view-details/index.html b/developers/view-details/index.html new file mode 100644 index 00000000..e2ec1f40 --- /dev/null +++ b/developers/view-details/index.html @@ -0,0 +1,1912 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Viewing contacts and activities - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

View contact and log details

+

For a matched contact or a logged call, the extension supports to open the corresponding page on CRM.

+

view contact or log details

+

To configure this feature, there are several fields to setup in manifest.json.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
canOpenLogPagebooleanSet to true if the corresponding CRM supports permalinks for a given activity/log. When set to true users will have the option view/open the activity log in the CRM from the call history page. When set to false, users will open the contact page instead.
contactPageUrlstringA format string to open CRM contact page. Eg.https://{hostname}/person/{contactId}. Supported parameters: {hostname}, {contactId}, {contactType}
logPageUrlstringA format string to open CRM log page. Eg.https://{hostname}/activity/{logId}. Supported parameters: {hostname}, {logId}, {contactType}
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/developers/welcome-page/index.html b/developers/welcome-page/index.html new file mode 100644 index 00000000..15e61418 --- /dev/null +++ b/developers/welcome-page/index.html @@ -0,0 +1,1890 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Welcome pages - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Customized welcome page

+

When user opens CRM page for the first time after installing the extension, it'll show welcome page in a modal dialog.

+

welcome page

+

Configure this feature under manifest.json, under embeddedOnCrmPage and then welcomePage, there are:

+
    +
  • docLink: A URL to read documentation
    • +
  • videoLink: A URL to watch a video
    • +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/extra.css b/extra.css new file mode 100644 index 00000000..aa5159eb --- /dev/null +++ b/extra.css @@ -0,0 +1,58 @@ +.float-left { float: left; } +.float-right { float: right; } +.md-typeset img.mw-100 { + max-width: 100px; +} +.md-typeset img.mw-200 { + max-width: 200px; +} +.md-typeset img.mw-250 { + max-width: 250px; +} +.md-typeset img.mw-300 { + max-width: 300px; +} +.md-typeset img.mw-400 { + max-width: 400px; +} +.md-typeset img.mw-500 { + max-width: 500px; +} +.md-typeset img.mw-600 { + max-width: 600px; +} +#oauth-parameters + .md-typeset__scrollwrap table th:first-of-type, +#platform-configuration + p + p + .md-typeset__scrollwrap table th:first-of-type, +#getuserinfo + p + .md-typeset__scrollwrap table th:first-of-type, +#return-values + .md-typeset__scrollwrap table th:first-of-type, +#return-values + p + .md-typeset__scrollwrap table th:first-of-type, +#request-parameters + .md-typeset__scrollwrap table th:first-of-type, +#input-parameters + .md-typeset__scrollwrap table th:first-of-type { + width: 250px; +} +.crm-logo { + max-width: 200px; + max-height: 100px; + display: block; + margin-bottom: 15px; +} +.md-typeset a { + color: #066fac +} +.md-typeset a:hover { + color: #066fac; + text-decoration: underline; +} +.download-button { + color: #CCC !important; + border-radius: 10px !important; +} +.md-main { + padding-bottom: 50px +} +#powered-by-embeddable .admonition { + font-size: 0.8rem; +} +:root { + --md-primary-fg-color: #002755; +} diff --git a/getting-started/index.html b/getting-started/index.html new file mode 100644 index 00000000..ec7e31fe --- /dev/null +++ b/getting-started/index.html @@ -0,0 +1,2059 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Installation - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + + + + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Setup and installation

+

RingCentral's App Connect is a browser extension for Google Chrome and Microsoft Edge that is available via the Chrome web store. Installation is quick and easy if you are accustom to installing browser extensions. Click the web store button below to get started.

+
+

Google Chrome Web store +

+
Install the extension now
+
+

Installing the browser plugin

+

Google Chrome

+

App Connect was initially architected for Google Chrome, and is therefore installed easily from the Google Chrome web store. Click the "Add to Chrome" button to install the extension instantly. Then, consult the instructions specific to your CRM.

+

Web Store Install

+

Microsoft Edge

+

Microsoft Edge supports most Chrome extensions. To install them, however, you will need to make configuration changes to Edge. In summary:

+
    +
  1. +

    In Microsoft Edge, navigate to the Manage extensions.

    +

    Extensions menu

    +
    2. +
  2. +

    Select "Allow extensions from other stores" in the banner at the top of the page, then select "Allow" to confirm.

    +

    Allow extensions from other stores

    +
    3. +
  3. +

    Navigate to the App Connect extension in the Chrome web store and select "Add to Chrome."

    +
    4. +
  4. +

    Follow any additional prompts to complete the installation process.

    +
    5. +
+

Connecting to your CRM

+

The process of connecting App Connect to your CRM is more or less the same at a high-level.

+
    +
  1. First, navigate to and login to your CRM.
    2. +
  2. +

    While viewing a page in your CRM, open up the extension by clicking the App Connect badge.

    +

    App Connect badge

    +
    3. +
  3. +

    Open the "More" tab and select "Settings."

    +
    4. +
  4. Scroll down to find your CRM, and click the "Connect" button.
    5. +
  5. Follow the on-screen instructions for your CRM.
    6. +
+

Each CRM may have a slightly different approach in order to install the extension fully. Consult the CRM-specific documentation to setup and configure your CRM below.

+ + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/img/CRMLogos/Bullhorn_Logo.png b/img/CRMLogos/Bullhorn_Logo.png new file mode 100644 index 00000000..ecadac2d Binary files /dev/null and b/img/CRMLogos/Bullhorn_Logo.png differ diff --git a/img/CRMLogos/Clio_Logo.png b/img/CRMLogos/Clio_Logo.png new file mode 100644 index 00000000..dc29d6fa Binary files /dev/null and b/img/CRMLogos/Clio_Logo.png differ diff --git a/img/CRMLogos/Insightly_logo.png b/img/CRMLogos/Insightly_logo.png new file mode 100644 index 00000000..0e5fe2e0 Binary files /dev/null and b/img/CRMLogos/Insightly_logo.png differ diff --git a/img/CRMLogos/Netsuite_Logo.png b/img/CRMLogos/Netsuite_Logo.png new file mode 100644 index 00000000..cd863ffc Binary files /dev/null and b/img/CRMLogos/Netsuite_Logo.png differ diff --git a/img/CRMLogos/Pipedrive_logo.png b/img/CRMLogos/Pipedrive_logo.png new file mode 100644 index 00000000..1c5482a7 Binary files /dev/null and b/img/CRMLogos/Pipedrive_logo.png differ diff --git a/img/CRMLogos/Redtail_Logo.png b/img/CRMLogos/Redtail_Logo.png new file mode 100644 index 00000000..f2442fcc Binary files /dev/null and b/img/CRMLogos/Redtail_Logo.png differ diff --git a/img/RingCentral_logo_color.png b/img/RingCentral_logo_color.png new file mode 100644 index 00000000..6bdfccdd Binary files /dev/null and b/img/RingCentral_logo_color.png differ diff --git a/img/adapter-arch.png b/img/adapter-arch.png new file mode 100644 index 00000000..c1fd2338 Binary files /dev/null and b/img/adapter-arch.png differ diff --git a/img/admin-bullhorn.png b/img/admin-bullhorn.png new file mode 100644 index 00000000..67468095 Binary files /dev/null and b/img/admin-bullhorn.png differ diff --git a/img/admin-logging.png b/img/admin-logging.png new file mode 100644 index 00000000..438014f6 Binary files /dev/null and b/img/admin-logging.png differ diff --git a/img/admin-tab.png b/img/admin-tab.png new file mode 100644 index 00000000..262ba9ee Binary files /dev/null and b/img/admin-tab.png differ diff --git a/img/admin-user-view.png b/img/admin-user-view.png new file mode 100644 index 00000000..5e0de447 Binary files /dev/null and b/img/admin-user-view.png differ diff --git a/img/adv-settings-formats.png b/img/adv-settings-formats.png new file mode 100644 index 00000000..e665be32 Binary files /dev/null and b/img/adv-settings-formats.png differ diff --git a/img/architecture.png b/img/architecture.png new file mode 100644 index 00000000..794263d7 Binary files /dev/null and b/img/architecture.png differ diff --git a/img/auto-log-unresolved-conflicts.png b/img/auto-log-unresolved-conflicts.png new file mode 100644 index 00000000..5d3b55fb Binary files /dev/null and b/img/auto-log-unresolved-conflicts.png differ diff --git a/img/badge.png b/img/badge.png new file mode 100644 index 00000000..475d2241 Binary files /dev/null and b/img/badge.png differ diff --git a/img/bullhorn-comment-action-list.png b/img/bullhorn-comment-action-list.png new file mode 100644 index 00000000..050a55f6 Binary files /dev/null and b/img/bullhorn-comment-action-list.png differ diff --git a/img/bullhorn-connect.png b/img/bullhorn-connect.png new file mode 100644 index 00000000..f8930c51 Binary files /dev/null and b/img/bullhorn-connect.png differ diff --git a/img/bullhorn-default-note-action-entry.png b/img/bullhorn-default-note-action-entry.png new file mode 100644 index 00000000..a931fee1 Binary files /dev/null and b/img/bullhorn-default-note-action-entry.png differ diff --git a/img/bullhorn-default-note-action-page.png b/img/bullhorn-default-note-action-page.png new file mode 100644 index 00000000..bc45f5a0 Binary files /dev/null and b/img/bullhorn-default-note-action-page.png differ diff --git a/img/bullhorn-logo.png b/img/bullhorn-logo.png new file mode 100644 index 00000000..b248a290 Binary files /dev/null and b/img/bullhorn-logo.png differ diff --git a/img/call-pop.png b/img/call-pop.png new file mode 100644 index 00000000..bba52a09 Binary files /dev/null and b/img/call-pop.png differ diff --git a/img/chrome-extension-menu.png b/img/chrome-extension-menu.png new file mode 100644 index 00000000..b867265a Binary files /dev/null and b/img/chrome-extension-menu.png differ diff --git a/img/chrome-extensions-menu.png b/img/chrome-extensions-menu.png new file mode 100644 index 00000000..017b7ca1 Binary files /dev/null and b/img/chrome-extensions-menu.png differ diff --git a/img/chrome-location-bar.png b/img/chrome-location-bar.png new file mode 100644 index 00000000..627b2b13 Binary files /dev/null and b/img/chrome-location-bar.png differ diff --git a/img/chrome-pinning-ext.png b/img/chrome-pinning-ext.png new file mode 100644 index 00000000..f0e44720 Binary files /dev/null and b/img/chrome-pinning-ext.png differ diff --git a/img/chrome-web-store.png b/img/chrome-web-store.png new file mode 100644 index 00000000..decfc0c7 Binary files /dev/null and b/img/chrome-web-store.png differ diff --git a/img/click-to-dial.png b/img/click-to-dial.png new file mode 100644 index 00000000..6ed1a1e7 Binary files /dev/null and b/img/click-to-dial.png differ diff --git a/img/clio-connect.png b/img/clio-connect.png new file mode 100644 index 00000000..71650737 Binary files /dev/null and b/img/clio-connect.png differ diff --git a/img/clio-logo.png b/img/clio-logo.png new file mode 100644 index 00000000..17dd8903 Binary files /dev/null and b/img/clio-logo.png differ diff --git a/img/clio-zapier.png b/img/clio-zapier.png new file mode 100644 index 00000000..11566f8c Binary files /dev/null and b/img/clio-zapier.png differ diff --git a/img/custom-adapter.png b/img/custom-adapter.png new file mode 100644 index 00000000..8bb05696 Binary files /dev/null and b/img/custom-adapter.png differ diff --git a/img/edge-allow-ext.png b/img/edge-allow-ext.png new file mode 100644 index 00000000..c21b36f5 Binary files /dev/null and b/img/edge-allow-ext.png differ diff --git a/img/edge-extensions-menu.png b/img/edge-extensions-menu.png new file mode 100644 index 00000000..4cc32dbe Binary files /dev/null and b/img/edge-extensions-menu.png differ diff --git a/img/embeddable.png b/img/embeddable.png new file mode 100644 index 00000000..cacbd72b Binary files /dev/null and b/img/embeddable.png differ diff --git a/img/extension-details.png b/img/extension-details.png new file mode 100644 index 00000000..3b2bd81d Binary files /dev/null and b/img/extension-details.png differ diff --git a/img/extension-options.png b/img/extension-options.png new file mode 100644 index 00000000..ea2af1ad Binary files /dev/null and b/img/extension-options.png differ diff --git a/img/feedback.png b/img/feedback.png new file mode 100644 index 00000000..04ce8d26 Binary files /dev/null and b/img/feedback.png differ diff --git a/img/flow.png b/img/flow.png new file mode 100644 index 00000000..03bc9e09 Binary files /dev/null and b/img/flow.png differ diff --git a/img/insightly-apicreds.png b/img/insightly-apicreds.png new file mode 100644 index 00000000..e36305b5 Binary files /dev/null and b/img/insightly-apicreds.png differ diff --git a/img/insightly-auth-page.png b/img/insightly-auth-page.png new file mode 100644 index 00000000..caa6f7e2 Binary files /dev/null and b/img/insightly-auth-page.png differ diff --git a/img/insightly-connect.png b/img/insightly-connect.png new file mode 100644 index 00000000..97006122 Binary files /dev/null and b/img/insightly-connect.png differ diff --git a/img/insightly-logo.png b/img/insightly-logo.png new file mode 100644 index 00000000..f9989982 Binary files /dev/null and b/img/insightly-logo.png differ diff --git a/img/insightly-setup.png b/img/insightly-setup.png new file mode 100644 index 00000000..2947ac1b Binary files /dev/null and b/img/insightly-setup.png differ diff --git a/img/intro.png b/img/intro.png new file mode 100644 index 00000000..7e0968d1 Binary files /dev/null and b/img/intro.png differ diff --git a/img/log-calls.png b/img/log-calls.png new file mode 100644 index 00000000..6534c4a3 Binary files /dev/null and b/img/log-calls.png differ diff --git a/img/logout.png b/img/logout.png new file mode 100644 index 00000000..d146234c Binary files /dev/null and b/img/logout.png differ diff --git a/img/manually-refresh-contact.png b/img/manually-refresh-contact.png new file mode 100644 index 00000000..e4d65c2c Binary files /dev/null and b/img/manually-refresh-contact.png differ diff --git a/img/multi-contacts.png b/img/multi-contacts.png new file mode 100644 index 00000000..63eb5f5b Binary files /dev/null and b/img/multi-contacts.png differ diff --git a/img/netsuite-connect.png b/img/netsuite-connect.png new file mode 100644 index 00000000..471dd085 Binary files /dev/null and b/img/netsuite-connect.png differ diff --git a/img/netsuite-logo.png b/img/netsuite-logo.png new file mode 100644 index 00000000..cbe246d8 Binary files /dev/null and b/img/netsuite-logo.png differ diff --git a/img/no-contacts.png b/img/no-contacts.png new file mode 100644 index 00000000..d4edaf80 Binary files /dev/null and b/img/no-contacts.png differ diff --git a/img/notes-during-call.png b/img/notes-during-call.png new file mode 100644 index 00000000..9e04bf16 Binary files /dev/null and b/img/notes-during-call.png differ diff --git a/img/overriding-format-setup.png b/img/overriding-format-setup.png new file mode 100644 index 00000000..810dba85 Binary files /dev/null and b/img/overriding-format-setup.png differ diff --git a/img/pipedrive-connect.png b/img/pipedrive-connect.png new file mode 100644 index 00000000..4adef2e5 Binary files /dev/null and b/img/pipedrive-connect.png differ diff --git a/img/pipedrive-logo.png b/img/pipedrive-logo.png new file mode 100644 index 00000000..18852290 Binary files /dev/null and b/img/pipedrive-logo.png differ diff --git a/img/pipedrive-marketplace.png b/img/pipedrive-marketplace.png new file mode 100644 index 00000000..b9081a87 Binary files /dev/null and b/img/pipedrive-marketplace.png differ diff --git a/img/presence-settings.png b/img/presence-settings.png new file mode 100644 index 00000000..5e7d15b5 Binary files /dev/null and b/img/presence-settings.png differ diff --git a/img/presence.png b/img/presence.png new file mode 100644 index 00000000..105a2829 Binary files /dev/null and b/img/presence.png differ diff --git a/img/quick-access.png b/img/quick-access.png new file mode 100644 index 00000000..854d0518 Binary files /dev/null and b/img/quick-access.png differ diff --git a/img/redtail-connect.png b/img/redtail-connect.png new file mode 100644 index 00000000..973588dc Binary files /dev/null and b/img/redtail-connect.png differ diff --git a/img/redtail-logo.png b/img/redtail-logo.png new file mode 100644 index 00000000..bd6d3932 Binary files /dev/null and b/img/redtail-logo.png differ diff --git a/img/servicenow.png b/img/servicenow.png new file mode 100644 index 00000000..34e2ca0d Binary files /dev/null and b/img/servicenow.png differ diff --git a/img/settings-audio.png b/img/settings-audio.png new file mode 100644 index 00000000..a1d6e41f Binary files /dev/null and b/img/settings-audio.png differ diff --git a/img/settings-autolog.png b/img/settings-autolog.png new file mode 100644 index 00000000..992f34df Binary files /dev/null and b/img/settings-autolog.png differ diff --git a/img/settings-call-log.png b/img/settings-call-log.png new file mode 100644 index 00000000..82917485 Binary files /dev/null and b/img/settings-call-log.png differ diff --git a/img/settings-calling.png b/img/settings-calling.png new file mode 100644 index 00000000..ce578832 Binary files /dev/null and b/img/settings-calling.png differ diff --git a/img/settings-callpop.png b/img/settings-callpop.png new file mode 100644 index 00000000..0377fd7c Binary files /dev/null and b/img/settings-callpop.png differ diff --git a/img/settings-contact-creation-pop.png b/img/settings-contact-creation-pop.png new file mode 100644 index 00000000..0580bd4b Binary files /dev/null and b/img/settings-contact-creation-pop.png differ diff --git a/img/settings-countdown.png b/img/settings-countdown.png new file mode 100644 index 00000000..312d19a9 Binary files /dev/null and b/img/settings-countdown.png differ diff --git a/img/settings-dialer.png b/img/settings-dialer.png new file mode 100644 index 00000000..7aedff9c Binary files /dev/null and b/img/settings-dialer.png differ diff --git a/img/settings-region.png b/img/settings-region.png new file mode 100644 index 00000000..b06649ba Binary files /dev/null and b/img/settings-region.png differ diff --git a/img/settings-sms.png b/img/settings-sms.png new file mode 100644 index 00000000..6a401047 Binary files /dev/null and b/img/settings-sms.png differ diff --git a/img/sms-import.png b/img/sms-import.png new file mode 100644 index 00000000..d24dd0c2 Binary files /dev/null and b/img/sms-import.png differ diff --git a/img/sms-templates-glip.png b/img/sms-templates-glip.png new file mode 100644 index 00000000..cefcfbdb Binary files /dev/null and b/img/sms-templates-glip.png differ diff --git a/img/sms-templates.png b/img/sms-templates.png new file mode 100644 index 00000000..e75cb48e Binary files /dev/null and b/img/sms-templates.png differ diff --git a/img/supported-crms.png b/img/supported-crms.png new file mode 100644 index 00000000..73c8ff33 Binary files /dev/null and b/img/supported-crms.png differ diff --git a/img/test-auth-page.png b/img/test-auth-page.png new file mode 100644 index 00000000..01738ce3 Binary files /dev/null and b/img/test-auth-page.png differ diff --git a/img/unlogged-filter.png b/img/unlogged-filter.png new file mode 100644 index 00000000..ad80ff2f Binary files /dev/null and b/img/unlogged-filter.png differ diff --git a/img/vendor-gate6.png b/img/vendor-gate6.png new file mode 100644 index 00000000..6c4dea3d Binary files /dev/null and b/img/vendor-gate6.png differ diff --git a/img/version.png b/img/version.png new file mode 100644 index 00000000..9f79ba53 Binary files /dev/null and b/img/version.png differ diff --git a/img/view-contact-and-log-details.png b/img/view-contact-and-log-details.png new file mode 100644 index 00000000..1e8d6d7b Binary files /dev/null and b/img/view-contact-and-log-details.png differ diff --git a/img/web-store-install.png b/img/web-store-install.png new file mode 100644 index 00000000..5a8862bb Binary files /dev/null and b/img/web-store-install.png differ diff --git a/img/welcome-dialog.png b/img/welcome-dialog.png new file mode 100644 index 00000000..f0a099a8 Binary files /dev/null and b/img/welcome-dialog.png differ diff --git a/index.html b/index.html new file mode 100644 index 00000000..2b47a81e --- /dev/null +++ b/index.html @@ -0,0 +1,2010 @@ + + + + + + + + + + + + + + + + + + + + + + + App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + + + + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +
+

RingCentral Unified CRM extension is becoming App Connect! Learn more

+
+

App Connect for RingEX

+

RingCentral's App Connect for RingEX is a browser extension for Google Chrome and Microsoft Edge that helps connect your RingCentral RingEX account to a number of different CRM services. It embeds a fully functional web phone into your CRM and supports key user flows unique to CRMs to better track communications and engage with customers.

+
+

App Connect's supported CRMs +

+
+

Don't see your CRM listed above? Tell us using our Ideas portal, or work with a developer to build for it.

+
+
+

Features

+
    +
  • Embedded dailer/CTI. A fully functional phone is embedded into your CRM so that you can place and receive phone calls. The CTI is also enhanced with specific capabilities designed specifically for use cases common to users of most CRMs. These enhancements are enumerated below.
    • +
  • Click-to-dial. Make any phone number in your CRM clickable to easily call or send an SMS to that phone number.
    • +
  • Call logging. Every call you make or receive on RingCentral can easily be logged into your CRM ensuring important communications are recorded there. Options are available that allow you to log calls and messages automatically, and more.
    • +
  • Automatic call logging. With a flip of a switch, make sure every inbound and outbound call is recorded in your CRM. If there is a conflict, then access our "Unlogged" tab to quickly fix the issue.
    • +
  • Call pop. When you receive a phone call, the extension will automatically open the caller's contact page in your CRM so that you have the customer's full context before answering the phone.
    • +
  • Send/receive SMS. Not only can you place calls, but you can also send and receive SMS using the CTI.
    • +
  • SMS templates. Respond to SMS more quickly, by storing and accessing messages you commonly send over SMS using a simple UI.
    • +
+
+

App Connect +

+
RingCentral's App Connect as seen inside Redtail CRM
+
+

Are you a developer? Build support for your own CRM

+

App Connect is itself an open source framework that can be used by developers to create a custom CRM integration more easily than building one from scratch.

+

Prerequisites

+

App Connect requires the following:

+
    +
  • RingEX account (Core, Advanced or Ultimate)
    • +
  • Google Chrome or Microsoft Edge
    • +
+ + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/release-notes/index.html b/release-notes/index.html new file mode 100644 index 00000000..71d42b7d --- /dev/null +++ b/release-notes/index.html @@ -0,0 +1,2586 @@ + + + + + + + + + + + + + + + + + + + + + + + Release notes - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Release notes

+

1.3.3

+
    +
  • Update: This extension's name is now changed to RingCentral App Connect
    • +
  • Fix: (for Clio and Insightly user only) Overriding phone number format missing issue
    • +
  • Fix: Admin icon in dark theme
    • +
  • Fix: Auto pop up log page after call setting not working
    • +
  • Fix: Inbound call contact pop not working
    • +
+

1.3.2

+
    +
  • New: User setting inside call pop to control behavior of multiple matched contacts (disabled, all open, prompt to select)
    • +
  • Fix: SMS logging issue
    • +
  • Fix: Auto open extension now only opens when main page is opened
    • +
+

1.3.1

+
    +
  • New: (Only for admin users) Admin tools. Admins have an extra tab in the extension to control end users' settings
    • +
  • Fix: SMS logging date format
    • +
+

1.2.0

+
    +
  • Fix: SMS log issue
    • +
  • Fix: Missing recording link when doing retroactive auto call logging
    • +
  • Bullhorn: New user setting to allow custom action note
    • +
+

1.1.4

+
    +
  • Bullhorn: Fix default SMS note action issue
    • +
  • Bullhorn: Fix message log timezone issue
    • +
+

1.1.3

+
    +
  • Fix: Auto log association
    • +
  • New: User setting in advanced features to turn on "Auto open extension" to open itself when opening a CRM page
    • +
  • Redtail: Fix domain matching
    • +
+

1.1.2

+
    +
  • Change: Auto pop up log page is not dependent on auto log setting anymore
    • +
+

1.1.1

+
    +
  • Fix: Call/SMS logging issue
    • +
+

1.1.0

+
    +
  • New: Show error page when CRM initialization fails
    • +
  • Better: Use local cached contact info to avoid rate limit issue
    • +
  • Better: Auto call log now supports retrospectively logging up to 100 unlogged records upon extension open
    • +
  • Bullhorn: Default note action matching ignores case and spaces
    • +
  • Bullhorn: Fix issue on user id confusion
    • +
+

1.0.10

+
    +
  • Change: Unreolved tab is removed now. To check out unlogged calls, there's now a filter on call history page
    • +
  • Change: Updated notification UI.
    • +
  • Fix: Numbers can now be copied from call page and call history page
    • +
  • Fix: Click-to-dial now supports detecting phone numbers in input fields
    • +
  • Fix: Click-to-dial now supports detecting extension numbers with format as eg. +13334445555#134
    • +
+

1.0.9

+
    +
  • New: Call history page now has a search bar with filters
    • +
  • New: Contact pop settings now support both inbound and outbound calls on different timings
    • +
  • New: RingCentral team message is added as a new tab
    • +
+

1.0.8

+
    +
  • New: More historical call records can be viewed from call history page with 'Load more' button
    • +
+

1.0.7

+
    +
  • Fix: Incoming call pop contact page fixed
    • +
+

1.0.6

+
    +
  • Better: User settings are organized in a better way
    • +
  • New: Support page is added to user settings
    • +
  • New: Community forum is created, can be accessed via support page -> 'Get support'
    • +
  • Clio&Insightly: Number formatters are in user setting contact page now
    • +
+

1.0.5

+
    +
  • Better: Bullhorn now has Voicemail default note action
    • +
  • Fix: SMS template remembers orders after close
    • +
+

1.0.4

+
    +
  • New: An About page in user settings to show info and helper links
    • +
  • Better: Factor reset now also cleans up unresolved conflicts
    • +
  • Better: SMS template supports drag and drop to arrange item orders
    • +
+

1.0.3

+
    +
  • Better: Use SMS template that syncs with RingCentral App's SMS template
    • +
  • New: Show notification when a call recording link is uploaded. Typically, a call recording link won't be immediately ready upon hang up. If call is logged right after, call recording will be uploaded when it's ready
    • +
+

1.0.2

+
    +
  • Fix: SMS template cannot apply issue
    • +
  • New: Factor reset button in user settings
    • +
+

1.0.1

+
    +
  • Fix: RingCentral sign in issue where pop up sign in window is stuck at loading screen
    • +
  • Better: Auto log conflict messages now contain more meaningful info
    • +
+

Bullhorn

+
    +
  • Better: Default Note Action is now moved to User Settings where you can setup default actions. Can also work for auto log.
    • +
+

1.0.0

+
    +
  • New: Auto log with conflict resolver
    • +
  • New: Manual refersh contact info with button
    • +
  • New: Audio volume controls
    • +
  • Better: SMS messages are now logged as in conversations per day
    • +
  • Better: New UIs
    • +
  • Fix: Fax view and logging
    • +
  • Fix: Open contact page from call history now only opens selected one if there are multiple matched contacts
    • +
  • Fix: Copy meeting info
    • +
  • Remove: Auto log with countdown
    • +
+

New features video demo:

+ + +

0.8.7

+
    +
  • Fix: Call disposition not cleared if opening under a contact without disposition options
    • +
+

0.8.6

+
    +
  • Fix: Incoming call contact pop up called twice issue
    • +
  • Fix: Log event mixed up issue
    • +
+

0.8.5

+
    +
  • Fix: Bullhorn and Redtail SMS message log issue
    • +
+

0.8.4

+
    +
  • Fix: Pipedrive deal mismatch issue
    • +
+

0.8.3

+
    +
  • Change: Updated logo icon
    • +
  • Fix: SMS log issue in multiple contacts matched case
    • +
  • Fix: In-call note button will disappear if user opens message conversation so to not cover SMS send button
    • +
  • Bullhorn: Clear user session info when log out
    • +
+

0.8.2

+
    +
  • Fix: Message conversation log page open issue
    • +
  • Feature: Clicking log button for a logged call will open corresponding contact/log page
    • +
+

0.8.1

+
    +
  • Fix: Sign up button now opens RingCentral plan page
    • +
+

0.8.0

+
    +
  • Feature: Now support logging calls for unknown contacts. Users will see extra fields on call log page to fill in placeholder contact info and click "Save" button to create a new placeholder contact and then log the call against it
    • +
  • Feature: Now support multiple matched contacts in call logging. Users can select target contact if it's a multiple match case
    • +
  • New setting - "Open contact web page after creating it": Auto open placeholder contact page so that users can do further editing more easily
    • +
  • UI: Polished the looking of some UIs
    • +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..115724f0 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"

RingCentral Unified CRM extension is becoming App Connect! Learn more

"},{"location":"#app-connect-for-ringex","title":"App Connect for RingEX","text":"

RingCentral's App Connect for RingEX is a browser extension for Google Chrome and Microsoft Edge that helps connect your RingCentral RingEX account to a number of different CRM services. It embeds a fully functional web phone into your CRM and supports key user flows unique to CRMs to better track communications and engage with customers.

Don't see your CRM listed above? Tell us using our Ideas portal, or work with a developer to build for it.

"},{"location":"#features","title":"Features","text":"
  • Embedded dailer/CTI. A fully functional phone is embedded into your CRM so that you can place and receive phone calls. The CTI is also enhanced with specific capabilities designed specifically for use cases common to users of most CRMs. These enhancements are enumerated below.
  • Click-to-dial. Make any phone number in your CRM clickable to easily call or send an SMS to that phone number.
  • Call logging. Every call you make or receive on RingCentral can easily be logged into your CRM ensuring important communications are recorded there. Options are available that allow you to log calls and messages automatically, and more.
  • Automatic call logging. With a flip of a switch, make sure every inbound and outbound call is recorded in your CRM. If there is a conflict, then access our \"Unlogged\" tab to quickly fix the issue.
  • Call pop. When you receive a phone call, the extension will automatically open the caller's contact page in your CRM so that you have the customer's full context before answering the phone.
  • Send/receive SMS. Not only can you place calls, but you can also send and receive SMS using the CTI.
  • SMS templates. Respond to SMS more quickly, by storing and accessing messages you commonly send over SMS using a simple UI.
RingCentral's App Connect as seen inside Redtail CRM"},{"location":"#are-you-a-developer-build-support-for-your-own-crm","title":"Are you a developer? Build support for your own CRM","text":"

App Connect is itself an open source framework that can be used by developers to create a custom CRM integration more easily than building one from scratch.

"},{"location":"#prerequisites","title":"Prerequisites","text":"

App Connect requires the following:

  • RingEX account (Core, Advanced or Ultimate)
  • Google Chrome or Microsoft Edge
"},{"location":"build/","title":"Build support for a new app or CRM","text":"

App Connect is not only a product used by RingCentral customers to connect our communications system to their applications, it is also a developer framework that helps companies integrate a full-featured phone and communication client into new CRMs, or proprietary CRMs into RingCentral quickly, efficiently and at a fraction of the cost.

If your CRM is not supported by App Connect, you have three general options.

"},{"location":"build/#build-an-app-connect-adapter-yourself","title":"Build an App Connect adapter yourself","text":"

App Connect is an open source framework that you are welcome to use to build support for your CRM of choice on your own. Our developer documentation will help you get started.

"},{"location":"build/#work-with-a-trusted-third-party-vendor","title":"Work with a trusted third-party vendor","text":""},{"location":"build/#gate6","title":"Gate6","text":"

Gate6 specializes in connecting your business applications, platforms, and data sources into cohesive Enterprise Solutions. Their dedicated System Integration Services team ensures seamless integration across infrastructure, technology architecture, applications, and data. With a focus on preserving legacy investments while embracing future innovations, they deliver end-to-end solutions tailored to your needs.

"},{"location":"build/#adapters","title":"Adapters","text":"

  • Currently in beta, Gate6 offers an adapter for ServiceNow, developed in partnership with RingCentral. Licenses start at $10/month/user.

"},{"location":"getting-started/","title":"Setup and installation","text":"

RingCentral's App Connect is a browser extension for Google Chrome and Microsoft Edge that is available via the Chrome web store. Installation is quick and easy if you are accustom to installing browser extensions. Click the web store button below to get started.

Install the extension now"},{"location":"getting-started/#installing-the-browser-plugin","title":"Installing the browser plugin","text":""},{"location":"getting-started/#google-chrome","title":"Google Chrome","text":"

App Connect was initially architected for Google Chrome, and is therefore installed easily from the Google Chrome web store. Click the \"Add to Chrome\" button to install the extension instantly. Then, consult the instructions specific to your CRM.

"},{"location":"getting-started/#microsoft-edge","title":"Microsoft Edge","text":"

Microsoft Edge supports most Chrome extensions. To install them, however, you will need to make configuration changes to Edge. In summary:

  1. In Microsoft Edge, navigate to the Manage extensions.

  2. Select \"Allow extensions from other stores\" in the banner at the top of the page, then select \"Allow\" to confirm.

  3. Navigate to the App Connect extension in the Chrome web store and select \"Add to Chrome.\"

  4. Follow any additional prompts to complete the installation process.

"},{"location":"getting-started/#connecting-to-your-crm","title":"Connecting to your CRM","text":"

The process of connecting App Connect to your CRM is more or less the same at a high-level.

  1. First, navigate to and login to your CRM.

  2. While viewing a page in your CRM, open up the extension by clicking the App Connect badge.

  3. Open the \"More\" tab and select \"Settings.\"

  4. Scroll down to find your CRM, and click the \"Connect\" button.
  5. Follow the on-screen instructions for your CRM.

Each CRM may have a slightly different approach in order to install the extension fully. Consult the CRM-specific documentation to setup and configure your CRM below.

  • Connect and setup Bullhorn
  • Connect and setup Clio
  • Connect and setup Insightly
  • Connect and setup Pipedrive
  • Connect and setup Redtail CRM
  • Connect and setup NetSuite
"},{"location":"release-notes/","title":"Release notes","text":""},{"location":"release-notes/#133","title":"1.3.3","text":"
  • Update: This extension's name is now changed to RingCentral App Connect
  • Fix: (for Clio and Insightly user only) Overriding phone number format missing issue
  • Fix: Admin icon in dark theme
  • Fix: Auto pop up log page after call setting not working
  • Fix: Inbound call contact pop not working
"},{"location":"release-notes/#132","title":"1.3.2","text":"
  • New: User setting inside call pop to control behavior of multiple matched contacts (disabled, all open, prompt to select)
  • Fix: SMS logging issue
  • Fix: Auto open extension now only opens when main page is opened
"},{"location":"release-notes/#131","title":"1.3.1","text":"
  • New: (Only for admin users) Admin tools. Admins have an extra tab in the extension to control end users' settings
  • Fix: SMS logging date format
"},{"location":"release-notes/#120","title":"1.2.0","text":"
  • Fix: SMS log issue
  • Fix: Missing recording link when doing retroactive auto call logging
  • Bullhorn: New user setting to allow custom action note
"},{"location":"release-notes/#114","title":"1.1.4","text":"
  • Bullhorn: Fix default SMS note action issue
  • Bullhorn: Fix message log timezone issue
"},{"location":"release-notes/#113","title":"1.1.3","text":"
  • Fix: Auto log association
  • New: User setting in advanced features to turn on \"Auto open extension\" to open itself when opening a CRM page
  • Redtail: Fix domain matching
"},{"location":"release-notes/#112","title":"1.1.2","text":"
  • Change: Auto pop up log page is not dependent on auto log setting anymore
"},{"location":"release-notes/#111","title":"1.1.1","text":"
  • Fix: Call/SMS logging issue
"},{"location":"release-notes/#110","title":"1.1.0","text":"
  • New: Show error page when CRM initialization fails
  • Better: Use local cached contact info to avoid rate limit issue
  • Better: Auto call log now supports retrospectively logging up to 100 unlogged records upon extension open
  • Bullhorn: Default note action matching ignores case and spaces
  • Bullhorn: Fix issue on user id confusion
"},{"location":"release-notes/#1010","title":"1.0.10","text":"
  • Change: Unreolved tab is removed now. To check out unlogged calls, there's now a filter on call history page
  • Change: Updated notification UI.
  • Fix: Numbers can now be copied from call page and call history page
  • Fix: Click-to-dial now supports detecting phone numbers in input fields
  • Fix: Click-to-dial now supports detecting extension numbers with format as eg. +13334445555#134
"},{"location":"release-notes/#109","title":"1.0.9","text":"
  • New: Call history page now has a search bar with filters
  • New: Contact pop settings now support both inbound and outbound calls on different timings
  • New: RingCentral team message is added as a new tab
"},{"location":"release-notes/#108","title":"1.0.8","text":"
  • New: More historical call records can be viewed from call history page with 'Load more' button
"},{"location":"release-notes/#107","title":"1.0.7","text":"
  • Fix: Incoming call pop contact page fixed
"},{"location":"release-notes/#106","title":"1.0.6","text":"
  • Better: User settings are organized in a better way
  • New: Support page is added to user settings
  • New: Community forum is created, can be accessed via support page -> 'Get support'
  • Clio&Insightly: Number formatters are in user setting contact page now
"},{"location":"release-notes/#105","title":"1.0.5","text":"
  • Better: Bullhorn now has Voicemail default note action
  • Fix: SMS template remembers orders after close
"},{"location":"release-notes/#104","title":"1.0.4","text":"
  • New: An About page in user settings to show info and helper links
  • Better: Factor reset now also cleans up unresolved conflicts
  • Better: SMS template supports drag and drop to arrange item orders
"},{"location":"release-notes/#103","title":"1.0.3","text":"
  • Better: Use SMS template that syncs with RingCentral App's SMS template
  • New: Show notification when a call recording link is uploaded. Typically, a call recording link won't be immediately ready upon hang up. If call is logged right after, call recording will be uploaded when it's ready
"},{"location":"release-notes/#102","title":"1.0.2","text":"
  • Fix: SMS template cannot apply issue
  • New: Factor reset button in user settings
"},{"location":"release-notes/#101","title":"1.0.1","text":"
  • Fix: RingCentral sign in issue where pop up sign in window is stuck at loading screen
  • Better: Auto log conflict messages now contain more meaningful info

Bullhorn

  • Better: Default Note Action is now moved to User Settings where you can setup default actions. Can also work for auto log.
"},{"location":"release-notes/#100","title":"1.0.0","text":"
  • New: Auto log with conflict resolver
  • New: Manual refersh contact info with button
  • New: Audio volume controls
  • Better: SMS messages are now logged as in conversations per day
  • Better: New UIs
  • Fix: Fax view and logging
  • Fix: Open contact page from call history now only opens selected one if there are multiple matched contacts
  • Fix: Copy meeting info
  • Remove: Auto log with countdown

New features video demo:

"},{"location":"release-notes/#087","title":"0.8.7","text":"
  • Fix: Call disposition not cleared if opening under a contact without disposition options
"},{"location":"release-notes/#086","title":"0.8.6","text":"
  • Fix: Incoming call contact pop up called twice issue
  • Fix: Log event mixed up issue
"},{"location":"release-notes/#085","title":"0.8.5","text":"
  • Fix: Bullhorn and Redtail SMS message log issue
"},{"location":"release-notes/#084","title":"0.8.4","text":"
  • Fix: Pipedrive deal mismatch issue
"},{"location":"release-notes/#083","title":"0.8.3","text":"
  • Change: Updated logo icon
  • Fix: SMS log issue in multiple contacts matched case
  • Fix: In-call note button will disappear if user opens message conversation so to not cover SMS send button
  • Bullhorn: Clear user session info when log out
"},{"location":"release-notes/#082","title":"0.8.2","text":"
  • Fix: Message conversation log page open issue
  • Feature: Clicking log button for a logged call will open corresponding contact/log page
"},{"location":"release-notes/#081","title":"0.8.1","text":"
  • Fix: Sign up button now opens RingCentral plan page
"},{"location":"release-notes/#080","title":"0.8.0","text":"
  • Feature: Now support logging calls for unknown contacts. Users will see extra fields on call log page to fill in placeholder contact info and click \"Save\" button to create a new placeholder contact and then log the call against it
  • Feature: Now support multiple matched contacts in call logging. Users can select target contact if it's a multiple match case
  • New setting - \"Open contact web page after creating it\": Auto open placeholder contact page so that users can do further editing more easily
  • UI: Polished the looking of some UIs
"},{"location":"support/","title":"Getting help with App Connect","text":"

  • Search the Community

    Search for answers from the community knowledge base.

  • Ask a question

    Ask the community for help - you will find all of us very helpful.

"},{"location":"support/#common-issues","title":"Common issues","text":"

Always make sure you are running the latest version

App Connect is frequently updated with fixes and feature enhancements. While the extension is updated automatically, you may need to restart your browser in order for those updates to take effect.

"},{"location":"support/#i-dont-see-a-connect-button-to-login-to-my-crm","title":"I don't see a \"Connect\" button to login to my CRM","text":"

In order to determine which CRM to connect to, you need to launch the extension while visiting and logged into your CRM application. App Connect will detect from the domain you are visiting to determine which CRM to prompt you to connect to. If you launch App Connect from any other domain, you will not see an Authorize or Connect button.

"},{"location":"support/#unable-to-find-contact","title":"Unable to find contact","text":"

One of the most common challenges arises from phone calls for which a corresponding contact record in the CRM cannot be found. However, you know for sure the contact exists.

When this happens it is almost certainly related to a failed lookup of the contact based on the given phone number. A lookup can fail in some CRMs:

  1. If the phone number stored in the CRM does not EXACTLY match the phone number as seen in App Connect. This is due to limitations in the connected CRMs' APIs.
  2. If you have just created it and the CRM server usually doesn't reflect the change immediately. Some CRMs have refresh clock to update all changes every X seconds/minutes. So if it's just created and can be seen on CRM webpages, please wait for a couple of minutes and it should then be fetched to the extension.

There are two ways to fix the issue:

  1. Update the contact record's phone number so that it conforms to the E.164 standard. This will be the most reliable solution and the most performant. However, reformatting the phone numbers across a huge contact database may not be feasible or practical.

  2. Update the advanced configuration settings of App Connect to add the phone number formats commonly used by your company. App Connect will then search for contacts using each of the phone number formats stored with us. This solution is easier to deploy, but can sometimes introduce latencies as multiple API calls are needed to successfully find a contact.

"},{"location":"support/#managing-software-updates","title":"Managing software updates","text":"

Updates to App Connect are installed automatically by Chrome and Edge when you restart your browser. You can see what version of App Connect is currently installed by navigating to the \"Manage extensions\" area of your browser, finding App Connect in your list of installed browser extensions, and clicking \"Show details.\" On the resulting page you can see the currently installed version.

To ensure you are actively running the most recent version, please restart your browser.

"},{"location":"support/#last-resort","title":"Last resort","text":"

In rare circumstances, due to voodoo and other supernatural forces, uninstalling and reinstalling the extension has been known to fix some problems.

"},{"location":"crm/","title":"CRMs supported by App Connect","text":"

RingCentral's App Connect for RingEX provides support for a number of different CRMs including the list below. It is also a developer framework that allows companies to quickly and easily build integrations with more niche or proprietary CRMs at a fraction of the cost.

"},{"location":"crm/#supported-crms","title":"Supported CRMs","text":"
  • Bullhorn
  • Clio
  • Insightly
  • Pipedrive
  • Redtail CRM
  • NetSuite
"},{"location":"crm/#dont-see-your-crm-listed","title":"Don't see your CRM listed?","text":"

If you don't see your CRM listed, contact us via our community and we can help get you in touch with qualified vendors or RingCentral Professional Services to help you build a solution that fits your needs.

"},{"location":"crm/#are-you-a-developer-build-support-for-your-own-crm","title":"Are you a developer? Build support for your own CRM","text":"

App Connect is itself an open source framework that can be used by developers to create a custom CRM integration more easily than building one from scratch.

"},{"location":"crm/bullhorn/","title":"Setting up App Connect for Bullhorn","text":"

Bullhorn is the global leader in software for the staffing industry. More than 10,000 companies rely on Bullhorn\u2019s cloud-based platform to power their staffing processes from start to finish.

RingCentral's integration with Bullhorn helps streamline communications with candidates, and helps staffing agents better support candidates through the entire recruitment pipeline by helping to manage and store communication history for all candidates.

"},{"location":"crm/bullhorn/#install-the-extension","title":"Install the extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/bullhorn/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for Bullhorn.

  1. Login to Bullhorn.

  2. While visiting a Bullhorn application page, click the quick access badge to open or bring the dialer to the foreground.

  3. Navigate to the Settings screen in App Connect, and find the option labeled \"Bullhorn.\"

  4. Click the \"Connect\" button.

  5. A window will be opened prompting you to enter your Bullhorn username and password. Login to Bullhorn.

When you login successfully, the Chrome extension will automatically update to show you are connected to Bullhorn. If you are connected, the button next to Bullhorn will say, \"logout\".

And with that, you will be connected to Bullhorn and ready to begin using the integration.

"},{"location":"crm/bullhorn/#auto-log-with-default-note-action-preference-setup","title":"Auto log with default Note Action preference setup","text":"

In Settings, there's a \"Bullhorn options\" entry button.

We provide four options to choose from, corresponding to the different communications that can be logged in Bullhorn via App Connect. The values you enter here will be used in two different ways:

  1. When logging calls automatically, these note actions will be used when creating the associated notes.
  2. When logging calls manually, these note actions will determine which action is selected by default in the logging screen.

"},{"location":"crm/bullhorn/#editing-the-enumerated-list-of-possible-note-actions","title":"Editing the enumerated list of possible note actions","text":"

As an admin, navigate inside of Bullhorn to Admin > System Settings. Then filter the list of settings for \"commentActionList.\" There you should fine a comma-delimited list of values that determine the possible/allowed note actions.

"},{"location":"crm/bullhorn/#placeholder-companies-when-creating-contacts","title":"Placeholder companies when creating contacts","text":"

Bullhorn requires that every contact be associated with a company. When logging calls for new contacts, App Connect will first look for a company called, \"Placeholder company.\" If a company with that name is not found, one will be created. Then the contact will be associated with that company record. It is the intent that once the call is complete that an agent do one of the following:

  1. Edit the company called \"Placeholder Company\" with a more appropriate name and with additional details.
  2. Edit the contact to associate it with a more appropriate company stored in Bullhorn.

In this way, App Connect ensures that all contacts created by it conform to the requirements of Bullhorn so that all contact records are complete.

"},{"location":"crm/clio/","title":"Setting up App Connect for Clio","text":"

Clio provides legal client relationship management software to help law firms manage business development functions such as client intake, client scheduling and follow-up, revenue tracking, and more. In short, Clio addresses the client intake process of turning potential new clients into retained clients.

RingCentral's integration with Clio helps streamline communications with clients, and helps staff servicing clients to better support them through the entire intake process by helping to manage and store communication history with clients, report on billable time and more.

"},{"location":"crm/clio/#install-the-extension","title":"Install the extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/clio/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for Clio.

  1. Login to Clio.

  2. While visiting a Clio application page, click the quick access button to bring the dialer to the foreground.

  3. Navigate to the Settings screen in App Connect, and find the option labeled \"Clio.\"

  4. Click the \"Connect\" button.

  5. A window will be opened prompting you to enter your Clio username and password. Login to Clio.

When you login successfully, the Chrome extension will automatically update to show you are connected to Clio. If you are connected, the button next to Clio will say, \"logout\".

And with that, you will be connected to Clio and ready to begin using the integration.

"},{"location":"crm/clio/#setting-up-phone-number-matching-to-properly-match-contacts","title":"Setting up phone number matching to properly match contacts","text":"

Clio's contact lookup method is very strict. As a result, if the phone numbers in Clio are not stored using the E.164 standard, e.g. +1##########, then App Connect will fail to find the contact record for call logging and call pop.

To address this, short of reformatting every phone number stored in Clio, is to go to Phone number format alternatives under the \"Contacts\" settings and set the phone number formats to conform with the conventions used by your practice.

Navigate to App Connect's Contacts settings page and enter in the phone formats used by your practice. Define a format by using an asterix \"*\" in place of any digit/number. Any other character used in the format string will be interpretted literally.

Let's look at a few examples. First, consider the following format string:

(***) ***-****\n
Phone number Does it match? (555) 123-2334 Yes (555)123-2334 No 1 (555) 123-2334 No 555-123-2334 No

Now, let's look at one more example. Consider the format string:

1 (***) ***-****\n
Phone number Does it match? 1 (555) 123-2334 Yes +1 (555) 123-2334 No (555) 123-2334 No 555-123-2334 No

We have found the following formats are commonly used among customers (feel free to copy and paste them into advanced settings):

  • (***) ***-****
  • ***-***-****
  • ***.***.****
  • 1 (***) ***-****

Select or enter up to three different formats used by your practice and click \"Save.\"

Phone number formats after being properly filled in.

The E.164 format is used by default. You do not need to specify the format 1**********.

Making this change will improve your experience with the extension considerably. Here are a few things to bear in mind:

  • Every phone number format you add results in another search request to Clio, which could lead to performance issues.
  • Searches are performed using each of the formats in order. The first phone number that is found will stop the search process. So place the formats that are most likely to yield results first in order.
"},{"location":"crm/clio/#improving-contact-lookup-speeds","title":"Improving contact lookup speeds","text":"

Ideally, phone numbers in Clio would all be stored using the E.164 format standard. This would eliminate the need to resort to searching using different formats. Therefore, one thing you can do within your company is socialise with Clio users the value of storing phone numbers in a specific format.

Use Zapier to automatically format phone numbers

Zapier is a great automation tool that can help your organization reformat phone numbers to E.164 for all new contacts moving forward.

Finally, you can improve performance by going back to existing contacts and updating their phone numbers. This can be a laborious process, but will yield the best results in the long term.

"},{"location":"crm/insightly/","title":"Setting up App Connect for Insightly","text":"

Growing businesses across the globe rely on Insightly to help them build lasting customer relationships. Insightly delivers a platform that can take businesses to the next level: a powerful CRM, plus marketing automation, a customer service app, and an integration tool.

RingCentral's integration with Insightly helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

"},{"location":"crm/insightly/#install-the-extension","title":"Install the extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/insightly/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for Insightly.

  1. Login to Insightly.

  2. While visiting an Insightly application page, click the quick access button to bring the dialer to the foreground.

  3. Navigate to the Settings screen in App Connect, and find the option labeled \"Insightly.\"

  4. Click the \"Connect\" button.

  5. A window will be opened prompting you to enter numerous attributes from Insightly, including:

    • API key
    • API URL

  6. Click the \"Get API Key\" button and the extension will attempt to retrieve these values for you. You may also enter these values manually. In Insightly, navigate to User Settings from the pull down menu in the upper-righthand corner. Scroll down until you see a section labeled \"API.\" Copy and paste your API key and API URL into the corresponding fields.

When you login successfully, the Chrome extension will automatically update to show you are connected to Insightly. If you are connected, the button next to Insightly will say, \"logout\".

And with that, you will be connected to Insightly and ready to begin using the integration.

"},{"location":"crm/insightly/#setting-up-phone-number-matching-to-properly-match-contacts","title":"Setting up phone number matching to properly match contacts","text":"

Insightly's contact lookup method is very strict. As a result, if the phone numbers in Insightly are not stored using the E.164 standard, e.g. +1##########, then App Connect will fail to find the contact record for call logging and call pop.

To address this, short of reformatting every phone number stored in Insightly, is to go to Phone number format alternatives under the \"Contacts\" settings and set the phone number formats to conform with the conventions used by your company.

Navigate to App Connect's Contacts settings page and enter in the phone formats used by your company. Define a format by using an asterix \"*\" in place of any digit/number. Any other character used in the format string will be interpretted literally.

Let's look at a few examples. First, consider the following format string:

(***) ***-****\n
Phone number Does it match? (555) 123-2334 Yes (555)123-2334 No 1 (555) 123-2334 No 555-123-2334 No

Now, let's look at one more example. Consider the format string:

1 (***) ***-****\n
Phone number Does it match? 1 (555) 123-2334 Yes +1 (555) 123-2334 No (555) 123-2334 No 555-123-2334 No

We have found the following formats are commonly used among customers (feel free to copy and paste them into advanced settings):

  • (***) ***-****
  • ***-***-****
  • ***.***.****
  • 1 (***) ***-****

Select or enter up to three different formats used by your company and click \"Save.\"

Phone number formats after being properly filled in.

The E.164 format is used by default. You do not need to specify the format 1**********.

Making this change will improve your experience with the extension considerably. Here are a few things to bear in mind:

  • Every phone number format you add results in another search request to Insightly, which could lead to performance issues.
  • Searches are performed using each of the formats in order. The first phone number that is found will stop the search process. So place the formats that are most likely to yield results first in order.
"},{"location":"crm/netsuite/","title":"Setting up App Connect for NetSuite","text":"

NetSuite is a cloud-based business management software that helps organizations manage their financials, operations, and customer relationships.

RingCentral's integration with NetSuite helps streamline communications with contacts, and helps staffing agents better support contacts through the entire sales order pipeline by helping to manage and store communication history for all contacts.

Prerequisites

  • The current version of the NetSuite integration requires NetSuite version 2024.1 or later.
  • NetSuite users must have REST Web Services enabled.
  • NetSuite OneWorld license holders will need to manually add the \"Subsidiaries\" permission to the role they use to connect to NetSuite.
"},{"location":"crm/netsuite/#install-the-suiteapp","title":"Install the SuiteApp","text":"

To begin using the NetSuite integration, users will first need to do the following:

  • Login to NetSuite, then visit the RingCentral Suite App page, or:
  • Click on the \"SuiteApps\" tab if your role gives you access to it
  • Search for \"RingCentral\" in the directory
  • Click \"RingCentral App Connect\" in the search results
  • Click the \"Install\" button found in the upper right hand corner of the page

If you see, \"Not compatible\" in place of an \"Install\" button, then you must be running an older version of NetSuite. You will need to upgrade to 2024.2 or later.

Installing the app from the SuiteApp marketplace is a necessary step prior to installing the Chrome extension discussed below.

"},{"location":"crm/netsuite/#setup-roles-and-permissions-in-netsuite","title":"Setup roles and permissions in NetSuite","text":"

Upon installation of the SuiteApp, a role will be created automatically within your account called \"RingCentral App Connect.\" This role has been specially tuned to contain the bare minimum number access level to fully operate the Chrome extension. You can see a detailed list of permissions below if you would like to incorporate these permissions into a custom role of your own.

"},{"location":"crm/netsuite/#netsuite-oneworld-instructions","title":"NetSuite OneWorld instructions","text":"

Upon installing the SuiteApp from the Marketplace, a new custom role named \"RingCentral App Connect\" will be automatically created in your account. If you are a OneWorld license holder, you will need to take these additional steps.

  1. Clone the \"RingCentral App Connect\" role by selecting the \"Customize\" option.
  2. While cloning, add the permission \"List -> Subsidiaries\" to the cloned role.

Use this cloned role when logging into and connecting App Connect to NetSuite.

The role is created by SuiteApp locked by default and cannot be edited. If you wish to make modifications, you may duplicate the role by clicking on 'Customize.'

"},{"location":"crm/netsuite/#turn-on-rest-web-services","title":"Turn on REST web services","text":"

REST Web Services is default to be invisible. We'll need to turn on the feature so to make it selectable for roles. Here's how to do it:

  1. From NetSuite homepage, go to Setup -> Company -> Enable Features
  2. Go to sub-tab, \"SuiteCloud\"
  3. Tick on \"REST Web Services\" and save
"},{"location":"crm/netsuite/#create-role-with-required-permissions","title":"Create role with required permissions","text":"

We recommend using the \"RingCentral App Connect\" role created for you when you install the SuiteApp. However, if you would like to create a custom role that includes the permissions necessary to allow this extension to operate fully, consult the table below.

Category Permission Level Lists Contacts Full Lists Customers Full Lists Phone Calls Full Lists Subsidiaries View (OneWorld users only) Reports SuiteAnalytics Workbook Edit Setup Log in using OAuth 2.0 Access Tokens Full Setup REST Web Services Full Setup User Access Tokens Full Transactions Sales Order Full"},{"location":"crm/netsuite/#install-the-chromeedge-extension","title":"Install the Chrome/Edge extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/netsuite/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for NetSuite.

  1. Login to NetSuite.

  2. While visiting a NetSuite web page, click the quick access button to bring the dialer to the foreground.

  3. Navigate to the Settings screen in App Connect, and find the option labeled \"Netsuite\".

  4. Click the \"Connect\" button.

  5. A window will be opened prompting you to allow OAuth scopes. Allow it.

When you login successfully, the Chrome extension will automatically update to show you are connected to NetSuite. If you are connected, the button next to NetSuite will say, \"logout\".

And with that, you will be connected to NetSuite and ready to begin using the integration.

"},{"location":"crm/netsuite/#placeholder-companies-when-creating-contacts","title":"Placeholder companies when creating contacts","text":"

NetSuite requires that every contact be associated with a company. When logging calls for new contacts, App Connect will first look for a company called, \"Placeholder company.\" If a company with that name is not found, one will be created. Then the contact will be associated with that company record. It is the intent that once the call is complete that an agent do one of the following:

  1. Edit the company called \"Placeholder Company\" with a more appropriate name and with additional details.
  2. Edit the contact to associate it with a more appropriate company stored in NetSuite.

In this way, App Connect ensures that all contacts created by it conform to the requirements of NetSuite so that all contact records are complete.

"},{"location":"crm/pipedrive/","title":"Setting up App Connect for Pipedrive","text":"

Pipedrive is designed to help small businesses grow. For over ten years, Pipedrive has been committed to building the best CRM \u2013 a CRM by and for salespeople. The result is an easy-to-use, effective sales tool that centralizes your data, helping you visualize your entire sales process and win more deals.

RingCentral's integration with Pipedrive helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

"},{"location":"crm/pipedrive/#install-the-extension","title":"Install the extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/pipedrive/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for Pipedrive.

  1. Make sure you are logged in to Pipedrive.

  2. Navigate to the RingCentral App Connect in the Pipedrive Marketplace.

  3. From the marketplace listing, initiate the authorization process by clicking the \"Install Now\" button.

  4. On the authorization screen, scroll to the bottom and click \"Allow and Install.\" App Connect should automatically come to the foreground and show that you are now connected to Pipedrive.

When you login successfully, the Chrome extension will automatically update to show you are connected to Pipedrive. If you are connected, the button next to Pipedrive will say, \"logout\".

Settings once you have connected to Pipedrive

And with that, you will be connected to Pipedrive and ready to begin using the integration.

"},{"location":"crm/pipedrive/#tailoring-your-configuration","title":"Tailoring your configuration","text":"

Pipedrive's system exhibits a relatively uncommon behavior that is the result of a perfectly normal function of the frameworks used by their engineers. However, this behavior is unfortunate because it causes the dialer to be removed from the page after it has loaded. You may see it appear briefly, and then POOF! It is gone.

To address this, go our advanced settings and set the config option called \"Click-to-dial inject delay\" to 2 or 3. Depending upon network latencies, you may need to increase this number, but usually a value of 2 is sufficient.

"},{"location":"crm/redtail/","title":"Setting up App Connect for Redtail CRM","text":"

Whether you are looking to strengthen your client relationships, improve your team\u2019s collaboration efforts and overall efficiency, increase your revenues and profitability, decrease client attrition, or engage in any number of other business-building activities, Redtail CRM offers tools to assist in your efforts.

RingCentral's integration with Redtail CRM helps streamline communications between customers, and helps sales staff to better support them through their entire lifecycle by helping to manage and store communication history with customers, capture important communication metadata and more.

"},{"location":"crm/redtail/#install-the-extension","title":"Install the extension","text":"

If you have not already done so, begin by installing App Connect from the Chrome web store.

"},{"location":"crm/redtail/#setup-the-extension","title":"Setup the extension","text":"

Once the extension has been installed, follow these steps to setup and configure the extension for Redtail.

  1. Login to Redtail.

  2. While visiting a Redtail application page, click the quick access button to bring the dialer to the foreground.

  3. Navigate to the Settings screen in App Connect, and find the option labeled \"Redtail.\"

  4. Click the \"Connect\" button.

  5. A window will be opened prompting you to enter your Redtail username and password. Login to Redtail.

When you login successfully, the Chrome extension will automatically update to show you are connected to Redtail. If you are connected, the button next to Redtail will say, \"logout\".

And with that, you will be connected to Redtail and ready to begin using the integration.

"},{"location":"developers/","title":"Integrating with CRMs using the App Connect framework","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

Welcome to RingCentral's App Connect integration framework. Using this framework, developers can integrate RingCentral into their web-based CRM more easily. The framework is centered around enabling the following features common to many CRM integrations:

  • Embedded phone. Injecting a phone into the CRM for a fully-integrated communications experience.
  • Call pop. Automatically opening up a contact record when a call is received.
  • Logging calls. Capturing and storing call notes in an activity record linked to an associated contact in the CRM.

Powered by RingCentral Embeddable

App Connect's integration framework is build on top of RingCentral Embeddable, which itself provides the following capabilities via its unified communications client:

  • Make and receive phone calls.
  • Send and receive SMS.
  • Read and send team chat messages.
  • Search your RingCentral address book.
  • View a history of past calls.
  • Listen to call recordings.
  • Access and listen to voicemail.
"},{"location":"developers/#architectural-overview","title":"Architectural overview","text":"

Each CRM supported by this framework is required to implement what is referred to as an \"adapter.\" Adapters help broker communications between the client application (the dialer and primary user interface) and the CRM being integrated with.

Each adapter implements the following components:

  • A configuration file, or manifest that defines basic metadata and provides a no-code interface for defining common user interactions.
  • A server that implements a prescribed interface that is invoked by the front-end client to perform more complex interactions with the CRM.

In this guide, you will learn how to build, package and distribute an adapter for a CRM.

Get started using the framework

"},{"location":"developers/adapter/","title":"Implementing your CRM adapter","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

App Connect's developer framework comes with everything you need to build an adapter for virtually any target CRM platform. While the sample adapter that is provided through this framework is implemented in Javascript, you are free to implement your server in whatever language you prefer -- provided that it implements the interface properly. However, we recommend most developers utilize this framework directly, as it will dramatically decrease your time to market.

Every adapter contains two key files or elements:

  1. A manifest file that defines and governs app behaviors
  2. A server that the Unfied Chrome extension interfaces with to communicate with the target CRM
"},{"location":"developers/adapter/#how-the-chrome-extension-interfaces-with-an-adapter-to-talk-to-a-crm","title":"How the Chrome extension interfaces with an adapter to talk to a CRM","text":"

One can think of an adapter as nothing more than an intermediary service that is responsible for translating actions performed by a user of the Chrome extension, into API calls made to a target CRM that fulfill a user's intent. Take for example when a user logs a call:

  1. A user clicks \"Log call\" from the call history page.
  2. The user fills out a form in which they enter notes and other data related to the call.
  3. The user clicks \"Save.\"
  4. The Chrome extension then packages up the user's input, and sends it to the adapter.
  5. The adapter's server receives a request stating, \"a user wants to log a call.\"
  6. The adapter's server then calls the target CRM's API to log a call.

This basic pattern is repeated for every action the framework enables. For those who want to nerd-out on this pattern, the following sequence diagram will describe the process more thoroughly.

"},{"location":"developers/adapter/#sequence-diagram","title":"Sequence diagram","text":""},{"location":"developers/adapter/#working-examples","title":"Working examples","text":"

The framework currently contains a total of five natively supported CRMs. These adapters are useful reference implementations for developers to learn from. The following table lists these adapters and what sets them apart from one another technically:

CRM Auth type Contact type Note Clio OAuth Contact Clio API only supports exact match for contact match by phone number, so users need to use overriding formats Pipedrive OAuth Contact Pipedrive has unique auth process behind OAuth, it's not recommended to be used as OAuth reference Insightly api key Lead and Contact Insightly API only supports exact match for contact match by phone number, so users need to use overriding formats Bullhorn OAuth Candidate and Contact Bullhorn has unique auth process behind OAuth, it's not recommended to be used as OAuth reference Redtail api key (username & password) Contact None NetSuite OAuth Contact NetSuite API only supports exact match for contact match by phone number, so users need to use overriding formats"},{"location":"developers/adapter/#development-process","title":"Development process","text":"

This guide will walk you through the process of creating an adapter step-by-step. At a high-level however, developers will be expected to do the following:

  • Create a manifest file
  • Implement each of the required adapter interfaces:
    • Authorization
    • Contact lookup and matching
    • Logging, updating and looking up call logs
    • Logging SMS messages
    • Creating placeholder contacts
    • Creating a custom welcome and getting started page
    • Opening contact and activity pages in the CRM
  • Deploy your server
  • Configure the App Connect Chrome extension to load your custom adapter

Let's get started.

"},{"location":"developers/auth/","title":"Authorization and authenticating users with their CRM","text":"

App Connect's framework currently supports two different authentication modalities:

  • OAuth. This is the most common form of authentication and authorization supported by most CRMs.
  • API keys. This less common method typically requires a CRM user to retrieve an auth string, often called an \"API key,\" and saving it within the framework. This key is then transmitted with each API request to the CRM.

Start by editing the platforms object within your adapter's manifest, and setting the type property under auth to either:

  • oauth
  • apiKey
"},{"location":"developers/auth/#connecting-to-a-crm-via-oauth","title":"Connecting to a CRM via OAuth","text":"

When implementing OAuth, you will need to login to the target CRM as a developer to retrieve a client ID and client secret. Every CRM is different, so please consult the CRM's API documentation to learn how to generate these two values to uniquely identify your application that will be calling the CRM's APIs.

Once you have obtained these values, you will need to set the following values in your adapter's manifest:

Name Type Description platforms.{crmName}.auth.oauth.authUrl string The auth URL to initiate the OAuth process with the CRM. Eg. https://app.clio.com/oauth/authorize platforms.{crmName}.auth.oauth.clientId string Only used with authType equal to oauth. The client ID of the application registered with the CRM to access it's API. platforms.{crmName}.auth.oauth.redirectUri string You can use your own uri, but the default one https://ringcentral.github.io/ringcentral-embeddable/redirect.html should work in most cases. platforms.{crmName}.auth.oauth.scope string (Optional) Only if you want to specify scopes in OAuth url. eg. \"scope\":\"scopes=write,read\" platforms.{crmName}.auth.oauth.customState string (Optional) Only if you want to override state query string in OAuth url. The state query string will be state={customState} instead."},{"location":"developers/auth/#generating-an-auth-url","title":"Generating an Auth URL","text":"

The framework will compose an OAuth compliant auth URL for you by appending to the authUrl the following query string:

{authUrl}?responseType=code&client_id={clientId}&{scope}&state=platform={name}\n    &redirect_uri=https://ringcentral.github.io/ringcentral-embeddable/redirect.html\n
"},{"location":"developers/auth/#setting-the-redirect-uri","title":"Setting the redirect URI","text":"

App Connect's framework utilizes a a fixed redirect URI for OAuth. This redirect URI is: 

https://ringcentral.github.io/ringcentral-embeddable/redirect.html\n

It should suffice standard OAuth use cases. If there's any special case, please contact us.

"},{"location":"developers/auth/#implement-server-endpoints","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • getAuthType
  • getOauthInfo
  • getUserInfo
"},{"location":"developers/auth/#connecting-to-a-crm-using-an-api-key","title":"Connecting to a CRM using an API key","text":"

Some CRMs provide developers access to their API via an API key. An API key is a slightly more cumbersome connection process for users, in that they must go into a technical part of the CRM to retrieve an obscure text string. But, the App Connect framework does what it can to make the process as easy as possible for users.

To auth a user via an API key, you need to present them with a form in which they will enter all needed credentials. The user will save those values and the framework will stash them a secure database for you.

"},{"location":"developers/auth/#setup-the-auth-page-in-the-extension","title":"Setup the auth page in the extension","text":"

Sample CRM adapter

manifest.jsonRendered page 
            \"auth\": {\n                \"type\": \"apiKey\",\n                \"apiKey\": {\n                    \"page\": {\n                        \"title\": \"test CRM\",\n                        \"content\": [\n                            {\n                                \"const\": \"apiKey\",\n                                \"title\": \"apiKey\",\n                                \"type\": \"string\",\n                                \"required\": true\n                            }\n                        ]\n                    }\n                },\n

Insightly adapter

manifest.jsonRendered page 
                                    \"title\": \"5\"\n                                },\n                                {\n                                    \"const\": \"6\",\n                                    \"title\": \"6\"\n                                },\n                                {\n                                    \"const\": \"7\",\n                                    \"title\": \"7\"\n                                },\n                                {\n                                    \"const\": \"8\",\n                                    \"title\": \"8\"\n                                },\n                                {\n                                    \"const\": \"9\",\n                                    \"title\": \"9\"\n                                },\n                                {\n                                    \"const\": \"10\",\n                                    \"title\": \"10\"\n                                }\n                            ],\n                            \"required\": true\n                        },\n                        {\n                            \"const\": \"feedback\",\n                            \"title\": \"Feedback\",\n                            \"type\": \"inputField\",\n                            \"placeholder\": \"Please share your feedback...\",\n                            \"required\": true\n                        }\n                    ]\n

"},{"location":"developers/auth/#implement-server-endpoints_1","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • getAuthType
  • getOauthInfo
  • getUserInfo
"},{"location":"developers/auth/#deauthorizing-users","title":"Deauthorizing users","text":"

Just as one needs to log someone in, they need to log someone out.

"},{"location":"developers/auth/#implement-server-endpoints_2","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • unAuthorize
"},{"location":"developers/auth/#testing-your-authorization-implementation","title":"Testing your authorization implementation","text":"

Now that the necessary server endpoints have been implemented, and the manifest updated, let's test authorization.

  1. Refresh and or save the Custom CRM config url setting under the extension's options.
  2. Access the Chrome extension.
  3. Log out and log back into your CRM using the \"Connect\" button under the Settings tab, or by going through the appropriate CRM login and authorization flow for your adapter.
  4. Finally, check to see if any user info was saved in the database (CHECK.1)
"},{"location":"developers/contact-matching/","title":"Loading a contact record","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

A critical function performed by the server is looking up a contact record in the target CRM given a phone number, and returning a list of matches for that phone number. In addition, the framework will transmit a list of alternative phone number formats to search for.

Alternative phone number formats

Some CRMs expose a contact search API that is very strict with regards to phone number lookup. For example, if a CRM only supports an EXACT MATCH then searching for an E.164 phone number may not yield any results if the phone number is stored in any other format.

As a workaround, the CRM framework allows users to specify additional phone number formats that they typically store phone numbers in. This list of phone numbers is transmitted to the adapter's server, so that the associated adapter can search for a contact using multiple phone number formats until one is found.

"},{"location":"developers/contact-matching/#implement-server-endpoints","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • findContact
"},{"location":"developers/contact-matching/#test","title":"Test","text":"
  1. Create a new contact on CRM platform and make a call to it
  2. In extension, near call record, click Refresh contact to check if console prints correct results (CHECK.3)
"},{"location":"developers/contact-matching/#multiple-contact-types","title":"Multiple contact types","text":"

The framework supports multiple contact types at basic levels. Please refer to existing bullhorn or insightly code implementation and manifest for more details.

"},{"location":"developers/deploy/","title":"Build and deploy a CRM adapter","text":"

Once you have developed your adapter for a CRM, it is time to try it out. To do that, you will need to deploy your adapter's server to a publicly accessible server

"},{"location":"developers/deploy/#deploying-server-to-aws","title":"Deploying server to AWS","text":"

Technically your adapter's server could be deployed anywhere. You could host it yourself, or deploy it to a third-party like Heroku or AWS. To assist developers, we have provided a serverless config file for AWS deployment under the serverless-deploy.

  1. Customize your environment

    cd rc-unified-crm-extension/serverless-deploy\ncp sample.env.yml env.yml\n

    Then edit env.yml.

  2. Customize your serverless deploy config

    cp sample.serverless.yml serverless.yml\n

    Then edit serverless.yml

  3. Build and deploy the server

    npm run serverless-build\nnpm run serverless-deploy\n

Deploying to another platform

If you want to deploy it to other platform. Run npm run build-local and a build folder will be created for you in the build folder. You can then deploy this build folder to any other hosting provider.

"},{"location":"developers/deploy/#server-environment-variables","title":"Server environment variables","text":"Variable Description APP_SERVER URL for your backend server APP_SERVER_SECRET_KEY Key to create secret toke between your server and client TEST_CRM_CLIENT_ID If CRM uses OAuth, it should be the client ID for OAuth TEST_CRM_CLIENT_SECRET If CRM uses OAuth, it should be the client secret for OAuth TEST_CRM_ACCESS_TOKEN_URI If CRM uses OAuth, it should access token url for OAuth TEST_CRM_REDIRECT_URI You can use the default redirect URI, or change it to yours DATABASE_URL URL for your database, the default one is for local sqlite database"},{"location":"developers/errors/","title":"Returning messages to client","text":"

When implementing your adapter, you will encounter the need to provide feedback to the end user interacting with the adapter. For example you may wish to display:

  • an error message
  • a confirmation message
  • a warning

Within your adapter, you can cause App Connect to display a message to a user by returning a returnMessage construct in an given interface. Here's a quick example for create call log return in testCRM:

return {\n    logId: addLogRes.data.id,\n    returnMessage: {\n        message: 'Call log added.',\n        messageType: 'success',\n        ttl: 3000\n    }\n};\n
"},{"location":"developers/errors/#return-message-parameters","title":"Return message parameters","text":"Parameter Description message The message to display. messageType There are 3 message types: success, warning and danger. ttl The length of time to display the message (in milliseconds) before it disappears automatically."},{"location":"developers/getting-started/","title":"Getting started building a custom CRM adapter","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

Every CRM adapter requires a manifest file which provides developers a way to configure and customize the framework properly for the associated CRM. Via the adapter's manifest, developers can:

  • Provide CRM connectivity and authorization details
  • Define custom fields for:
    • call logging and disposition forms
    • SMS and messagig logging forms
  • Customize the \"Connect to CRM\" or authorization screen
  • Define custom contact record types/categories
  • Customize the welcome screen for a given CRM
"},{"location":"developers/getting-started/#clone-or-fork-the-frameworks-repository","title":"Clone or fork the framework's repository","text":"

Let's begin by downloading the framework to your development machine.

> git clone https://github.com/ringcentral/rc-unified-crm-extension.git\n> cd rc-unified-crm-extension\n

Next, copy the contents of the test CRM adapter to a new folder where your adapter will be placed.

> cp src/adapters/testCRM src/adapters/my-crm-adatper\n
"},{"location":"developers/getting-started/#setup-and-start-your-server","title":"Setup and start your server","text":"

Each adapter requires a server to be running. This server exposes a canonical API to the App Connect framework, and in a sense acts as a broker or proxy between the front-end client, and the CRM. Let's setup and start the sample server bundled with the framework.

Open up a console and within it, follow these instructions.

  1. Install the necessary prerequisites

    npm i\n

  2. Start ngrok

    npm run ngrok\n

    Make note of your personalized ngrok URL (referred as https://xxxx.ngrok.app below).

  3. Edit your server's manifest file in the rc-unified-crm-extension/server directory

    cp .env.test .env\n

    Edit .env and set APP_SERVER equal to your personalized ngrok URL above.

  4. Edit test CRM manifest file in the rc-unified-crm-extension/src/adapters/testCRM directory

    Change serverUrl in manifest.json to https://xxxx.ngrok.app

  5. Start your server from the rc-unified-crm-extension/server directory

    npm run start\n
"},{"location":"developers/getting-started/#install-and-configure-the-client","title":"Install and configure the client","text":"

Download Chrome extension from Chrome Web Store

Right click extension's icon and go to Options, change Custom CRM manifest url to the following URL:

https://xxxx.ngrok.app/crmManifest?platformName=testCRM

Click \"Save.\"

What to do if saving options doesn't work

If the option save failed, please try if you can manually open the manifest file from browser. Sometimes there's network policy that blocks web tunnel like ngrok.

Now, the extension is setup with a manifest that serves testCRM. From the manifest file we can tell that the variable okatforms.testCRM.urlIdentifier = \"*.labs.ringcentral.com/*\". Let's use https://unified-crm-extension.labs.ringcentral.com/is-alive as the test CRM homepage.

Open the extension on the page and login with your RingCentral account. Then you should be able to play with mock data and see how this extension works.

"},{"location":"developers/getting-started/#next-step-edit-your-manifest-file","title":"Next step: edit your manifest file","text":"

Fork this repo and track changes better

Under this framework, there are 1 javascript file and 1 manifest.json file that you'll need to create which are new files therefore won't prevent you from fetching the latest changes from this repo. Please don't change anything outside of that in case of conflicts in pull actions.

With this step complete, you now have a shell of an adapter in place and you are ready to begin development. Let's start by customizing your adapter's manifest file.

Implement an authorization layer

"},{"location":"developers/logging-calls/","title":"Working with call log records","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

One of the most used features across all of RingCentral's CRM integrations is the function of logging a phone call and recording a disposition associated with that phone call in the target CRM. To facilitate various user flows that relate to the logging of calls, developers need to implement three different interfaces in their server implementation.

  • Load a call log associated with a phone call
  • Create a call log record
  • Update a call log record
"},{"location":"developers/logging-calls/#implement-server-endpoints","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • createCallLog
  • getCallLog
  • updateCallLog
"},{"location":"developers/logging-calls/#test","title":"Test","text":"
  1. Make a call to a known contact
  2. Click + button near a call record to log the call
  3. Check if call log is saved on CRM platform and database (CHECK.4)
  4. Click Edit button near the call record to update the log
  5. Check if call log's subject and note are pulled correctly (CHECK.5)
  6. Edit subject and note, then click Update
  7. Check if call log is updated on CRM platform (CHECK.6)
"},{"location":"developers/logging-calls/#log-page-setup","title":"Log page setup","text":"

Please go to manifest.

"},{"location":"developers/logging-calls/#internal-call-logging","title":"Internal call logging","text":"

To enable internal call logging for extension numbers under your main number, please add enableExtensionNumberLoggingSetting under your manifest platform info. Users would need to turn on Allow extension number logging under Contacts settings. Then on server end, isExtension flag will be passed in as in src/adapters/testCRM/index.js - findContact().

"},{"location":"developers/logging-sms/","title":"Logging an SMS message or conversation","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

App Connect allows users to log in their CRM all forms of communication with a customer, which includes SMS or text messages. This interface describes how to log an SMS conversation within the target CRM.

"},{"location":"developers/logging-sms/#important-note","title":"Important note","text":"

Message logging is slightly different from call logging. Message logs could become pretty messy. This framework applies an idea to group messages together, and here is how:

Message logs are grouped per conversation per day, meaning there will be just one CRM activity for all messages that happen under the same conversation on the same day.

Therefore, the first message during the day will be logged using createMessageLog to create a new CRM activity, while the following messages are added to the existing activity using updateMessageLog. And the framework already takes care of separating the 1st message and the rest.

"},{"location":"developers/logging-sms/#implement-server-endpoints","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • createMessageLog
  • updateMessageLog
"},{"location":"developers/logging-sms/#test","title":"Test","text":"
  1. Send a SMS message to a known contact
  2. Click + button near a conversation record to log all unlogged messages under this conversation
  3. Check if message log is saved on CRM platform and database (CHECK.7)
  4. Send another SMS message to the same contact
  5. Click + button near a conversation record to log all unlogged messages under this conversation
  6. Check if message log is added to previously created log on CRM platform and as a new record in database (CHECK.8)
"},{"location":"developers/logging-sms/#tips","title":"Tips","text":"

The framework checks database to see if there's existing message log on the day. If you want to setup a scenario to test 1st message, you could delete all message log records in database.

"},{"location":"developers/logging-sms/#log-page-setup","title":"Log page setup","text":"

Please go to manifest.

"},{"location":"developers/manifest-pages/","title":"Customizing pages","text":""},{"location":"developers/manifest-pages/#customizing-the-welcome-message","title":"Customizing the welcome message","text":"

When a user installs App Connect for the first time and accesses it from their CRM, a welcome page or splash screen appears to the user. This screen can be very effective in educating the end user about how to setup and connect to the associated CRM.

Currently welcome pages are relatively simple, providing developers with the ability to direct users to two key resources under embeddedOnCrmPage.welcomePage:

  • docLink: A URL to read documentation
  • videoLink: A URL to watch a video
"},{"location":"developers/manifest-pages/#customizing-pages-within-the-client-application","title":"Customizing pages within the client application","text":"

There are a number of pages within the App Connect client application that often need to be customized in some way for the corresponding CRM. Those pages are:

  • CRM authentication page (ONLY for apiKey auth)
  • Call logging form
  • Message logging form
"},{"location":"developers/manifest-pages/#adding-custom-fields-to-logging-forms","title":"Adding custom fields to logging forms","text":"

CRMs almost always have a set of fields associated with logging an activity that are relatively unique. Consider for example Clio, a CRM used by legal professionals, in which users link calls to \"matters\" (e.g. a \"legal matter\"). Where CRMs like Insightly link calls to opportunities. To account for this, the framework makes it easy to add new custom form fields to two key forms users interact with frequently:

  • Call logging page
  • Create contact page

For each page, you will define an array of additionalFields. Each additional field element consists of the properties below.

Name Type Description const string A unique key identifying the field. title string The display name of the field. type string The data type associated with the field. contactDependent boolean Set to true if this field would change when the selected contact is changed, or false if the value is static."},{"location":"developers/manifest-pages/#custom-call-log-fields","title":"Custom call log fields","text":"

In the following example, a \"Deals\" pull-down menu with three options, and an \"Address\" text input is added to the call log form. 

                {\n                    \"id\": \"testCallLogDetails\",\n                    \"type\": \"section\",\n                    \"name\": \"Call log details\",\n                    \"items\": [\n                        {\n                            \"id\": \"addCallLogNote\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add note to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogSubject\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add subject to call log\",\n                            \"defaultValue\": true\n
"},{"location":"developers/manifest-pages/#custom-sms-log-fields","title":"Custom SMS log fields","text":"

Setup the same fields as above, but associated with the SMS logging page.

                        },\n                        {\n                            \"id\": \"addCallLogContactNumber\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add contact phone number to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDateTime\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add date and time to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDuration\",\n                            \"type\": \"boolean\",\n
"},{"location":"developers/manifest-pages/#feedback-page","title":"Feedback page","text":"

A feedback page allows you to facilitate the collection of feedback from users. When defined a feedback link will appear in App Connect for users to click. When clicked, a form will be displayed to the user prompting them for feedback. The structure and input elements of the form are configurable.

To use feedback page, please create feedback object under page. The feedback object has the following properties:

Name Type Description url string A URL that the feedback form will post data to. Query parameters can be setup. Please refer to below elements array Page and input elements that will comprise the feedback form. Please refer to below"},{"location":"developers/manifest-pages/#page-elements-and-query-parameters","title":"Page elements and query parameters","text":"

Page elements are defined as similar to log page fields above:

Name Type Description const string A unique key identifying the field. title string The display name of the field. type string The input type associated with the field. string, inputField and selection bold boolean (Only applicable for string) selections array Each element has only const and title required boolean If true, the form cannot be submitted until a value has been entered. placeholder string A placeholder value to be replaced by the user. Only applicable for inputField."},{"location":"developers/manifest-pages/#submitting-feedback-forms","title":"Submitting feedback forms","text":"

When a user submits the feedback form, the feedback will be submitted to the designated url. The URL supports a number of tokens so that you can encode user submitted form data into the URL being posted to. These tokens are as follows:

Name Is native Description crmName true Your crm platform name userName true RingCentral user name userEmail true RingCentral user email Element const value false Any custom field that you define in your feedback page

Posting to a Google Form

Posting feedback to a Google Form such that the user's input is pre-filled on the resulting Google Form page requires you to encode the Google Form URL with custom values. This is achieved through the use of tokens. For example, consider the need to construct the following URL:

https://docs.google.com/forms/d/e/:FORM_ID/viewform?\n   usp=pp_url&entry.912199227={score}&entry.912199228={crmName}\n

Prior to the form being posted to the URL, the {score} and {crmName} tokens will be replaced with their corresponding values, using user-provided data when present.

"},{"location":"developers/manifest-sample/","title":"Sample manifest file","text":"

Here is a sample manifest file that illustrates the full syntax and structure of the manifest file. 

{\n    \"serverUrl\": \"https://xxxx.ngrok.app\",\n    \"redirectUri\": \"https://ringcentral.github.io/ringcentral-embeddable/redirect.html\",\n    \"author\": {\n        \"name\": \"Test Developer\",\n        \"websiteUrl\": \"\"\n    },\n    \"platforms\": {\n        \"testCRM\": {\n            \"logoUrl\": \"https://avatars.githubusercontent.com/u/6549285?s=200&v=4\",\n            \"documentationUrl\": \"https://ringcentral.github.io/rc-unified-crm-extension\",\n            \"releaseNotesUrl\": \"https://ringcentral.github.io/rc-unified-crm-extension/release-notes/\",\n            \"getSupportUrl\": \"https://community.ringcentral.com/topic/new?fid=22\",\n            \"writeReviewUrl\": \"https://chromewebstore.google.com/detail/ringcentral-crm-extension/kkhkjhafgdlihndcbnebljipgkandkhh/reviews\",\n            \"urlIdentifier\": \"*.labs.ringcentral.com/*\",\n            \"name\": \"testCRM\",\n            \"displayName\": \"Test CRM\",\n            \"enableExtensionNumberLoggingSetting\": true,\n            \"requestConfig\": {\n                \"timeout\": 30\n            },\n            \"auth\": {\n                \"type\": \"apiKey\",\n                \"apiKey\": {\n                    \"page\": {\n                        \"title\": \"test CRM\",\n                        \"content\": [\n                            {\n                                \"const\": \"apiKey\",\n                                \"title\": \"apiKey\",\n                                \"type\": \"string\",\n                                \"required\": true\n                            }\n                        ]\n                    }\n                },\n                \"oauth\": {\n                    \"authUrl\": \"\",\n                    \"clientId\": \"\",\n                    \"redirectUri\": \"https://ringcentral.github.io/ringcentral-embeddable/redirect.html\",\n                    \"customState\": \"\",\n                    \"scope\": \"\"\n                }\n            },\n            \"canOpenLogPage\": false,\n            \"contactTypes\": [\n                {\n                    \"display\": \"TestContactType\",\n                    \"value\": \"testContact\"\n                },\n                {\n                    \"display\": \"Contact\",\n                    \"value\": \"cta\"\n                }\n            ],\n            \"embeddedOnCrmPage\": {\n                \"welcomePage\": {\n                    \"docLink\": \"https://ringcentral.github.io/rc-unified-crm-extension/\",\n                    \"videoLink\": \"https://youtu.be/pQgdsAR1UCI\"\n                }\n            },\n            \"settings\": [\n                {\n                    \"id\": \"testCallLogDetails\",\n                    \"type\": \"section\",\n                    \"name\": \"Call log details\",\n                    \"items\": [\n                        {\n                            \"id\": \"addCallLogNote\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add note to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogSubject\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add subject to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogContactNumber\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add contact phone number to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDateTime\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add date and time to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDuration\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add duration to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogResult\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add call result to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogRecording\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add recording link to call log\",\n                            \"defaultValue\": true\n                        }\n                    ]\n                }\n            ],\n            \"page\": {\n                \"callLog\": {\n                    \"additionalFields\": [\n                        {\n                            \"const\": \"associatedDeal\",\n                            \"title\": \"Deals\",\n                            \"type\": \"selection\",\n                            \"contactDependent\": true\n                        },\n                        {\n                            \"const\": \"address\",\n                            \"title\": \"Address\",\n                            \"type\": \"inputField\",\n                            \"contactDependent\": false\n                        }\n                    ]\n                },\n                \"messageLog\": {\n                    \"additionalFields\": [\n                        {\n                            \"const\": \"associatedDeal\",\n                            \"title\": \"Deals\",\n                            \"type\": \"selection\",\n                            \"contactDependent\": true\n                        },\n                        {\n                            \"const\": \"address\",\n                            \"title\": \"Address\",\n                            \"type\": \"inputField\",\n                            \"contactDependent\": false\n                        }\n                    ]\n                }\n            },\n            \"rcAdditionalSubmission\": [\n                {\n                    \"id\": \"departmentName\",\n                    \"path\": \"cachedData.extensionInfo.contact.department\"\n                }\n            ]\n        }\n    },\n    \"version\": \"1.3.3\"\n}\n
"},{"location":"developers/manifest/","title":"Configuring your adapter's manifest","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

An adapter's manifest file helps a developer to instruct the framework on how to interface with your adapter. It enables developers to customize the user interface within certain boundaries, enables authentication and connectivity with the target CRM and more.

Below you will find an explanation of the many properties found within a manifest file.

"},{"location":"developers/manifest/#turn-on-developer-mode","title":"Turn on developer mode","text":"

To use a custom manifest, we'll need to turn on developer mode and assign a custom manifest url to the extension. Here's how:

  1. Open DevTools
  2. In console, execute window.postMessage({type: 'toggle-developer-mode', toggle: true}) and reload the extension
  3. In user settings, there's a section for Developer settings. Input your custom manifest url and save
  4. Reload the extension to make it work
"},{"location":"developers/manifest/#basic-properties","title":"Basic properties","text":"

These basic properties

Name Type Description author string The author of the adapter. This is displayed to end users within the Chrome extension. platforms ARRAY of object An array of platforms being integrated with. Each element of this array defines a different CRM. serverUrl string The base URL the Chrome extension will used when composing requests to your adapter. The URL should utilize HTTPS and should omit the trailing slash (/). For example: https://my-adapter.myserver.com version string The version of your adapter. This is displayed to end users within the Chrome extension."},{"location":"developers/manifest/#platform-configuration","title":"Platform configuration","text":"

Each manifest file contains an array of platform objects. This is helpful for developers who manage multiple CRM adapters from the same server.

The platforms property is an associative array. Each key should be a unique identifier for the crm. The value of each element is an object with the following properties.

Name Type Description name string The name of the CRM. displayName string The display name of the CRM. urlIdentifier string The URL for which this CRM will be enabled. When the CRM is enabled for a domain, the extension's orange quick access button will appear. (* for wildcard match is supported) auth object Contains all info for authorization. Details canOpenLogPage boolean Set to true if the corresponding CRM supports permalinks for a given activity/log. When set to true users will have the option view/open the activity log in the CRM from the call history page. When set to false, users will open the contact page instead. contactTypes ARRAY of object (Optional) CRMs often adopt unique vernaculars to describe contacts. Provide the enumerated list of contact types supported by the corresponding CRM. Each object has display and value. contactPageUrl string A format string to open a CRM's contact page, e.g.https://{hostname}/person/{contactId}. Supported parameters: {hostname}, {contactId}, {contactType} embeddedOnCrmPage object The rendering config for embedded page, explained here logPageUrl string A format string to open CRM log page. Eg.https://{hostname}/activity/{logId}. Supported parameters: {hostname}, {logId}, {contactType} page object The rendering config for all pages, explained here requestConfig object Contains http request config for client extension, including timeout (number in seconds)

The client-side authorization url that is opened by the extension will be: {authUrl}?responseType=code&client_id={clientId}&{scope}&state=platform={name}&redirect_uri=https://ringcentral.github.io/ringcentral-embeddable/redirect.html

"},{"location":"developers/manifest/#authorization","title":"Authorization","text":"

platform has auth object which has following parameters:

Name Type Description type string The authorization mode utilized by the target CRM. Only two values are supported: oauth and apiKey. Setting up auth is covered in more detail in the Authorization section. oauth object Only used with type equal to oauth. It contains authUrl, clientId and redirectUri. apiKey object Only used with type equal to apiKey. It contains page"},{"location":"developers/manifest/#oauth-parameters","title":"oauth parameters","text":"Name Type Description authUrl string Only used with authType equal to oauth. The auth URL to initiate the OAuth process with the CRM. clientId string Only used with authType equal to oauth. The client ID of the application registered with the CRM to access it's API. redirectUri string The Redirect URI used when logging into RingCentral (not the CRM). It's recommended to use the default value of https://ringcentral.github.io/ringcentral-embeddable/redirect.html. customState string (Optional) Only if you want to override state query string in OAuth url. The state query string will be state={customState} instead. scope string (Optional) Only if you want to specify scopes in OAuth url. eg. \"scope\":\"scopes=write,read\""},{"location":"developers/manifest/#customizing-pages-within-the-client-application","title":"Customizing pages within the client application","text":"

There are a number of pages within the App Connect client application that often need to be customized in some way for the corresponding CRM. Those pages are:

  • CRM authentication page (ONLY for apiKey auth)
  • Call logging form
  • Message logging form
"},{"location":"developers/manifest/#apikey-auth-page","title":"apiKey auth page","text":"Sample adapterInsightly adapter 
            \"auth\": {\n                \"type\": \"apiKey\",\n                \"apiKey\": {\n                    \"page\": {\n                        \"title\": \"test CRM\",\n                        \"content\": [\n                            {\n                                \"const\": \"apiKey\",\n                                \"title\": \"apiKey\",\n                                \"type\": \"string\",\n                                \"required\": true\n                            }\n                        ]\n                    }\n                },\n
                                    \"title\": \"5\"\n                                },\n                                {\n                                    \"const\": \"6\",\n                                    \"title\": \"6\"\n                                },\n                                {\n                                    \"const\": \"7\",\n                                    \"title\": \"7\"\n                                },\n                                {\n                                    \"const\": \"8\",\n                                    \"title\": \"8\"\n                                },\n                                {\n                                    \"const\": \"9\",\n                                    \"title\": \"9\"\n                                },\n                                {\n                                    \"const\": \"10\",\n                                    \"title\": \"10\"\n                                }\n                            ],\n                            \"required\": true\n                        },\n                        {\n                            \"const\": \"feedback\",\n                            \"title\": \"Feedback\",\n                            \"type\": \"inputField\",\n                            \"placeholder\": \"Please share your feedback...\",\n                            \"required\": true\n                        }\n
"},{"location":"developers/manifest/#adding-custom-fields-to-logging-forms","title":"Adding custom fields to logging forms","text":"

CRMs almost always have a set of fields associated with logging an activity that are relatively unique. Consider for example Clio, a CRM used by legal professionals, in which users link calls to \"matters\" (e.g. a \"legal matter\"). Where CRMs like Insightly link calls to opportunities. To account for this, the framework makes it easy to add new custom form fields to two key forms users interact with frequently:

  • Call logging page
  • Create contact page

For each page, you will define an array of additionalFields. Each additional field element consists of the properties below.

Name Type Description const string A unique key identifying the field. title string The display name of the field. type string The data type associated with the field. contactDependent boolean Set to true if this field would change when the selected contact is changed, or false if the value is static."},{"location":"developers/manifest/#custom-call-log-fields","title":"Custom call log fields","text":"

Set up associated deals as dropdown options:

  1. Christmas special A351
  2. Easter A22
  3. Anniversary C92

And then setup \"Address\" as free input field.

            \"settings\": [\n                {\n                    \"id\": \"testCallLogDetails\",\n                    \"type\": \"section\",\n                    \"name\": \"Call log details\",\n                    \"items\": [\n                        {\n                            \"id\": \"addCallLogNote\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add note to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogSubject\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add subject to call log\",\n                            \"defaultValue\": true\n
"},{"location":"developers/manifest/#custom-sms-log-fields","title":"Custom SMS log fields","text":"

Set up associated deals the same as call log

                        },\n                        {\n                            \"id\": \"addCallLogContactNumber\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add contact phone number to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDateTime\",\n                            \"type\": \"boolean\",\n                            \"name\": \"Add date and time to call log\",\n                            \"defaultValue\": true\n                        },\n                        {\n                            \"id\": \"addCallLogDuration\",\n                            \"type\": \"boolean\",\n
"},{"location":"developers/manifest/#customizing-the-welcome-message","title":"Customizing the welcome message","text":"

When a user installs App Connect for the first time and accesses it from their CRM, a welcome page or splash screen appears to the user. This screen can be very effective in educating the end user about how to setup and connect to the associated CRM.

Currently welcome pages are relatively simple, providing developers with the ability to direct users to two key resources under embeddedOnCrmPage.welcomePage:

  • docLink: A URL to read documentation
  • videoLink: A URL to watch a video
"},{"location":"developers/manifest/#user-settings-for-default-log-form-values","title":"User settings for default log form values","text":"

This topic is closely related to the use of auto log. For manual log cases, using Bullhorn as example, users would need to manually select one of the Note action codes. In auto log scenarios, the extension would refuse to auto log because it misses selection for Note action code value. Now, default log form values would be able to help. It has 4 cases: inbound call, outbound call, message and voicemail where we can predefine default values.

Here's the example from Bullhorn. In settings, we want to add a new custom setting, and on log page render, we want to link the default values from user settings.

{\n    \"settings\": \n        [\n            {\n                \"id\": \"bullhornDefaultNoteAction\",\n                \"type\": \"section\",\n                \"name\": \"Bullhorn options\",\n                \"items\": [\n                    {\n                        \"id\": \"noteActionMatchWarning\",\n                        \"name\": \"Info: note action matching warning\",\n                        \"type\": \"warning\",\n                        \"value\": \"Note action value match ignores cases and spaces\"\n                    },\n                    {\n                        \"id\": \"bullhornInboundCallNoteAction\",\n                        \"type\": \"inputField\",\n                        \"name\": \"Default action for inbound calls\",\n                        \"placeholder\": \"Enter action value\"\n                    },\n                    {\n                        \"id\": \"bullhornOutboundCallNoteAction\",\n                        \"type\": \"inputField\",\n                        \"name\": \"Default action for outbound calls\",\n                        \"placeholder\": \"Enter action value\"\n                    },\n                    {\n                        \"id\": \"bullhornMessageNoteAction\",\n                        \"type\": \"inputField\",\n                        \"name\": \"Default action for SMS\",\n                        \"placeholder\": \"Enter action value\"\n                    },\n                    {\n                        \"id\": \"bullhornVoicemailNoteAction\",\n                        \"type\": \"inputField\",\n                        \"name\": \"Default action for voicemails\",\n                        \"placeholder\": \"Enter action value\"\n                    }\n                ]\n            }\n        ]\n}\n

Page fields need to be set to use default values mapped from user settings. 

{\n    \"page\": {\n        \"callLog\": {\n            \"additionalFields\": [\n                {\n                    \"const\": \"noteActions\",\n                    \"title\": \"Note action\",\n                    \"type\": \"selection\",\n                    \"contactDependent\": false,\n                    \"defaultSettingId\": \"bullhornDefaultNoteAction\",\n                    \"defaultSettingValues\": {\n                        \"inboundCall\": {\n                            \"settingId\": \"bullhornInboundCallNoteAction\"\n                        },\n                        \"outboundCall\": {\n                            \"settingId\": \"bullhornOutboundCallNoteAction\"\n                        }\n                    }\n                }\n            ]\n        },\n        \"messageLog\": {\n            \"additionalFields\": [\n                {\n                    \"const\": \"noteActions\",\n                    \"title\": \"Note action\",\n                    \"type\": \"selection\",\n                    \"contactDependent\": false,\n                    \"defaultSettingId\": \"bullhornDefaultNoteAction\",\n                    \"defaultSettingValues\": {\n                        \"message\": {\n                            \"settingId\": \"bullhornMessageNoteAction\"\n                        },\n                        \"voicemail\": {\n                            \"settingId\": \"bullhornVoicemailNoteAction\"\n                        }\n                    }\n                }\n            ]\n        }\n    }\n}\n
"},{"location":"developers/placeholder-contacts/","title":"Creating a placeholder contact","text":"

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

In the event that no contact could be found with an associated phone number, then the client application will prompt a user to create a placeholder contact.

In the framework's logic, contact creation is coupled with call/message logging. It'll only be used in one case: logging a call/message against an unknown contact. Therefore, it can be described as:

logging against an unknown contact = create a placeholder contact + logging against it

"},{"location":"developers/placeholder-contacts/#implement-server-endpoints","title":"Implement server endpoints","text":"

Within your adapter's index.js file, implement the following methods.

  • createContact
"},{"location":"developers/placeholder-contacts/#test","title":"Test","text":"
  1. Make a call to an uknown contact
  2. Click + button near a call record to log the call
  3. Check if the contact is created on CRM platform (CHECK.9)
  4. Check if call log is saved on CRM platform and database (CHECK.9)
"},{"location":"developers/proprietary-crm/","title":"Integrating with a proprietary CRM","text":"

The App Connect framework from RingCentral can be used to build an integration with any CRM, even a home-grown or proprietary one. If you are seeking to build an adapter for a home-grown CRM, here is a check list to see if what you have built is compatible with this framework.

"},{"location":"developers/proprietary-crm/#compatibility-checklist-for-proprietary-crms","title":"Compatibility checklist for proprietary CRMs","text":"

OAuth 2.0 support

Ideally, your proprietary CRM supports the OAuth 2.0 authorization protocol. From the perspective of building the adapter, this will by far be the easiest most turn-key way to connect the App Connect client application to your CRM.

Technically, the framework can be made to work with alternative authentication mechanisms, like API keys and other tokenized methods. However, there is no guarantee such mechanisms will work out of the box.

A similar API is needed to log a user out. This API would effectively invalidate an access key so that it cannot be used again.

API to create a call log, note or activity record

Every CRM has its own unique vernacular, but at the end of the day the core function of an adapter is to facilitate the process of recording communications in the CRM in question. To do that, the CRM needs an API that allows the adapter to store in the CRM's database a record of a phone call or SMS message.

A similar API will be needed for fetching, and editing/updating call logs as well.

API to lookup associations with a phone number

To execute a call pop, which describes the process of opening a web page or fetching information about the person or contact one is calling or receiving a call from, the CRM needs an API that can receive as input a phone number, and return information about the person corresponding to that phone number.

Ideally, that API will take as input a phone number in E.164 format but search the CRM for phone numbers stored in any other format. The stricter the search syntax is for phone numbers, the less reliably contacts/associations will be found when a search is conducted.

API to create a contact

When a call is received for which no association or contact exists, users are given the opportunity to create a contact record to associate the activity record with. To facilitate this user flow, an API must exist that allows a contact to be created and associated with a given phone number.

API to fetch the name of the currently logged in user

Finally, in order to show users that they have connected to the CRM successfully, an API needs to exist that returns the current user's name, and validates that the access key or API key used to authenticate with the CRM is valid.

"},{"location":"developers/proprietary-crm/#server-recommendations","title":"Server recommendations","text":"

Technically, an adapter's server could be implemented in any language. However, the fastest and easiest way to implement an adapter's server is using our pre-made Javascript adapter server framework.

"},{"location":"developers/view-details/","title":"View contact and log details","text":"

For a matched contact or a logged call, the extension supports to open the corresponding page on CRM.

To configure this feature, there are several fields to setup in manifest.json.

Name Type Description canOpenLogPage boolean Set to true if the corresponding CRM supports permalinks for a given activity/log. When set to true users will have the option view/open the activity log in the CRM from the call history page. When set to false, users will open the contact page instead. contactPageUrl string A format string to open CRM contact page. Eg.https://{hostname}/person/{contactId}. Supported parameters: {hostname}, {contactId}, {contactType} logPageUrl string A format string to open CRM log page. Eg.https://{hostname}/activity/{logId}. Supported parameters: {hostname}, {logId}, {contactType}"},{"location":"developers/welcome-page/","title":"Customized welcome page","text":"

When user opens CRM page for the first time after installing the extension, it'll show welcome page in a modal dialog.

Configure this feature under manifest.json, under embeddedOnCrmPage and then welcomePage, there are:

  • docLink: A URL to read documentation
  • videoLink: A URL to watch a video
"},{"location":"developers/advanced/openapi/","title":"Building a custom adapter server","text":"

This developer guide is optimized and intended for Javascript developers who are implementing new adapters using the server that comes bundled with the framework. Using this built in server can save developers a ton of time because it abstracts developers away from the underlying protocol used by the Chrome extension to talk to an adapter.

If you would like to build your own server framework, perhaps because you personally prefer a programming language other than Javascript, you are welcome to. To implement your own server, you will need to fully implement the OpenAPI specification below.

"},{"location":"developers/advanced/openapi/#jwt-tokens","title":"JWT tokens","text":"

The frontend client helps to maintain a user's current authentication context, and transmits to the server with every API call a jwtToken parameter that encodes the data associated with the user making the current request. A JWT token, once decoded looks like this:

{\n  id: \"<User ID in CRM>\",\n  platform: \"<the CRM being integrated with>\"\n}\n

With this information, server can validate and identify users so to perform API actions under their accounts on CRM platforms.

"},{"location":"developers/advanced/openapi/#decoding-jwt-tokens","title":"Decoding JWT tokens","text":"

The JWT token created by the framework uses the APP_SERVER_SECRET_KEY environment variable as the secret to encode the token. To decode a token, we recommend using a third party library accordingly.

Javascript 
const { verify } = require('jsonwebtoken');\nfunction decodeJwt(token) {\n  try {\n    return verify(token, process.env.APP_SERVER_SECRET_KEY);\n  } catch (e) {\n    return null;\n  }\n}\n
"},{"location":"developers/advanced/openapi/#adapter-server-openapi-specification","title":"Adapter Server OpenAPI specification","text":"

The OpenAPI specification below defines the interfaces that a developer must implement when creating an adapter for App Connect. Once implemented, your adapter's manifest file will specify the serverURL for your adapter's server that has implemented the interfaces defined by the OpenAPI specification below.

As a user uses the Chrome extension, when a CRM-specific function is engaged, the Chrome extension will compose a request the corresponding adapter's endpoint implemented by that adapter's server. The server will perform the corresponding action in the associated CRM, and return results in a prescribed format so the Chrome extension can display the results of the user's action.

Download OpenAPI spec

"},{"location":"developers/interfaces/createCallLog/","title":"addCallLog","text":"

This interface is responsible for creating a new call log record in the associated CRM. The call must be associated with the contact passed in as a request parameter. Other associations may be made depending upon the CRM and the adapter.

"},{"location":"developers/interfaces/createCallLog/#input-parameters","title":"Input parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface. contactInfo An associative array describing the contact a call is associated with. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM. callLog All the metadata associated with the call to be logged. Call Log schema is described in our API Reference. note The notes saved by the user during and/or after the call. additionalSubmission All of the additional custom fields defined in the manifest and submitted by the user. timezoneOffset The timezone offset of the current user in the event you need to use UTC when calling the CRM's API."},{"location":"developers/interfaces/createCallLog/#contact-info","title":"Contact Info","text":"
{ \n  id: \"<string\">,\n  type: \"<string>\", \n  phoneNumber: \"<E.164 Phone Number>\",\n  name: \"<string>\"\n}\n
"},{"location":"developers/interfaces/createCallLog/#return-values","title":"Return value(s)","text":"

An object with following properties:

Parameter Description logId ID of the log entry created within the CRM returnMessage message, messageType and ttl

Example 

  return {\n    logId: \"xxx-xxxxx\", // ID of log entity on CRM platform\n    returnMessage:{\n      message: 'Call logged',\n      messageType: 'success', // 'success', 'warning' or 'danger'\n      ttl: 30000 // in miliseconds\n    }\n  }\n

"},{"location":"developers/interfaces/createCallLog/#reference","title":"Reference","text":"Example CRMPipedrive 
    };  //[{id, name, phone, additionalInfo}]\n}\n\n// - contactInfo: { id, type, phoneNumber, name }\n// - callLog: same as in https://developers.ringcentral.com/api-reference/Call-Log/readUserCallRecord\n// - note: note submitted by user\n// - additionalSubmission: all additional fields that are setup in manifest under call log page\nasync function createCallLog({ user, contactInfo, authHeader, callLog, note, additionalSubmission }) {\n    // ------------------------------------\n    // ---TODO.4: Implement call logging---\n    // ------------------------------------\n\n    // const postBody = {\n    //     subject: callLog.customSubject ?? `[Call] ${callLog.direction} Call ${callLog.direction === 'Outbound' ? 'to' : 'from'} ${contactInfo.name} [${contactInfo.phone}]`,\n    //     body: `\\nContact Number: ${contactInfo.phoneNumber}\\nCall Result: ${callLog.result}\\nNote: ${note}${callLog.recording ? `\\n[Call recording link] ${callLog.recording.link}` : ''}\\n\\n--- Created via RingCentral App Connect`,\n    //     type: 'PhoneCommunication',\n    //     received_at: moment(callLog.startTime).toISOString()\n    // }\n    // const addLogRes = await axios.post(\n    //     `https://api.crm.com/activity`,\n    //     postBody,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n    console.log(`adding call log... \\n${JSON.stringify(callLog, null, 2)}`);\n    console.log(`with note... \\n${note}`);\n    console.log(`with additional info... \\n${JSON.stringify(additionalSubmission, null, 2)}`);\n    mockCallLog = {\n        id: 'testCallLogId',\n        subject: callLog.customSubject,\n        note,\n        contactName: contactInfo.name\n    }\n    const addLogRes = {\n        data: {\n            id: mockCallLog.id\n        }\n    }\n    //----------------------------------------------------------------------------\n    //---CHECK.4: Open db.sqlite and CRM website to check if call log is saved ---\n    //----------------------------------------------------------------------------\n    return {\n        logId: addLogRes.data.id,\n
        returnMessage: {\n            message: `New contact created.`,\n            messageType: 'success',\n            ttl: 3000\n        }\n    }\n}\n\nasync function createCallLog({ user, contactInfo, authHeader, callLog, note, additionalSubmission }) {\n    const dealId = additionalSubmission ? additionalSubmission.deals : '';\n    const personResponse = await axios.get(`https://${user.hostname}/v1/persons/${contactInfo.id}`, { headers: { 'Authorization': authHeader } });\n    const orgId = personResponse.data.data.org_id?.value ?? '';\n    const timeUtc = moment(callLog.startTime).utcOffset(0).format('HH:mm')\n    const dateUtc = moment(callLog.startTime).utcOffset(0).format('YYYY-MM-DD');\n    let noteBody = '<b>Agent notes</b>';;\n    if (user.userSettings?.addCallLogNote?.value ?? true) { noteBody = upsertCallAgentNote({ body: noteBody, note }); }\n    noteBody += '<b>Call details</b><ul>';\n    if (user.userSettings?.addCallLogContactNumber?.value ?? true) { noteBody = upsertContactPhoneNumber({ body: noteBody, phoneNumber: contactInfo.phoneNumber, direction: callLog.direction }); }\n    if (user.userSettings?.addCallLogDateTime?.value ?? true) { noteBody = upsertCallDateTime({ body: noteBody, startTime: callLog.startTime, timezoneOffset: user.timezoneOffset }); }\n    if (user.userSettings?.addCallLogDuration?.value ?? true) { noteBody = upsertCallDuration({ body: noteBody, duration: callLog.duration }); }\n    if (user.userSettings?.addCallLogResult?.value ?? true) { noteBody = upsertCallResult({ body: noteBody, result: callLog.result }); }\n    if (!!callLog.recording?.link && (user.userSettings?.addCallLogRecording?.value ?? true)) { noteBody = upsertCallRecording({ body: noteBody, recordingLink: callLog.recording.link }); }\n    noteBody += '</ul>';\n    const postBody = {\n        user_id: user.id,\n        subject: callLog.customSubject ?? `${callLog.direction} Call ${callLog.direction === 'Outbound' ? 'to' : 'from'} ${contactInfo.name}`,\n        duration: callLog.duration,    // secs\n        person_id: contactInfo.id,\n        org_id: orgId,\n        deal_id: dealId,\n        note: noteBody,\n        done: true,\n        due_date: dateUtc,\n
"},{"location":"developers/interfaces/createCallLog/#example-call-log-schema","title":"Example Call Log Schema","text":"
{\n  \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AvJPtwNQbNQA?view=Detailed\",\n  \"id\" : \"X2AvJPtwNQbNQA\",\n  \"sessionId\" : \"4503991004\",\n  \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n  \"startTime\" : \"2018-09-11T13:24:09.000Z\",\n  \"duration\" : 7,\n  \"type\" : \"Voice\",\n  \"direction\" : \"Inbound\",\n  \"action\" : \"Phone Call\",\n  \"result\" : \"Accepted\",\n  \"to\" : {\n    \"phoneNumber\" : \"+18662019834\",\n    \"name\" : \"Jane Smith\"\n  },\n  \"from\" : {\n    \"phoneNumber\" : \"+16504445566\",\n    \"name\" : \"John Smith\",\n    \"location\" : \"Palo Alto, CA\"\n  },\n  \"extension\" : {\n    \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n    \"id\" : 1477535004\n  },\n  \"transport\" : \"PSTN\",\n  \"lastModifiedTime\" : \"2018-09-11T13:24:12.003Z\",\n  \"billing\" : {\n    \"costIncluded\" : 0.000,\n    \"costPurchased\" : 0.000\n  },\n  \"legs\" : [ {\n    \"startTime\" : \"2018-09-11T13:24:09.000Z\",\n    \"duration\" : 7,\n    \"type\" : \"Voice\",\n    \"direction\" : \"Inbound\",\n    \"action\" : \"Phone Call\",\n    \"result\" : \"Accepted\",\n    \"to\" : {\n      \"phoneNumber\" : \"+18662019834\",\n      \"name\" : \"Jane Smith\"\n    },\n    \"from\" : {\n      \"phoneNumber\" : \"+16504445566\",\n      \"name\" : \"John Smith\",\n      \"location\" : \"Palo Alto, CA\"\n    },\n    \"extension\" : {\n      \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n      \"id\" : 1477535004\n    },\n    \"transport\" : \"PSTN\",\n    \"legType\" : \"Accept\",\n    \"master\" : true\n  } ]\n}\n
"},{"location":"developers/interfaces/createContact/","title":"createContact","text":"

This interface is invoked whenever a new contact needs to be created in the target CRM. This happens when a user of App Connect has elected to create a \"placeholder contact.\"

This function is to create a placeholder contact, ONLY in the following case: * User adds a new call/message log against a number with no matched contact. In another words, create placeholder contact is tied to call/message logging action

"},{"location":"developers/interfaces/createContact/#manifest-elements","title":"Manifest elements","text":"

Every CRM can define a different set of contact types, or data elements that can be associated with an activity (call or SMS) log. Within the platforms.[crm name] section of your manifest, provide the list of contact types supported by the target CRM.

..snip..\n\"contactTypes\": [\n  {\n    \"display\": \"TestContactType\",\n    \"value\": \"testContact\"\n  },\n  {\n    \"display\": \"Contact\",\n    \"value\": \"cta\"\n  }\n],\n..snip..\n
"},{"location":"developers/interfaces/createContact/#request-parameters","title":"Request parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM. phoneNumber The phone number of the contact in E.164 format, e.g. +1231231234. newContactName The name of the contact as entered by the user. newContactType The contact type the user selected to indicate what kind of contact to create."},{"location":"developers/interfaces/createContact/#return-values","title":"Return value(s)","text":"

This interface returns a single object. That object describes the contact that was created. It has following properties:

Parameter Description contactInfo Contain id and name returnMessage message, messageType and ttl

Example

{\n  contactInfo:{\n    id: \"xxxx-xxxxx\", // ID of the contact in the target \n    name: \"John Doe\" // Display name of the contact. This name will appear and be associated with all users with the same `phoneNumber`.\n  },\n  returnMessage:{\n    message: 'Contact created',\n    messageType: 'success', // 'success', 'warning' or 'danger'\n    ttl: 30000 // in miliseconds\n  }\n}\n
"},{"location":"developers/interfaces/createContact/#reference","title":"Reference","text":"Example CRMPipedrive 
    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n    console.log(`update message log with... \\n\\n${JSON.stringify(message, null, 2)}`);\n\n    //---------------------------------------------------------------------------------------------------------------------------------------------\n    //---CHECK.8: For multiple messages or additional message during the day, open db.sqlite and CRM website to check if message logs are saved ---\n    //---------------------------------------------------------------------------------------------------------------------------------------------\n}\n\nasync function createContact({ user, authHeader, phoneNumber, newContactName, newContactType }) {\n    // ----------------------------------------\n    // ---TODO.9: Implement contact creation---\n    // ----------------------------------------\n\n    const postBody = {\n        name: newContactName,\n        type: newContactType,\n        phone_numbers: [\n            {\n                name: \"Work\",\n                number: phoneNumber,\n                default_number: true\n            }\n        ]\n    }\n    // const contactInfoRes = await axios.post(\n    //     `https://api.crm.com/contacts`,\n    //     postBody,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     }\n    // );\n    mockContact = {\n        id: 'testContactId',\n        name: newContactName,\n        type: newContactType,\n        phone: phoneNumber,\n        additionalInfo: {\n            associatedDeal: [\n                {\n                    const: 'csA351',\n                    title: 'Christmas special A351'\n                },\n                {\n                    const: 'eA22',\n                    title: 'Easter A22'\n                },\n                {\n                    const: 'aC92',\n                    title: 'Anniversary C92'\n                }\n            ],\n            address: ''\n        }\n    }\n\n    const contactInfoRes = {\n        data: {\n            id: mockContact.id,\n            name: mockContact.name\n        }\n    }\n\n    //--------------------------------------------------------------------------------\n    //---CHECK.9: In extension, try create a new contact against an unknown number ---\n    //--------------------------------------------------------------------------------\n    return {\n        contactInfo: {\n
        name: rawContactInfo.name,\n        phone: rawContactInfo.phones[0],\n        organization: rawContactInfo.organization?.name ?? '',\n        additionalInfo: relatedDeals ? { deals: relatedDeals } : null\n\n    }\n}\n\nasync function createContact({ user, authHeader, phoneNumber, newContactName }) {\n    const postBody = {\n        name: newContactName,\n        phone: phoneNumber\n    }\n    const createContactRes = await axios.post(\n        `https://${user.hostname}/v1/persons`,\n        postBody,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n    return {\n        contactInfo: {\n            id: createContactRes.data.data.id,\n            name: createContactRes.data.data.name\n
"},{"location":"developers/interfaces/createMessageLog/","title":"addMessageLog","text":"

This interface is responsible for creating a new messaging log record in the associated CRM. The message or messages must be associated with the contact passed in as a request parameter. Other associations may be made depending upon the CRM and the adapter. This interface is always invoked for a single SMS message.

"},{"location":"developers/interfaces/createMessageLog/#creating-daily-digests-of-an-sms-conversation","title":"Creating daily digests of an SMS conversation","text":"

To prevent SMS conversations with a customer from overwhelming the CRM with a multitude of log entries for each SMS message, App Connect creates a daily digest for each SMS conversation with a customer into which all SMS messages for a 24 hour period are aggregated.

Therefore, this interface is only invoked when the daily digest is created. The updateMessageLog interface is invoked for all subsequent SMS messages in that 24 hour period.

"},{"location":"developers/interfaces/createMessageLog/#input-parameters","title":"Input parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface. contactInfo An associative array describing the contact a call is associated with. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM. message All the metadata associated with the message to be logged. SMS message schema is described in our API Reference. additionalSubmission All of the additional custom fields defined in the manifest and submitted by the user. recordingLink If the call was a voicemail, then this field will contain a link to the voicemail. timezoneOffset The timezone offset of the current user in the event you need to use UTC when calling the CRM's API."},{"location":"developers/interfaces/createMessageLog/#message","title":"message","text":"
{\n  \"uri\" : \"https://platform.ringcentral.com/restapi/xxxxxxx/message-store/60279564004\",\n  \"id\" : 60279564004,\n  \"to\" : [ {\n    \"phoneNumber\" : \"+16505553204\",\n    \"location\" : \"San Mateo, CA\"\n  } ],\n  \"from\" : {\n    \"phoneNumber\" : \"+18885550052\"\n  },\n  \"type\" : \"SMS\",\n  \"creationTime\" : \"2015-02-18T13:24:50.000Z\",\n  \"readStatus\" : \"Read\",\n  \"priority\" : \"Normal\",\n  \"attachments\" : [ {\n    \"id\" : 60279564004,\n    \"uri\" : \"https://media.ringcentral.com/restapi/xxxxxxxxxxxx/content/60279564004\",\n    \"type\" : \"Text\",\n    \"contentType\" : \"text/plain\"\n  } ],\n  \"direction\" : \"Outbound\",\n  \"availability\" : \"Alive\",\n  \"subject\" : \"Flight information\",\n  \"messageStatus\" : \"Sent\",\n  \"smsSendingAttemptsCount\" : 1,\n  \"conversationId\" : 5578984350117917661,\n  \"lastModifiedTime\" : \"2015-02-18T13:24:50.300Z\"\n}\n
"},{"location":"developers/interfaces/createMessageLog/#return-values","title":"Return value(s)","text":"

An object with following properties:

Parameter Description logId ID of the log entry created within the CRM returnMessage message, messageType and ttl

Example 

  return {\n    logId: \"xxxx-xxx\", // ID of log entity on CRM platform\n    returnMessage:{\n      message: 'Logged',\n      messageType: 'success', // 'success', 'warning' or 'danger'\n      ttl: 30000 // in miliseconds\n    }\n  }\n

"},{"location":"developers/interfaces/createMessageLog/#reference","title":"Reference","text":"Example CRMPipedrive 
            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\n// - contactInfo: { id, type, phoneNumber, name }\n// - message : same as in https://developers.ringcentral.com/api-reference/Message-Store/readMessage\n// - recordingLink: recording link of voice mail\n// - additionalSubmission: all additional fields that are setup in manifest under call log page\nasync function createMessageLog({ user, contactInfo, authHeader, message, additionalSubmission, recordingLink, faxDocLink }) {\n    // ---------------------------------------\n    // ---TODO.7: Implement message logging---\n    // ---------------------------------------\n\n    // const postBody = {\n    //     data: {\n    //         subject: `[SMS] ${message.direction} SMS - ${message.from.name ?? ''}(${message.from.phoneNumber}) to ${message.to[0].name ?? ''}(${message.to[0].phoneNumber})`,\n    //         body: `${message.direction} SMS - ${message.direction == 'Inbound' ? `from ${message.from.name ?? ''}(${message.from.phoneNumber})` : `to ${message.to[0].name ?? ''}(${message.to[0].phoneNumber})`} \\n${!!message.subject ? `[Message] ${message.subject}` : ''} ${!!recordingLink ? `\\n[Recording link] ${recordingLink}` : ''}\\n\\n--- Created via RingCentral App Connect`,\n    //         type: 'Message'\n    //     }\n    // }\n    // const addLogRes = await axios.post(\n    //     `https://api.crm.com/activity`,\n    //     postBody,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n    const messageType = !!recordingLink ? 'Voicemail' : (!!faxDocLink ? 'Fax' : 'SMS');\n    console.log(`adding message log... \\n\\n${JSON.stringify(message, null, 2)}`);\n    mockMessageLog = {\n        id: 'testMessageLogId'\n    }\n    const addLogRes = {\n        data: {\n            id: mockMessageLog.id\n        }\n    }\n    //-------------------------------------------------------------------------------------------------------------\n    //---CHECK.7: For single message logging, open db.sqlite and CRM website to check if message logs are saved ---\n
        updatedNote: putBody.note,\n        returnMessage: {\n            message: 'Call log updated.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\nasync function createMessageLog({ user, contactInfo, authHeader, message, additionalSubmission, recordingLink, faxDocLink }) {\n    const userInfoResponse = await axios.get(`https://${user.hostname}/v1/users/me`, {\n        headers: {\n            'Authorization': authHeader\n        }\n    });\n    const userName = userInfoResponse.data.data.name;\n    const dealId = additionalSubmission ? additionalSubmission.deals : '';\n    const orgId = contactInfo.organization ? contactInfo.organization.id : '';\n    const timeUtc = moment(message.creationTime).utcOffset(0).format('HH:mm')\n    const dateUtc = moment(message.creationTime).utcOffset(0).format('YYYY-MM-DD');\n    const activityTypesResponse = await axios.get(`https://${user.hostname}/v1/activityTypes`, { headers: { 'Authorization': authHeader } });\n    const hasSMSType = activityTypesResponse.data.data.some(t => t.name === 'SMS' && t.active_flag);\n\n    const messageType = !!recordingLink ? 'Voicemail' : (!!faxDocLink ? 'Fax' : 'SMS');\n    let subject = '';\n    let note = '';\n    switch (messageType) {\n        case 'SMS':\n            subject = `SMS conversation with ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;\n            note =\n                `<br><b>${subject}</b><br>` +\n                '<b>Conversation summary</b><br>' +\n                `${moment(message.creationTime).utcOffset(user.timezoneOffset).format('dddd, MMMM DD, YYYY')}<br>` +\n                'Participants<br>' +\n                `<ul><li><b>${userName}</b><br></li>` +\n                `<li><b>${contactInfo.name}</b></li></ul><br>` +\n                'Conversation(1 messages)<br>' +\n                'BEGIN<br>' +\n                '------------<br>' +\n                '<ul>' +\n                `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +\n                `<b>${message.subject}</b></li>` +\n                '</ul>' +\n                '------------<br>' +\n                'END<br><br>' +\n                '--- Created via RingCentral App Connect';\n            break;\n        case 'Voicemail':\n            subject = `Voicemail left by ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;\n            note = `<br><b>${subject}</b><br>Voicemail recording link: ${recordingLink} <br><br>--- Created via RingCentral App Connect`;\n            break;\n        case 'Fax':\n            subject = `Fax document sent from ${contactInfo.name} - ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('YY/MM/DD')}`;\n            note = `<br><b>${subject}</b><br>Fax document link: ${faxDocLink} <br><br>--- Created via RingCentral App Connect`;\n            break;\n    }\n    const postBody = {\n        user_id: user.id,\n        subject,\n        person_id: contactInfo.id,\n        org_id: orgId,\n        deal_id: dealId,\n        note,\n        done: true,\n        due_date: dateUtc,\n        due_time: timeUtc,\n        type: hasSMSType ? 'SMS' : 'Call'\n    }\n    const addLogRes = await axios.post(\n        `https://${user.hostname}/v1/activities`,\n        postBody,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n
"},{"location":"developers/interfaces/findContact/","title":"getContact","text":"

This interface is central to App Connect's framework as it is responsible for matching phone numbers with contacts in the target CRM. This interface powers the following key features:

  • call pop
  • call logging
  • sms logging

This interface can return one or more contacts. If multiple contacts are returned, App Connect will prompt the end user to select the specific contact to be used when logging calls.

This interface is called in the following circumstances:

  • When a call is received.
  • When a user manually clicks the \"refresh contact\" action for a contact or phone call.
  • When a user accesses App Connect the first time in an attempt to perform an initial contact match operation for recent phone calls.

The \"Refresh contact\" action in App Connect's contact list"},{"location":"developers/interfaces/findContact/#request-parameters","title":"Request parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM. phoneNumber The phone number to search for within the target CRM, provided in an E.164 format, e.g. +11231231234. overridingFormat (Optional) If defined by the user under advanced settings, this will contain alternative formats the user may wish to use when searching for the phoneNumber

Alternative formats

Some CRM's have very restrictive APIs with regards to searching for phone numbers, meaning they require an exact match in order to find a contact with that phone number. To work around this restriction, users are allowed to specify a list of phone number formats which they often use when entering phone numbers into the CRM. It is the intention that each adapter when provided a list of overridingFormat values to convert the E.164 phone number into each of the overriding formats, and to search for each one until a contact is found.

Remember: only a single call the getContact interface will be made. The developer is responsible for searching for each alternative format.

"},{"location":"developers/interfaces/findContact/#return-values","title":"Return value(s)","text":"

This interface returns a single object. That object describes the contacts that were found. It has following properties:

Parameter Description matchedContactInfo An array of objects containing id, name and optionally additionalInfo and isNewContact. returnMessage message, messageType and ttl

isNewContact is only used as an extra option in contact list for users to be able to create new contacts

Example

{\n  matchedContactInfo:[\n    {\n      id: 'contact id',\n      name: 'John Doe',\n      additionalInfo: null,\n      isNewContact: false\n    },\n    {\n        id: 'createNewContact',\n        name: 'Create new contact...',\n        additionalInfo: null,\n        isNewContact: true\n    }\n  ],\n  returnMessage:{\n    message: 'Found 1 contact',\n    messageType: 'warning', // 'success', 'warning' or 'danger'\n    ttl: 30000 // in miliseconds\n  }\n}\n
"},{"location":"developers/interfaces/findContact/#reference","title":"Reference","text":"Example CRMPipedrive 
async function findContact({ user, authHeader, phoneNumber, overridingFormat, isExtension }) {\n    // ----------------------------------------\n    // ---TODO.3: Implement contact matching---\n    // ----------------------------------------\n\n    console.log(`phone number: ${phoneNumber}`)\n    console.log(`is extesnion number? ${isExtension}`)\n    const numberToQueryArray = [];\n    if (isExtension) {\n        numberToQueryArray.push(phoneNumber);\n    }\n    else {\n        numberToQueryArray.push(phoneNumber.replace(' ', '+'));\n    }\n    // You can use parsePhoneNumber functions to further parse the phone number\n    const matchedContactInfo = [];\n    // for (var numberToQuery of numberToQueryArray) {\n    //     const personInfo = await axios.get(\n    //         `https://api.crm.com/contacts?query=number:${numberToQuery}`,\n    //         {\n    //             headers: { 'Authorization': authHeader }\n    //         });\n    //     if (personInfo.data.length > 0) {\n    //         for (var result of personInfo.data) {\n    //             foundContacts.push({\n    //                 id: result.id,\n    //                 name: result.name,\n    //                 type: result.type,\n    //                 phone: numberToQuery,\n    //                 additionalInfo: null\n    //             })\n    //         }\n    //     }\n    // }\n    if (mockContact != null) {\n        matchedContactInfo.push(mockContact);\n    }\n    console.log(`found contacts... \\n\\n${JSON.stringify(matchedContactInfo, null, 2)}`);\n\n    // If you want to support creating a new contact from the extension, below placeholder contact should be used\n    matchedContactInfo.push({\n        id: 'createNewContact',\n        name: 'Create new contact...',\n        additionalInfo: null,\n        isNewContact: true\n    });\n    //-----------------------------------------------------\n    //---CHECK.3: In console, if contact info is printed---\n    //-----------------------------------------------------\n    return {\n        matchedContactInfo,\n
async function findContact({ user, authHeader, phoneNumber, overridingFormat }) {\n    phoneNumber = phoneNumber.replace(' ', '+')\n    // without + is an extension, we don't want to search for that\n    if (!phoneNumber.includes('+')) {\n        return {\n            matchedContactInfo: null,\n            returnMessage: {\n                message: 'Logging against internal extension number is not supported.',\n                messageType: 'warning',\n                ttl: 3000\n            }\n        };\n    }\n    const phoneNumberObj = parsePhoneNumber(phoneNumber);\n    let phoneNumberWithoutCountryCode = phoneNumber;\n    if (phoneNumberObj.valid) {\n        phoneNumberWithoutCountryCode = phoneNumberObj.number.significant;\n    }\n    const personInfo = await axios.get(\n        `https://${user.hostname}/v1/persons/search?term=${phoneNumberWithoutCountryCode}&fields=phone`,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n    const matchedContactInfo = [];\n    for (const person of personInfo.data.data.items) {\n        const dealsResponse = await axios.get(\n            `https://${user.hostname}/v1/persons/${person.item.id}/deals?status=open`,\n            {\n                headers: { 'Authorization': authHeader }\n            });\n        const relatedDeals = dealsResponse.data.data ?\n            dealsResponse.data.data.map(d => { return { const: d.id, title: d.title } })\n            : null;\n        matchedContactInfo.push(formatContact(person.item, relatedDeals));\n
"},{"location":"developers/interfaces/getAuthType/","title":"getAuthType","text":"

This method returns either oauth or apiKey.

"},{"location":"developers/interfaces/getAuthType/#request-parameters","title":"Request parameters","text":"

None.

"},{"location":"developers/interfaces/getAuthType/#return-values","title":"Return value(s)","text":"

This interface returns a single string, either oauth or apiKey to indicate what kind of auth is supported by the target CRM.

"},{"location":"developers/interfaces/getAuthType/#reference","title":"Reference","text":"Example CRMPipedrive 
function getAuthType() {\n    return 'apiKey'; // Return either 'oauth' OR 'apiKey'\n}\n
function getAuthType() {\n    return 'oauth';\n
"},{"location":"developers/interfaces/getCallLog/","title":"getCallLog","text":"

This interface retrieves a previously logged call log record in the target CRM. This information is used to render a form to allow an end user to view or edit that record within the App Connect client.

"},{"location":"developers/interfaces/getCallLog/#request-parameters","title":"Request parameters","text":"Parameter Description user TODO callLogId The ID of the activity or call log record within the CRM. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM."},{"location":"developers/interfaces/getCallLog/#return-values","title":"Return value(s)","text":"

This interface should return the associated call log record in a prescribed format.

Parameter Description callLogInfo Contain subject, note and optionally additionalSubmission returnMessage message, messageType and ttl

Example

{\n  callLogInfo:{\n    subject: \"A new call from John Doe\",\n    note: \"Delivery location changed.\",\n    additionalSubmission: {\n      address: \"12 Some Street, CA\"\n    }\n  },\n  returnMessage:{\n    message: 'Log fetched',\n    messageType: 'success', // 'success', 'warning' or 'danger'\n    ttl: 30000 // in miliseconds\n  }\n}\n
"},{"location":"developers/interfaces/getCallLog/#reference","title":"Reference","text":"Example CRMPipedrive 
            message: 'Call log added.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\nasync function getCallLog({ user, callLogId, authHeader }) {\n    // -----------------------------------------\n    // ---TODO.5: Implement call log fetching---\n    // -----------------------------------------\n\n    // const getLogRes = await axios.get(\n    //     `https://api.crm.com/activity/${callLogId}`,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n\n    const getLogRes = {\n        subject: mockCallLog.subject,\n        note: mockCallLog.note\n    }\n\n    //-------------------------------------------------------------------------------------\n    //---CHECK.5: In extension, for a logged call, click edit to see if info is fetched ---\n    //-------------------------------------------------------------------------------------\n    return {\n        callLogInfo: {\n            subject: getLogRes.subject,\n            note: getLogRes.note\n        },\n
    const putLogRes = await axios.put(\n        `https://${user.hostname}/v1/activities/${existingLogId}`,\n        putBody,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n}\n\n\nasync function getCallLog({ user, callLogId, authHeader }) {\n    const getLogRes = await axios.get(\n        `https://${user.hostname}/v1/activities/${callLogId}`,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n    const logBody = getLogRes.data.data.note;\n    console.log(logBody)\n    const note = logBody.split('<li><b>Summary</b>: ')[1]?.split('<li><b>')[0] ?? '';\n    const relatedContact = getLogRes.data.related_objects?.person;\n    let contactName = 'Unknown';\n    if (!!relatedContact) {\n        const contactKeys = Object.keys(relatedContact);\n
"},{"location":"developers/interfaces/getOauthInfo/","title":"getOauthInfo","text":"

This method returns a simple object containing all necessary OAuth values. This method provides developers with a safe and secure way to present to the framework values that are typically considered private, for example a client secret. These values are often stored in environment variables or in a vault.

"},{"location":"developers/interfaces/getOauthInfo/#input-parameters","title":"Input parameters","text":"

None.

"},{"location":"developers/interfaces/getOauthInfo/#return-values","title":"Return value(s)","text":"

This method should return an associative array with the following keys and values:

Key Value clientId The client ID of the application registered with the CRM provider, used to call the CRM's API. clientSecret The client secret of the application registered with the CRM provider. accessTokenUri The API endpoint used to retrieve the access token from the CRM provider. redirectUri The redirect URI registered with the CRM provider.

Example

{\n  'clientId': 'xxx-xxxx-xxxxxxxxxx-xxxx',\n  'clientSecret': 'xxxxxxxx-xxxxxxxxxxxxxxxxxx',\n  'accessTokenUri': 'https://auth.crm.com/token',\n  'redirectUri': 'https://ringcentral.github.io/ringcentral-embeddable/redirect.html'\n}\n
"},{"location":"developers/interfaces/getOauthInfo/#reference","title":"Reference","text":"Example CRMPipedrive 
// async function getOauthInfo() {\n//     return {\n//         clientId: process.env.TEST_CRM_CLIENT_ID,\n//         clientSecret: process.env.TEST_CRM_CLIENT_SECRET,\n//         accessTokenUri: process.env.TEST_CRM_TOKEN_URI,\n//         redirectUri: process.env.TEST_CRM_REDIRECT_URI\n//     }\n// }\n
async function getOauthInfo() {\n    return {\n        clientId: process.env.PIPEDRIVE_CLIENT_ID,\n        clientSecret: process.env.PIPEDRIVE_CLIENT_SECRET,\n        accessTokenUri: process.env.PIPEDRIVE_ACCESS_TOKEN_URI,\n        redirectUri: process.env.PIPEDRIVE_REDIRECT_URI\n    }\n
"},{"location":"developers/interfaces/getUserInfo/","title":"getUserInfo","text":"

This method results in the adapter calling the CRM to retrieve key information about the currently logged in user. This method should return an associative array containing the following keys and values.

Key Value id The account ID of the user within the CRM. This not the user's personal ID, but that of the parent account. name The name of the user within the CRM. This will be shown in the Chrome extension to indicate who is currentlyly logged into the CRM. timezoneName The three-letter timezone identifier of the user. timezoneOffset The timezone offset of the user, expressed as a positive or negative integer. platformAdditionalInfo An associative array of additional information about the user in the CRM. See below. overridingHostname Some CRMs provision unique URLs to each account within their service. For example, to access your account one would use a URL such as https://mycompanydomain.crm.com. The property tells the framework your company's unique URL if there is one.

platformAdditionalInfo

Key Value companyId The company or account ID of the user within the CRM. companyName The name of the company or account the user is associated with in the CRM. companyDomain The domain of the account within the CRM. Example CRMPipedrive 
async function getUserInfo({ authHeader, additionalInfo }) {\n    // ------------------------------------------------------\n    // ---TODO.1: Implement API call to retrieve user info---\n    // ------------------------------------------------------\n    try {\n        // API call to get logged in user info\n        // const userInfoResponse = await axios.get('https://api.crm.com/user/me', {\n        //     headers: {\n        //         'Authorization': authHeader\n        //     }\n        // });\n        const mockUserInfoResponse = {\n            data: {\n                id: 'testUserId',\n                name: 'Test User',\n                time_zone: 'America/Los_Angeles',\n                time_zone_offset: 0\n            }\n        }\n\n        const id = mockUserInfoResponse.data.id;\n        const name = mockUserInfoResponse.data.name;\n        const timezoneName = mockUserInfoResponse.data.time_zone ?? ''; // Optional. Whether or not you want to log with regards to the user's timezone\n        const timezoneOffset = mockUserInfoResponse.data.time_zone_offset ?? null; // Optional. Whether or not you want to log with regards to the user's timezone. It will need to be converted to a format that CRM platform uses,\n        return {\n            successful: true,\n            platformUserInfo: {\n                id,\n                name,\n                timezoneName,\n                timezoneOffset,\n                platformAdditionalInfo: {}  // this should save whatever extra info you want to save against the user\n            },\n            returnMessage: {\n                messageType: 'success',\n                message: 'Successfully connected to TestCRM.',\n                ttl: 3000\n            }\n        };\n    }\n    catch (e) {\n        return {\n            successful: false,\n            returnMessage: {\n                messageType: 'warning',\n                message: 'Failed to get user info.',\n                ttl: 3000\n            }\n        }\n    }\n
async function getUserInfo({ authHeader, hostname }) {\n    try {\n        const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {\n            headers: {\n                'Authorization': authHeader\n            }\n        });\n        const id = userInfoResponse.data.data.id.toString();\n        const name = userInfoResponse.data.data.name;\n        const timezoneName = userInfoResponse.data.data.timezone_name;\n        const timezoneOffset = userInfoResponse.data.data.timezone_offset;\n        return {\n            successful: true,\n            platformUserInfo: {\n                id,\n                name,\n                timezoneName,\n                timezoneOffset,\n                platformAdditionalInfo: {\n                    companyId: userInfoResponse.data.data.company_id,\n                    companyName: userInfoResponse.data.data.company_name,\n                    companyDomain: userInfoResponse.data.data.company_domain,\n                },\n                overridingHostname: hostname == 'temp' ? `${userInfoResponse.data.data.company_domain}.pipedrive.com` : null\n            },\n            returnMessage: {\n                messageType: 'success',\n                message: 'Successfully connected to Pipedrive.',\n                ttl: 3000\n            }\n        };\n    }\n    catch (e) {\n        return {\n            successful: false,\n            returnMessage: {\n                messageType: 'warning',\n                message: 'Failed to get user info.',\n                ttl: 3000\n            }\n        }\n    }\n
"},{"location":"developers/interfaces/unAuthorize/","title":"unAuthorize","text":"

It is to remove user data from our database when user chooses to log out. Some CRMs have token invalidation mechanism, if so, please implement that as well.

"},{"location":"developers/interfaces/unAuthorize/#request-parameters","title":"Request parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface."},{"location":"developers/interfaces/unAuthorize/#return-values","title":"Return value(s)","text":"Parameter Description returnMessage message, messageType and ttl

Example

{\n  returnMessage:{\n    message: 'Successfully unauthorized',\n    messageType: 'success', // 'success', 'warning' or 'danger'\n    ttl: 30000 // in miliseconds\n  }\n}\n
"},{"location":"developers/interfaces/unAuthorize/#reference","title":"Reference","text":"Example CRMPipedrive 
async function unAuthorize({ user }) {\n    // -----------------------------------------------------------------\n    // ---TODO.2: Implement token revocation if CRM platform requires---\n    // -----------------------------------------------------------------\n\n    // const revokeUrl = 'https://api.crm.com/oauth/unauthorize';\n    // const revokeBody = {\n    //     token: user.accessToken\n    // }\n    // const accessTokenRevokeRes = await axios.post(\n    //     revokeUrl,\n    //     revokeBody,\n    //     {\n    //         headers: { 'Authorization': `Basic ${getBasicAuth({ apiKey: user.accessToken })}` }\n    //     });\n    await user.destroy();\n    return {\n        returnMessage: {\n            messageType: 'success',\n            message: 'Successfully logged out from TestCRM account.',\n            ttl: 3000\n        }\n    }\n
async function unAuthorize({ user }) {\n    const revokeUrl = 'https://oauth.pipedrive.com/oauth/revoke';\n    const basicAuthHeader = Buffer.from(`${process.env.PIPEDRIVE_CLIENT_ID}:${process.env.PIPEDRIVE_CLIENT_SECRET}`).toString('base64');\n    const refreshTokenParams = new url.URLSearchParams({\n        token: user.refreshToken\n    });\n    const refreshTokenRevokeRes = await axios.post(\n        revokeUrl,\n        refreshTokenParams,\n        {\n            headers: { 'Authorization': `Basic ${basicAuthHeader}` }\n        });\n    const accessTokenParams = new url.URLSearchParams({\n        token: user.accessToken\n    });\n    const accessTokenRevokeRes = await axios.post(\n        revokeUrl,\n        accessTokenParams,\n        {\n            headers: { 'Authorization': `Basic ${basicAuthHeader}` }\n        });\n    await user.destroy();\n    return {\n        returnMessage: {\n            messageType: 'success',\n            message: 'Successfully logged out from Pipedrive account.',\n            ttl: 3000\n        }\n    }\n
"},{"location":"developers/interfaces/updateCallLog/","title":"updateCallLog","text":"

This interface is called when a call log activity record needs to be updated. This interface is invoked in response to the following user actions:

  • The user of App Connect's Chrome extension updates the subject or notes associated with a call log.
  • When a recording has become available for a phone call.
"},{"location":"developers/interfaces/updateCallLog/#adding-a-recording-to-a-call-log-entry","title":"Adding a recording to a call log entry","text":"

Events are triggers the moment a phone call is completed so that it can be logged properly. However, recordings take additional time to process and encode to make available to users. Therefore, for any given call you will receive an event when the call ends, and a subsequent event when a record is made available (assuming a recording of the call was made).

It is the developer's responsibility to update the call log record contents as they see fit to make a call recording available.

"},{"location":"developers/interfaces/updateCallLog/#input-parameters","title":"Input parameters","text":"Parameter Description user An object describing the Chrome extension user associated with the action that triggered this interface. existingCallLog All the metadata associated with the call to be logged. Call Log schema is described in our API Reference. authHeader The HTTP Authorization header to be transmitted with the API request to the target CRM. recordingLink If the call has a recording associated with it, then this field will contain a link to the voicemail. subject The subject or summary of the call activity. The value may have been changes by the user. note The notes saved by the user. The value may change if the user has updated the notes they have taken."},{"location":"developers/interfaces/updateCallLog/#contact-info","title":"Contact Info","text":"
{ \n  id: \"<string\">,\n  type: \"<string>\", \n  phoneNumber: \"<E.164 Phone Number>\",\n  name: \"<string>\"\n}\n
"},{"location":"developers/interfaces/updateCallLog/#return-values","title":"Return value(s)","text":"

An object with following properties:

Parameter Description updatedNote updated note on CRM returnMessage message, messageType and ttl

Example 

  return {\n    updatedNote: \"Some random notes\",\n    returnMessage:{\n      message: 'Call logged',\n      messageType: 'success', // 'success', 'warning' or 'danger'\n      ttl: 30000 // in miliseconds\n    }\n  }\n

"},{"location":"developers/interfaces/updateCallLog/#reference","title":"Reference","text":"Example CRMPipedrive 
        logId: addLogRes.data.id,\n        returnMessage: {\n            message: 'Message log added.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\n// Used to update existing message log so to group message in the same day together\nasync function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {\n    // ---------------------------------------\n    // ---TODO.8: Implement message logging---\n    // ---------------------------------------\n\n    // const existingLogId = existingMessageLog.thirdPartyLogId;\n    // const getLogRes = await axios.get(\n    //     `https://api.crm.com/activity/${existingLogId}`,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n    // const originalNote = getLogRes.data.body;\n    // const updateNote = orginalNote.replace();\n\n    // const patchBody = {\n    //     data: {\n    //         body: updateNote,\n    //     }\n    // }\n    // const updateLogRes = await axios.patch(\n    //     `https://api.crm.com/activity`,\n
        logId: addLogRes.data.data.id,\n        returnMessage: {\n            message: 'Message log added.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\nasync function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {\n    const existingLogId = existingMessageLog.thirdPartyLogId;\n    const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {\n        headers: {\n            'Authorization': authHeader\n        }\n    });\n    const userName = userInfoResponse.data.data.name;\n    const getLogRes = await axios.get(\n        `https://${user.hostname}/v1/activities/${existingLogId}`,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n    let logBody = getLogRes.data.data.note;\n    let putBody = {};\n    const newMessageLog =\n        `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +\n        `<b>${message.subject}</b></li>`;\n    logBody = logBody.replace('------------<br><ul>', `------------<br><ul>${newMessageLog}`);\n\n    const regex = RegExp('<br>Conversation.(.*) messages.');\n    const matchResult = regex.exec(logBody);\n    logBody = logBody.replace(matchResult[0], `<br>Conversation(${parseInt(matchResult[1]) + 1} messages)`);\n\n    putBody = {\n
"},{"location":"developers/interfaces/updateMessageLog/","title":"updateMessageLog","text":"

This function is to add following messages on the same day to the same contact. Use case is explained here

"},{"location":"developers/interfaces/updateMessageLog/#params","title":"Params","text":"

Input: - user: user entity - contactInfo: has id, phoneNumber, type, name - existingMessageLog: existing message log entity - authHeader: auth header for CRM API call - message: message text

"},{"location":"developers/interfaces/updateMessageLog/#reference","title":"Reference","text":"Example CRMPipedrive 
        logId: addLogRes.data.id,\n        returnMessage: {\n            message: 'Message log added.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\n// Used to update existing message log so to group message in the same day together\nasync function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {\n    // ---------------------------------------\n    // ---TODO.8: Implement message logging---\n    // ---------------------------------------\n\n    // const existingLogId = existingMessageLog.thirdPartyLogId;\n    // const getLogRes = await axios.get(\n    //     `https://api.crm.com/activity/${existingLogId}`,\n    //     {\n    //         headers: { 'Authorization': authHeader }\n    //     });\n    // const originalNote = getLogRes.data.body;\n    // const updateNote = orginalNote.replace();\n\n    // const patchBody = {\n    //     data: {\n    //         body: updateNote,\n    //     }\n    // }\n    // const updateLogRes = await axios.patch(\n    //     `https://api.crm.com/activity`,\n
        logId: addLogRes.data.data.id,\n        returnMessage: {\n            message: 'Message log added.',\n            messageType: 'success',\n            ttl: 3000\n        }\n    };\n}\n\nasync function updateMessageLog({ user, contactInfo, existingMessageLog, message, authHeader }) {\n    const existingLogId = existingMessageLog.thirdPartyLogId;\n    const userInfoResponse = await axios.get('https://api.pipedrive.com/v1/users/me', {\n        headers: {\n            'Authorization': authHeader\n        }\n    });\n    const userName = userInfoResponse.data.data.name;\n    const getLogRes = await axios.get(\n        `https://${user.hostname}/v1/activities/${existingLogId}`,\n        {\n            headers: { 'Authorization': authHeader }\n        });\n    let logBody = getLogRes.data.data.note;\n    let putBody = {};\n    const newMessageLog =\n        `<li>${message.direction === 'Inbound' ? `${contactInfo.name} (${contactInfo.phoneNumber})` : userName} ${moment(message.creationTime).utcOffset(user.timezoneOffset).format('hh:mm A')}<br>` +\n        `<b>${message.subject}</b></li>`;\n    logBody = logBody.replace('------------<br><ul>', `------------<br><ul>${newMessageLog}`);\n\n    const regex = RegExp('<br>Conversation.(.*) messages.');\n    const matchResult = regex.exec(logBody);\n    logBody = logBody.replace(matchResult[0], `<br>Conversation(${parseInt(matchResult[1]) + 1} messages)`);\n\n    putBody = {\n
"},{"location":"users/access/","title":"Accessing the extension to make calls","text":"

App Connect makes available to users a fully-functional web phone for placing and receiving calls, as well as recording notes and call dispositions related to those calls -- not to mention numerous other features. The web phone can be accessed in one of two ways.

"},{"location":"users/access/#click-the-quick-access-badge","title":"Click the quick access badge","text":"

When logged into and viewing your CRM, an orange \"R\" handle/badge will appear in the lower-righthand corner of your browser window. Click the badge to open the dialer window and/or bring it to the foreground.

App Connect's quick access badge

If the orange badge obscures page content, or if you wish to hide it for other reasons, you may turn this off using an advanced configuration parameter.

"},{"location":"users/access/#click-ringcentral-app-connect-from-the-extensions-menu","title":"Click \"RingCentral App Connect\" from the extensions menu","text":"

You can open App Connect's dialer by finding the extension in your list of installed extensions and clicking \"RingCentral App Connect.\"

App Connect's quick access badge

Pin the extension to your browser bar

If you need to access the extension often, you can \"pin\" the extension to your location bar so that it is more readily available.

"},{"location":"users/admin/","title":"Managing user settings across your account","text":"

Super Admins within your RingCentral account have access to an additional area of App Connect in which they can manage the end user's experience across their entire account. This feature primarily allows admins to set certain preferences, or mandate certain preferences across their entire account. This allows admins for example to mandate that all calls across an account be logged. Or that specific settings be employed for their CRM.

The admin tab in App Connect gives admins the ability to manage settings on behalf of others"},{"location":"users/admin/#gaining-access-to-the-admin-tab","title":"Gaining access to the admin tab","text":"

When you first load App Connect, you may not see the Admin tab. To make the Admin tab appears please check the following:

  1. Make sure you possess the \"Super Admin\" role in the RingCentral Admin Console.
  2. Connect to your CRM
"},{"location":"users/admin/#managing-settings-on-behalf-of-others","title":"Managing settings on behalf of others","text":"

Once you have access to the Admin tab, admins can manage the following:

  • Call and SMS logging settings
  • Contact and call-pop settings
  • CRM-specific settings
  • Advanced settings
  • Set the custom CRM manifest URL

Admins can set call logging policies

For each setting that can be managed by an admin, one can do the following:

  • Mandate the setting be a specific value. This is done by disabling the user's ability to customize the value, and select the value you prefer.
  • Set the default value of a setting. This is done by setting the preferred value, and by enabling the user to customize the value.
"},{"location":"users/admin/#what-users-within-your-account-will-see","title":"What users within your account will see","text":"

When a setting is mandated by an admin, a lock icon will appear next to the setting and it will be disabled, thereby allowing the user to see the value, but be unable to change it.

Admins can manage CRM-specific settings"},{"location":"users/admin/#managing-crm-specific-settings","title":"Managing CRM-specific settings","text":"

Each CRM supported by App Connect may expose custom settings. These settings can be managed under the area labeled as \"Custom options.\"

Admins can manage CRM-specific settings"},{"location":"users/admin/#managing-custom-adapter-settings","title":"Managing custom adapter settings","text":"

App Connect enables developers to build custom adapters to connect to proprietary CRMs, or CRMs not supported natively by App Connect. Users can load a custom adapter under \"Developer Settings.\" Admins however can manage this setting across their entire account under the \"Custom adapter\" area of the Admin tab.

"},{"location":"users/logging/","title":"Logging phone calls in the CRM","text":"

One of the central features of App Connect is the ability to automatically log calls that are received or placed while the extension is active. All calls made or received can be logged manually. To manually log a call, open the \"Calls\" tab in the extension, find the call you wish to log in the list, and click the call log icon. You will then be prompted to enter call notes for the call. Clicking \"save\" will result in the call be logged, associated with the proper contact, and any notes you entered being saved with the associated activity.

App Connect's call history page"},{"location":"users/logging/#finding-all-unlogged-calls","title":"Finding all unlogged calls","text":"

It might be helpful from time to time to quickly assess and remedy any calls that have not yet been logged. To see a list of calls that have not yet been logged, select \"Unlogged\" from the list of available filters.

App Connect's filtered list of \"Unlogged\" calls"},{"location":"users/logging/#logging-call-recordings","title":"Logging call recordings","text":"

If a call is recorded, a link to the call's recording is included in the contents logged to the CRM automatically.

Call recording links are generated with certain delay

Please be aware that it takes time for RingCentral server to process and upload your recordings, therefore recording links won't be generated immediately after calls. The delay could be seconds to minutes dpending on duration of the call and RingCentral server's current capacity.

Call logs are kept for a maximum of 90 days within RingCentral

Please be aware that RingCentral does not retain data indefinitely. Call recordings for example are purged after 90 days. If you wish to retain those files longer, most users subscribe to a third-party service to archive call media.

"},{"location":"users/logging/#taking-notes-during-an-active-call","title":"Taking notes during an active call","text":"

While a call is active, click the \"Notes\" icon found in the lower right-hand corner of the dialer to open up a notes page into which you free type notes. When the call is complete, the notes will be saved locally, and when you log the call in the CRM the notes will transmitted to and saved in the CRM.

Users can take notes during a phone call that can later be logged into a CRM."},{"location":"users/logging/#logging-calls-when-no-contact-is-found","title":"Logging calls when no contact is found","text":"

In order for a call to be logged properly, a contact record within the connected CRM must exist and be associated with the phone call. Calls are matched to a contact via the phone number associated with the call.

When no contact can be found associated with a given phone number, App Connect makes it easy to create a placeholder contact associated with the corresponding phone number. To create a placeholder contact, provide the name of the contact and the extension will do the rest.

Creating a placeholder contact in the connected CRM

It is the intention for someone to edit the placeholder contact after the call has been logged, to make sure all the correct and appropriate information about the contact has been captured.

What if no contact was found, when a contact is known to exist?

Sometimes a contact is not found, even though one knows for a fact that the contact exists. This happens with some CRMs whose search mechanisms are overly strict. You can address this through advanced settings.

"},{"location":"users/logging/#resolving-logging-conflicts","title":"Resolving logging conflicts","text":"

A call must be associated with one and only contact record in order for it to be logged. There are therefore two circumstances that will prevent a call from being logged.

"},{"location":"users/logging/#when-no-contact-is-found","title":"When no contact is found","text":"

If you receive a call from someone whose phone number is not in your CRM, or whose contact record cannot be found, then the call will not be logged. In this circumstance, App Connect will give you the option of creating a new contact when the call is logged. Here are some things to keep in mind when creating contacts in this way.

  • App Connect only prompts you for a name. You may want to edit the contact later to augment it with more information about the contact after the call is logged.
  • There is a call-pop setting that controls whether App Connect will open a browser tab to the newly created contact to aid you in editing the contact after it is created.
  • Some CRMs require additional records, like a company, be created and associated with a contact. App Connect will often create placeholder objects that you can edit later.
"},{"location":"users/logging/#when-multiple-possible-contacts-found","title":"When multiple possible contacts found","text":"

If more than one contact in a CRM shares the same phone number, then multiple contacts are likely to be found. This often happens when communicating with multiple employees from the same company, as it is not uncommon for the incoming phone number of two employees in the same building to present incoming phone numbers of their company's main company number.

When multiple contacts are found, users are given an opportunity to disambiguate and select the correct contact record. This is done via a pull-down menu on the call logging screen.

Disambiguating between contacts when multiple matches are found in the connected CRM"},{"location":"users/logging/#automatically-logging-calls","title":"Automatically logging calls","text":"

What to expect from logging call automatically

App Connect has the ability to automatically log calls for its users, but it is not designed to be an all-purpose call logging solution. So use it successfully to log calls, it is important to understand what it can and cannot do:

  • It CAN automatically log the calls for any user who has the extension installed, and has connected the extension to both RingCentral and their CRM.
  • It CANNOT log calls for anyone who does not have the extension installed in their browser.
  • It CANNOT log calls for anyone who has not connected the extension to their CRM.
  • It CANNOT log calls automatically for people whose browser is closed.
  • It CANNOT log calls automatically for people whose App Connect window is closed.

App Connect can be configured to log calls automatically so that you do not need to remember to do so manually. To log calls automatically, there are two configuration parameters that are relevant to you. Both of these parameters can be found under Settings accessed from the More tab.

Settings screen in App Connect to enable automatic call logging Setting Description Log phone calls automatically This toggles the auto log feature which will always attemp to log your calls/messages unless any conflict is found. Open call logging page after call This is a sub-setting under auto log. When enabled, App Connect will open a call logging page when a call ends. If auto-logging is also enabled, then the call will be logged and then the log form will be opened giving you a chance to make edits to what was logged.

Automatic call logging allows for calls to be logged, even if you are not actively using your CRM, or taking calls through App Connect. However, there is one key restriction everyone should be aware of: calls cannot be logged if App Connect is closed. Luckily, when you open App Connect, and if automatic call logging is enabled, then App Connect will attempt to log any calls that were not logged while it was closed. It will do this in the background slowly over time, processing calls in groups of ten every minute for ten minutes. Therefore, it will only attempt to log 100 calls in this way. If you failed to log more than 100, then the remainder will need to be logged manually.

Auto-logging calls require you to be logged in

Users should be aware that calls received while the browser is closed, or while the extension is not actively running will not be logged automatically. They will however be logged the next time App Connect is active.

"},{"location":"users/logging/#how-to-resolve-logging-conflicts","title":"How to resolve logging conflicts","text":"

If you have \"Auto log call\" enabled under Settings, then whenever a call is received or placed that cannot be logged automatically, then a new tab will appear called \"Unresolve.\" Within this tab, calls with various logging conflicts will queue up for the user to resolve.

In most cases, there are three reasons a call cannot be logged.

  1. No contact found: A contact could not be found in the CRM associated with the associated phone number. When this happens, a new contact must be created, or the actual contact record in the CRM should be updated with the phone number in question.

  2. Multiple contacts found: More than one contact was found with the associated phone number. To log this call, a contact record needs to be selected for the note/activity to be associated.

  3. Multiple associations found: In some CRMs, a call/SMS log can be associated with other entities. A quick example would be, a contact has two orders.

How do you know if a contact record has been found?

You will know if a contact record has been found if you see a contact's name in the call history tab of App Connect. If you see a phone number only, chances are a contact record could not be found.

Pro tip: you can still log the call as long as you fill in a contact name in the call log form for the extension to create a placeholder contact and then log the call against it

"},{"location":"users/logging/#logging-past-calls","title":"Logging past calls","text":"

App Connect has the ability to automatically log calls in your connected CRM (see \"Automatically logging calls\" above). However, for calls to be logged automatically, the extension must be actively running. So if you receive a call overnight for example, the next morning when you login, you can navigate to the Call History tab, see the calls you missed, and click the call log icon to record notes or call disposition for that particular call.

What you are prompted to log will vary depending upon the CRM you are connected to, as we tailor the logging behavior to best fit with the conventions of the corresponding CRM.

"},{"location":"users/making-calls/","title":"Making and receiving calls","text":"

As soon as you login to your RingCentral account via App Connect, and after it has loaded and initialized, you will be able to make and receive calls. When you receive a call, you will hear a ringing sound. Bring the extension to the foreground and click \"Answer\" to begin the call.

To place a call, bring the extension to the foreground, open up the dialer, and dial the phone number. It is as simple as that.

"},{"location":"users/making-calls/#click-to-dial","title":"Click-to-dial","text":"

When using your CRM, all phone numbers in your CRM will become clickable, allowing you to easily initiate a call with that phone number, or send an SMS message to that phone number. This helps users more quickly and easily engage with contacts, leads, candidates and people whom your CRM tracks.

Internal phone numbers, e.g. a plain extension, are also supported for click-to-dial so that you can easily call a co-worker -- provided that the phone number is in the following format {mainNumber}#{extensionNumber}. For example, +12223334444#438.

Click-to-dial hovercard for easy calling"},{"location":"users/making-calls/#call-pop","title":"Call-pop","text":"

You will find a number of settings under the \"Contacts\" settings area that control under what circumstances App Connect will automatically open your CRM to the contact or person being called, or calling you.

"},{"location":"users/making-calls/#call-pop-and-contact-settings","title":"Call-pop and Contact settings","text":"Setting Description Open contact from incoming call Determines if and when App Connect will open the matched contact in the CRM for an incoming call. Allowed values are: Disable, On first ring, and on answer. Open contact from outgoing call Determines if and when App Connect will open the matched contact in the CRM for an outgoing call. Allowed values are: Disable, On first ring, and on answer. Open contact after creating it If enabled, will cause App Connect to open the CRM to the page to edit a contact immediately upon creating the contact via App Connect. This is especially helpful when you want to augment the newly created contact with more data."},{"location":"users/presence/","title":"Presence and status","text":"

Using the embedded phone provided by App Connect one can easily set their presence and/or status and instantly have that synced across the network. Similarly, your presence status will always be reflected in your embedded dialer as it changes via mechanisms outside of the extension.

There are two ways to change your status:

  • Click the presence indicator in the upper-left corner of the embedded dialer

  • Navigate to the Settings page under the more menu and modify it from there

"},{"location":"users/settings/","title":"Settings and preferences","text":"

App Connect provides numerous options so that end-users can customize their specific settings and experience.

Please note that currently all options are user-specific. Account-wide configuration options are not supported.

Below you will find information on the various ways in which App Connect can be configured and customized. You can access all of these options from the Settings page accessed from the More menu.

"},{"location":"users/settings/#setting-your-preferred-phone-device","title":"Setting your preferred phone device","text":"

RingCentral customers may sometimes have multiple devices or ways of initiating a phone call. To better control what device you use for placing calls, from the Settings screen select \"Calling.\" Then, select the device you prefer to use. Options include the following:

The settings screen for changing your preferred device for placing calls"},{"location":"users/settings/#config-options","title":"Config options","text":"
  • Browser. Select this if you wish to place calls using App Connect itself.
  • RingCentral App. If you prefer to use the main RingCentral desktop app to make calls, select this.
  • RingCentral Phone. This option is not recommended as RingCentral Phone is no longer supported. However, if you still have this app installed and if you prefer to use it, select this.
  • RingOut. RingOut is helpful if you prefer to make a call from your desk phone. When RingOut is selected you will be called, and your desk/hard phone will ring. Answer the phone and we will then connect you to the person you are calling.
"},{"location":"users/settings/#changing-your-region-and-default-area-code","title":"Changing your region and default area code","text":"

To customize your default country and area code, from the Settings screen select \"Region.\" Then enter your preferred defaults.

The settings screen for modifying your locale"},{"location":"users/settings/#customizing-your-preferred-audio-devices","title":"Customizing your preferred audio devices","text":"

To customize your preferred input and output devices, e.g. headphones, laptop speakers, etc, from the Settings screen select \"Audio.\" Then select your preferred default devices. There are also audio volume controls.

The settings screen for customizing audio devices"},{"location":"users/settings/#toggling-the-call-pop-feature","title":"Toggling the call-pop feature","text":"

The term \"call-pop\" refers to opening a page about an incoming caller automatically so that the person making (or receiving) the call can see all of the relevant information about that person prior to answering the phone. You can easily toggle this feature on and off under the \"Contacts\" section.

The settings screen for toggling call-pop"},{"location":"users/settings/#toggling-the-contact-creation-pop-feature","title":"Toggling the contact creation pop feature","text":"

Users can directly create placeholder contacts from within the extension to make call logging more efficient. Placeholder contacts would normally be created with just name and phone number. If users want to edit the placeholder contact further on its CRM webpage, \"Open contact page after creating it\" setting can be turned on to automatically open the contact page after the contact's creation.

"},{"location":"users/settings/#phone-number-formats","title":"Phone number formats","text":"

In order to match a call to a contact in a CRM, App Connect needs to search the CRM for a contact using a phone number. Some CRMs have more rudimentary APIs that require phone numbers to EXACTLY match the string searched for. For these CRMs, reliably finding a contact record for a phone number can be difficult, which in turn impacts your ability to log a call and associate it with the proper entity in your CRM. Let's look at an example to help you understand. The following phone numbers are all functionally equivalent, even though they are not literally identical.

  • (###) ###-####
  • ###.###.####
  • ###-###-####
  • +1-###-###-####
  • etc

A setting used to search for contacts using a variety of alternative formats used by the customer.

RingCentral phone numbers are all formatted using the E.164 standard. If you are not storing phone numbers that utilize this format, and if your particular CRM does not support a more rigorous search mechanism, App Connect may fail to associate calls with contacts properly.

Those CRMs that exhibit this problem have additional settings found under the \"Contacts\" setting area. These phone number format parameters allows you to specify multiple formats used by your team. App Connect will then search for contacts using each of the formats provided until a record is found. This may have performance impacts.

CRMs known to exhibit this problem are:

  • Clio
  • Insightly
  • NetSuite
"},{"location":"users/settings/#automatically-prompt-to-capture-call-notes","title":"Automatically prompt to capture call notes","text":"

Many end users would like confidence in knowing that every call they place or receive is logged properly in the CRM they are connected to. Furthermore, users also want to be prompted to capture notes about a call immediately upon a call ending. To automatically be prompted to enter and save notes relating to a call that has just ended, enable \"Auto log call - only pop up log page\" from the Settings page.

The settings screen to enable prompting the user to enter notes after a call"},{"location":"users/settings/#automatically-prompt-to-capture-sms-and-text-messaging-notes","title":"Automatically prompt to capture SMS and text messaging notes","text":"

As with phone calls, many end users would like to reliably capture the SMS messages transmitted to contacts. To be prompted automatically to enter notes upon sending an SMS, enable \"Prompt to enter notes after sending SMS\" from the Settings page.

The settings screen to enable prompting the user to enter notes after sending an SMS"},{"location":"users/settings/#automatically-log-calls-and-sms-messages","title":"Automatically log calls and SMS messages","text":"

Sometimes users may not be present at their computer when a call is received, yet they still wish to record the call was received and possibly that the call was never responded to. To ensure all calls are captured whether you are present or not, enable \"Auto log call/SMS\"

For more details, please refer to auto log.

"},{"location":"users/settings/#factory-reset","title":"Factory reset","text":"

Sometimes users may encounter issues that are transient and most likely resolved by uninstalling and re-installing the app. To make this process easier, there's a Factory Reset button in user settings that allow you to wipe out user data without uninstalling the extension.

"},{"location":"users/settings/#advanced-configuration-options","title":"Advanced configuration options","text":"

Most users will not need to access these advanced configuration options. However, they have been provided to assist in resolving less common, low-level challenges. These options can be accessed both in Chrome and Edge by opening the \"Manage Extensions\" area from the Window menu, or from the extension menu found adjacent to your browser's location bar.

  • Open Manage extensions in Chrome
  • Open Manage extensions in Microsoft Edge

Finding advanced settings

To access advanced settings, in your browser, navigate to \"Manage Extensions,\" or just \"Extensions.\" From there locate \"RingCentral App Connect\" and click \"Show Details.\"

An excerpt from the extension details page for App Connect

Then scroll down near to the bottom and click \"Extension options\" to open the dialog below.

App Connect extension options. Users may see a slightly different set of options depending upon the version they are using."},{"location":"users/settings/#loading-custom-crm-adapter","title":"Loading custom CRM adapter","text":"

App Connect comes bundled with a number of CRM adapters that are ready-to-use. Developers and users alike can use advanced settings to load another third-party or alternative adapter.

To load a custom adapter, enter in the URL to the publicly accessible manifest.json file into the \"Custom CRM manifest url\" field.

A setting used to load a custom CRM adapter into the framework."},{"location":"users/settings/#click-to-dial-inject-delay","title":"Click-to-dial inject delay","text":"

App Connect's phone/dialer is injected into the CRM via a mechanism that some web servers will reject. This is circumvented by delaying the loading of the CTI by a couple of seconds. This config parameter controls this delay.

This should only be used in rare circumstances.

CRMs known to need this parameter set are:

  • Pipedrive
"},{"location":"users/settings/#render-quick-access-button","title":"Render quick access button","text":"

App Connect injects a small handle in the lower right hand corner of your CRM. Some users have expressed concern that this handle obscures the page content, and therefore wish to remove it. Toggle this parameter to turn off/on the dialer handle in the lower-righthand corner.

Disabling the quick access button does not impact the operability of the extension.

"},{"location":"users/sms/","title":"Sending SMS","text":"

App Connect has the ability to send and receive SMS messages. You can access this functionality from the Messages tab and works more or less like your phone. Click on the conversation you want to view, and then send messages to that individual or group.

"},{"location":"users/sms/#sms-templates","title":"SMS templates","text":"

Engaging with communications from customers can be overwhelming, and responding to the same questions individually can be taxing. SMS templates allow you to compose responses to common inquiries ahead of time. Then when it comes time to author a message, rather than composing your response manually, select from one of your pre-written responses, populate the message into the messaging box, make any small edits you need, and then click send.

Use SMS templates to quickly compose responses to common inquiries"},{"location":"users/sms/#managing-sms-templates","title":"Managing SMS templates","text":"

The SMS templates used in App Connect are the same templates you create and manage inside of the RingCentral desktop application to ensure consistency between these two clients.

Use SMS templates as seen from the RingCentral desktop application"},{"location":"users/sms/#logging-sms-conversations","title":"Logging SMS conversations","text":"

Similar to call logging, App Connect can also log SMS messages. To help prevent a CRM from being overwhelmed by individual records for each SMS, App Connect creates a single CRM record that contains a digest of all the SMS messages sent between you and a recipient sent in a single day.

"},{"location":"users/sms/#sms-logging-settings","title":"SMS logging settings","text":"Setting Description Log SMS conversations automatically This toggles the auto log feature which will always attemp to log your SMS messages unless any conflict is found. Open call SMS logging page after message This is a sub-setting under auto log. When enabled, App Connect will open a logging page when an SMS message is sent. It only prompts you in this manner for the first message logged that day.

Logging SMS conversations follows many of the same rules as logging phone calls, especially as it relates to resolving conflicts and so forth. Please consult call logging for more information.

"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..b909d928 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,191 @@ + + + + https://github.com/ringcentral/rc-unified-crm-extension/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/build/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/getting-started/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/release-notes/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/support/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/bullhorn/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/clio/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/insightly/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/netsuite/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/pipedrive/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/crm/redtail/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/adapter/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/auth/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/contact-matching/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/deploy/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/errors/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/getting-started/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/logging-calls/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/logging-sms/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/manifest-pages/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/manifest-sample/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/manifest/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/placeholder-contacts/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/proprietary-crm/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/view-details/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/welcome-page/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/advanced/openapi/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/createCallLog/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/createContact/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/createMessageLog/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/findContact/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/getAuthType/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/getCallLog/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/getOauthInfo/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/getUserInfo/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/unAuthorize/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/updateCallLog/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/developers/interfaces/updateMessageLog/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/access/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/admin/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/logging/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/making-calls/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/presence/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/settings/ + 2024-12-30 + + + https://github.com/ringcentral/rc-unified-crm-extension/users/sms/ + 2024-12-30 + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..203a6e4a Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/support/index.html b/support/index.html new file mode 100644 index 00000000..f4d6d6b1 --- /dev/null +++ b/support/index.html @@ -0,0 +1,2061 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Troubleshooting - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Getting help with App Connect

+
+ +
+

Common issues

+
+

Always make sure you are running the latest version

+

App Connect is frequently updated with fixes and feature enhancements. While the extension is updated automatically, you may need to restart your browser in order for those updates to take effect.

+
+

I don't see a "Connect" button to login to my CRM

+

In order to determine which CRM to connect to, you need to launch the extension while visiting and logged into your CRM application. App Connect will detect from the domain you are visiting to determine which CRM to prompt you to connect to. If you launch App Connect from any other domain, you will not see an Authorize or Connect button.

+

Unable to find contact

+

One of the most common challenges arises from phone calls for which a corresponding contact record in the CRM cannot be found. However, you know for sure the contact exists.

+

When this happens it is almost certainly related to a failed lookup of the contact based on the given phone number. A lookup can fail in some CRMs:

+
    +
  1. If the phone number stored in the CRM does not EXACTLY match the phone number as seen in App Connect. This is due to limitations in the connected CRMs' APIs.
    2. +
  2. If you have just created it and the CRM server usually doesn't reflect the change immediately. Some CRMs have refresh clock to update all changes every X seconds/minutes. So if it's just created and can be seen on CRM webpages, please wait for a couple of minutes and it should then be fetched to the extension.
    3. +
+

There are two ways to fix the issue:

+
    +
  1. +

    Update the contact record's phone number so that it conforms to the E.164 standard. This will be the most reliable solution and the most performant. However, reformatting the phone numbers across a huge contact database may not be feasible or practical.

    +
    2. +
  2. +

    Update the advanced configuration settings of App Connect to add the phone number formats commonly used by your company. App Connect will then search for contacts using each of the phone number formats stored with us. This solution is easier to deploy, but can sometimes introduce latencies as multiple API calls are needed to successfully find a contact.

    +
    3. +
+

Managing software updates

+

Updates to App Connect are installed automatically by Chrome and Edge when you restart your browser. You can see what version of App Connect is currently installed by navigating to the "Manage extensions" area of your browser, finding App Connect in your list of installed browser extensions, and clicking "Show details." On the resulting page you can see the currently installed version.

+

version number

+

To ensure you are actively running the most recent version, please restart your browser.

+

Last resort

+

In rare circumstances, due to voodoo and other supernatural forces, uninstalling and reinstalling the extension has been known to fix some problems.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/access/index.html b/users/access/index.html new file mode 100644 index 00000000..8a7aa0d4 --- /dev/null +++ b/users/access/index.html @@ -0,0 +1,1977 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Basic usage - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Accessing the extension to make calls

+

App Connect makes available to users a fully-functional web phone for placing and receiving calls, as well as recording notes and call dispositions related to those calls -- not to mention numerous other features. The web phone can be accessed in one of two ways.

+

Click the quick access badge

+

When logged into and viewing your CRM, an orange "R" handle/badge will appear in the lower-righthand corner of your browser window. Click the badge to open the dialer window and/or bring it to the foreground.

+
+

Quick Access badge +

+
App Connect's quick access badge
+
+
+

If the orange badge obscures page content, or if you wish to hide it for other reasons, you may turn this off using an advanced configuration parameter.

+
+

Click "RingCentral App Connect" from the extensions menu

+

You can open App Connect's dialer by finding the extension in your list of installed extensions and clicking "RingCentral App Connect."

+
+

Chrome extensions menu +

+
App Connect's quick access badge
+
+
+

Pin the extension to your browser bar

+

If you need to access the extension often, you can "pin" the extension to your location bar so that it is more readily available.

+

Chrome location bar with pinned extension

+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/admin/index.html b/users/admin/index.html new file mode 100644 index 00000000..28e7c337 --- /dev/null +++ b/users/admin/index.html @@ -0,0 +1,2067 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Administration - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Managing user settings across your account

+

Super Admins within your RingCentral account have access to an additional area of App Connect in which they can manage the end user's experience across their entire account. This feature primarily allows admins to set certain preferences, or mandate certain preferences across their entire account. This allows admins for example to mandate that all calls across an account be logged. Or that specific settings be employed for their CRM.

+
+

Admin tab in App Connect +

+
The admin tab in App Connect gives admins the ability to manage settings on behalf of others
+
+

Gaining access to the admin tab

+

When you first load App Connect, you may not see the Admin tab. To make the Admin tab appears please check the following:

+
    +
  1. Make sure you possess the "Super Admin" role in the RingCentral Admin Console.
    2. +
  2. Connect to your CRM
    3. +
+

Managing settings on behalf of others

+

Once you have access to the Admin tab, admins can manage the following:

+
    +
  • Call and SMS logging settings
    • +
  • Contact and call-pop settings
    • +
  • CRM-specific settings
    • +
  • Advanced settings
    • +
  • Set the custom CRM manifest URL
    • +
+
+

Logging calls +

+
Admins can set call logging policies
+
+

For each setting that can be managed by an admin, one can do the following:

+
    +
  • Mandate the setting be a specific value. This is done by disabling the user's ability to customize the value, and select the value you prefer.
    • +
  • Set the default value of a setting. This is done by setting the preferred value, and by enabling the user to customize the value.
    • +
+

What users within your account will see

+

When a setting is mandated by an admin, a lock icon will appear next to the setting and it will be disabled, thereby allowing the user to see the value, but be unable to change it.

+
+

Logging calls +

+
Admins can manage CRM-specific settings
+
+

Managing CRM-specific settings

+

Each CRM supported by App Connect may expose custom settings. These settings can be managed under the area labeled as "Custom options."

+
+

Logging calls +

+
Admins can manage CRM-specific settings
+
+

Managing custom adapter settings

+

App Connect enables developers to build custom adapters to connect to proprietary CRMs, or CRMs not supported natively by App Connect. Users can load a custom adapter under "Developer Settings." Admins however can manage this setting across their entire account under the "Custom adapter" area of the Admin tab.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/logging/index.html b/users/logging/index.html new file mode 100644 index 00000000..e9af6bc1 --- /dev/null +++ b/users/logging/index.html @@ -0,0 +1,2244 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Logging calls - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Logging phone calls in the CRM

+

One of the central features of App Connect is the ability to automatically log calls that are received or placed while the extension is active. All calls made or received can be logged manually. To manually log a call, open the "Calls" tab in the extension, find the call you wish to log in the list, and click the call log icon. You will then be prompted to enter call notes for the call. Clicking "save" will result in the call be logged, associated with the proper contact, and any notes you entered being saved with the associated activity.

+
+

Logging calls +

+
App Connect's call history page
+
+

Finding all unlogged calls

+

It might be helpful from time to time to quickly assess and remedy any calls that have not yet been logged. To see a list of calls that have not yet been logged, select "Unlogged" from the list of available filters.

+
+

Logging calls +

+
App Connect's filtered list of "Unlogged" calls
+
+

Logging call recordings

+

If a call is recorded, a link to the call's recording is included in the contents logged to the CRM automatically.

+
+

Call recording links are generated with certain delay

+

Please be aware that it takes time for RingCentral server to process and upload your recordings, therefore recording links won't be generated immediately after calls. The delay could be seconds to minutes dpending on duration of the call and RingCentral server's current capacity.

+
+
+

Call logs are kept for a maximum of 90 days within RingCentral

+

Please be aware that RingCentral does not retain data indefinitely. Call recordings for example are purged after 90 days. If you wish to retain those files longer, most users subscribe to a third-party service to archive call media.

+
+

Taking notes during an active call

+

While a call is active, click the "Notes" icon found in the lower right-hand corner of the dialer to open up a notes page into which you free type notes. When the call is complete, the notes will be saved locally, and when you log the call in the CRM the notes will transmitted to and saved in the CRM.

+
+

Logging calls +

+
Users can take notes during a phone call that can later be logged into a CRM.
+
+

Logging calls when no contact is found

+

In order for a call to be logged properly, a contact record within the connected CRM must exist and be associated with the phone call. Calls are matched to a contact via the phone number associated with the call.

+

When no contact can be found associated with a given phone number, App Connect makes it easy to create a placeholder contact associated with the corresponding phone number. To create a placeholder contact, provide the name of the contact and the extension will do the rest.

+
+

Logging calls +

+
Creating a placeholder contact in the connected CRM
+
+

It is the intention for someone to edit the placeholder contact after the call has been logged, to make sure all the correct and appropriate information about the contact has been captured.

+
+

What if no contact was found, when a contact is known to exist?

+

Sometimes a contact is not found, even though one knows for a fact that the contact exists. This happens with some CRMs whose search mechanisms are overly strict. You can address this through advanced settings.

+
+

Resolving logging conflicts

+

A call must be associated with one and only contact record in order for it to be logged. There are therefore two circumstances that will prevent a call from being logged.

+

When no contact is found

+

If you receive a call from someone whose phone number is not in your CRM, or whose contact record cannot be found, then the call will not be logged. In this circumstance, App Connect will give you the option of creating a new contact when the call is logged. Here are some things to keep in mind when creating contacts in this way.

+
    +
  • App Connect only prompts you for a name. You may want to edit the contact later to augment it with more information about the contact after the call is logged.
    • +
  • There is a call-pop setting that controls whether App Connect will open a browser tab to the newly created contact to aid you in editing the contact after it is created.
    • +
  • Some CRMs require additional records, like a company, be created and associated with a contact. App Connect will often create placeholder objects that you can edit later.
    • +
+

When multiple possible contacts found

+

If more than one contact in a CRM shares the same phone number, then multiple contacts are likely to be found. This often happens when communicating with multiple employees from the same company, as it is not uncommon for the incoming phone number of two employees in the same building to present incoming phone numbers of their company's main company number.

+

When multiple contacts are found, users are given an opportunity to disambiguate and select the correct contact record. This is done via a pull-down menu on the call logging screen.

+
+

Logging calls +

+
Disambiguating between contacts when multiple matches are found in the connected CRM
+
+

Automatically logging calls

+
+

What to expect from logging call automatically

+

App Connect has the ability to automatically log calls for its users, but it is not designed to be an all-purpose call logging solution. So use it successfully to log calls, it is important to understand what it can and cannot do:

+
    +
  • It CAN automatically log the calls for any user who has the extension installed, and has connected the extension to both RingCentral and their CRM.
    • +
  • It CANNOT log calls for anyone who does not have the extension installed in their browser.
    • +
  • It CANNOT log calls for anyone who has not connected the extension to their CRM.
    • +
  • It CANNOT log calls automatically for people whose browser is closed.
    • +
  • It CANNOT log calls automatically for people whose App Connect window is closed.
    • +
+
+

App Connect can be configured to log calls automatically so that you do not need to remember to do so manually. To log calls automatically, there are two configuration parameters that are relevant to you. Both of these parameters can be found under Settings accessed from the More tab.

+
+

Logging calls +

+
Settings screen in App Connect to enable automatic call logging
+
+ + + + + + + + + + + + + + + + + +
SettingDescription
Log phone calls automaticallyThis toggles the auto log feature which will always attemp to log your calls/messages unless any conflict is found.
Open call logging page after callThis is a sub-setting under auto log. When enabled, App Connect will open a call logging page when a call ends. If auto-logging is also enabled, then the call will be logged and then the log form will be opened giving you a chance to make edits to what was logged.
+

Automatic call logging allows for calls to be logged, even if you are not actively using your CRM, or taking calls through App Connect. However, there is one key restriction everyone should be aware of: calls cannot be logged if App Connect is closed. Luckily, when you open App Connect, and if automatic call logging is enabled, then App Connect will attempt to log any calls that were not logged while it was closed. It will do this in the background slowly over time, processing calls in groups of ten every minute for ten minutes. Therefore, it will only attempt to log 100 calls in this way. If you failed to log more than 100, then the remainder will need to be logged manually.

+
+

Auto-logging calls require you to be logged in

+

Users should be aware that calls received while the browser is closed, or while the extension is not actively running will not be logged automatically. They will however be logged the next time App Connect is active.

+
+

How to resolve logging conflicts

+

If you have "Auto log call" enabled under Settings, then whenever a call is received or placed that cannot be logged automatically, then a new tab will appear called "Unresolve." Within this tab, calls with various logging conflicts will queue up for the user to resolve.

+

Unresolved conflicts

+

In most cases, there are three reasons a call cannot be logged.

+
    +
  1. +

    No contact found: A contact could not be found in the CRM associated with the associated phone number. When this happens, a new contact must be created, or the actual contact record in the CRM should be updated with the phone number in question.

    +
    2. +
  2. +

    Multiple contacts found: More than one contact was found with the associated phone number. To log this call, a contact record needs to be selected for the note/activity to be associated.

    +
    3. +
  3. +

    Multiple associations found: In some CRMs, a call/SMS log can be associated with other entities. A quick example would be, a contact has two orders.

    +
    4. +
+

How do you know if a contact record has been found?

+

You will know if a contact record has been found if you see a contact's name in the call history tab of App Connect. If you see a phone number only, chances are a contact record could not be found.

+

Pro tip: you can still log the call as long as you fill in a contact name in the call log form for the extension to create a placeholder contact and then log the call against it

+

Logging past calls

+

App Connect has the ability to automatically log calls in your connected CRM (see "Automatically logging calls" above). However, for calls to be logged automatically, the extension must be actively running. So if you receive a call overnight for example, the next morning when you login, you can navigate to the Call History tab, see the calls you missed, and click the call log icon to record notes or call disposition for that particular call.

+

What you are prompted to log will vary depending upon the CRM you are connected to, as we tailor the logging behavior to best fit with the conventions of the corresponding CRM.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/making-calls/index.html b/users/making-calls/index.html new file mode 100644 index 00000000..805f9142 --- /dev/null +++ b/users/making-calls/index.html @@ -0,0 +1,2021 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Making and receiving calls - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Making and receiving calls

+

As soon as you login to your RingCentral account via App Connect, and after it has loaded and initialized, you will be able to make and receive calls. +When you receive a call, you will hear a ringing sound. Bring the extension to the foreground and click "Answer" to begin the call.

+

To place a call, bring the extension to the foreground, open up the dialer, and dial the phone number. It is as simple as that.

+

Click-to-dial

+

When using your CRM, all phone numbers in your CRM will become clickable, allowing you to easily initiate a call with that phone number, or send an SMS message to that phone number. This helps users more quickly and easily engage with contacts, leads, candidates and people whom your CRM tracks.

+

Internal phone numbers, e.g. a plain extension, are also supported for click-to-dial so that you can easily call a co-worker -- provided that the phone number is in the following format {mainNumber}#{extensionNumber}. For example, +12223334444#438.

+
+

Click to dial +

+
Click-to-dial hovercard for easy calling
+
+

Call-pop

+

You will find a number of settings under the "Contacts" settings area that control under what circumstances App Connect will automatically open your CRM to the contact or person being called, or calling you.

+

Call pop

+

Call-pop and Contact settings

+ + + + + + + + + + + + + + + + + + + + + +
SettingDescription
Open contact from incoming callDetermines if and when App Connect will open the matched contact in the CRM for an incoming call. Allowed values are: Disable, On first ring, and on answer.
Open contact from outgoing callDetermines if and when App Connect will open the matched contact in the CRM for an outgoing call. Allowed values are: Disable, On first ring, and on answer.
Open contact after creating itIf enabled, will cause App Connect to open the CRM to the page to edit a contact immediately upon creating the contact via App Connect. This is especially helpful when you want to augment the newly created contact with more data.
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/presence/index.html b/users/presence/index.html new file mode 100644 index 00000000..ada22133 --- /dev/null +++ b/users/presence/index.html @@ -0,0 +1,1892 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Presence - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Presence and status

+

Using the embedded phone provided by App Connect one can easily set their presence and/or status and instantly have that synced across the network. Similarly, your presence status will always be reflected in your embedded dialer as it changes via mechanisms outside of the extension.

+

There are two ways to change your status:

+
    +
  • +

    Click the presence indicator in the upper-left corner of the embedded dialer

    +

    Change presence

    +
    • +
  • +

    Navigate to the Settings page under the more menu and modify it from there

    +

    Change presence from settings

    +
    • +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/settings/index.html b/users/settings/index.html new file mode 100644 index 00000000..417d1575 --- /dev/null +++ b/users/settings/index.html @@ -0,0 +1,2342 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Settings - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Settings and preferences

+

App Connect provides numerous options so that end-users can customize their specific settings and experience.

+

Please note that currently all options are user-specific. Account-wide configuration options are not supported.

+

Below you will find information on the various ways in which App Connect can be configured and customized. You can access all of these options from the Settings page accessed from the More menu.

+

Setting your preferred phone device

+

RingCentral customers may sometimes have multiple devices or ways of initiating a phone call. To better control what device you use for placing calls, from the Settings screen select "Calling." Then, select the device you prefer to use. Options include the following:

+
+

Setting your preferred phone device +

+
The settings screen for changing your preferred device for placing calls
+
+

Config options

+
    +
  • Browser. Select this if you wish to place calls using App Connect itself.
    • +
  • RingCentral App. If you prefer to use the main RingCentral desktop app to make calls, select this.
    • +
  • RingCentral Phone. This option is not recommended as RingCentral Phone is no longer supported. However, if you still have this app installed and if you prefer to use it, select this.
    • +
  • RingOut. RingOut is helpful if you prefer to make a call from your desk phone. When RingOut is selected you will be called, and your desk/hard phone will ring. Answer the phone and we will then connect you to the person you are calling.
    • +
+

Changing your region and default area code

+

To customize your default country and area code, from the Settings screen select "Region." Then enter your preferred defaults.

+
+

Setting your preferred phone device +

+
The settings screen for modifying your locale
+
+

Customizing your preferred audio devices

+

To customize your preferred input and output devices, e.g. headphones, laptop speakers, etc, from the Settings screen select "Audio." Then select your preferred default devices. There are also audio volume controls.

+
+

Setting your preferred phone device +

+
The settings screen for customizing audio devices
+
+

Toggling the call-pop feature

+

The term "call-pop" refers to opening a page about an incoming caller automatically so that the person making (or receiving) the call can see all of the relevant information about that person prior to answering the phone. You can easily toggle this feature on and off under the "Contacts" section.

+
+

Setting your preferred phone device +

+
The settings screen for toggling call-pop
+
+

Toggling the contact creation pop feature

+

Users can directly create placeholder contacts from within the extension to make call logging more efficient. Placeholder contacts would normally be created with just name and phone number. If users want to edit the placeholder contact further on its CRM webpage, "Open contact page after creating it" setting can be turned on to automatically open the contact page after the contact's creation.

+

Phone number formats

+

In order to match a call to a contact in a CRM, App Connect needs to search the CRM for a contact using a phone number. Some CRMs have more rudimentary APIs that require phone numbers to EXACTLY match the string searched for. For these CRMs, reliably finding a contact record for a phone number can be difficult, which in turn impacts your ability to log a call and associate it with the proper entity in your CRM. Let's look at an example to help you understand. The following phone numbers are all functionally equivalent, even though they are not literally identical.

+
    +
  • (###) ###-####
    • +
  • ###.###.####
    • +
  • ###-###-####
    • +
  • +1-###-###-####
    • +
  • etc
    • +
+
+

Overriding formats in settings +

+
A setting used to search for contacts using a variety of alternative formats used by the customer.
+
+

RingCentral phone numbers are all formatted using the E.164 standard. If you are not storing phone numbers that utilize this format, and if your particular CRM does not support a more rigorous search mechanism, App Connect may fail to associate calls with contacts properly.

+

Those CRMs that exhibit this problem have additional settings found under the "Contacts" setting area. These phone number format parameters allows you to specify multiple formats used by your team. App Connect will then search for contacts using each of the formats provided until a record is found. This may have performance impacts.

+

CRMs known to exhibit this problem are:

+
    +
  • Clio
    • +
  • Insightly
    • +
  • NetSuite
    • +
+

Automatically prompt to capture call notes

+

Many end users would like confidence in knowing that every call they place or receive is logged properly in the CRM they are connected to. Furthermore, users also want to be prompted to capture notes about a call immediately upon a call ending. To automatically be prompted to enter and save notes relating to a call that has just ended, enable "Auto log call - only pop up log page" from the Settings page.

+
+

Setting your preferred phone device +

+
The settings screen to enable prompting the user to enter notes after a call
+
+

Automatically prompt to capture SMS and text messaging notes

+

As with phone calls, many end users would like to reliably capture the SMS messages transmitted to contacts. To be prompted automatically to enter notes upon sending an SMS, enable "Prompt to enter notes after sending SMS" from the Settings page.

+
+

Setting your preferred phone device +

+
The settings screen to enable prompting the user to enter notes after sending an SMS
+
+

Automatically log calls and SMS messages

+

Sometimes users may not be present at their computer when a call is received, yet they still wish to record the call was received and possibly that the call was never responded to. To ensure all calls are captured whether you are present or not, enable "Auto log call/SMS"

+

For more details, please refer to auto log.

+

Factory reset

+

Sometimes users may encounter issues that are transient and most likely resolved by uninstalling and re-installing the app. To make this process easier, there's a Factory Reset button in user settings that allow you to wipe out user data without uninstalling the extension.

+

Advanced configuration options

+

Most users will not need to access these advanced configuration options. However, they have been provided to assist in resolving less common, low-level challenges. These options can be accessed both in Chrome and Edge by opening the "Manage Extensions" area from the Window menu, or from the extension menu found adjacent to your browser's location bar.

+ +

Finding advanced settings

+

To access advanced settings, in your browser, navigate to "Manage Extensions," or just "Extensions." From there locate "RingCentral App Connect" and click "Show Details."

+
+

Setting your preferred phone device +

+
An excerpt from the extension details page for App Connect
+
+

Then scroll down near to the bottom and click "Extension options" to open the dialog below.

+
+

Setting your preferred phone device +

+
App Connect extension options. Users may see a slightly different set of options depending upon the version they are using.
+
+

Loading custom CRM adapter

+

App Connect comes bundled with a number of CRM adapters that are ready-to-use. Developers and users alike can use advanced settings to load another third-party or alternative adapter.

+

To load a custom adapter, enter in the URL to the publicly accessible manifest.json file into the "Custom CRM manifest url" field.

+
+

Custom CRM adapter +

+
A setting used to load a custom CRM adapter into the framework.
+
+

Click-to-dial inject delay

+

App Connect's phone/dialer is injected into the CRM via a mechanism that some web servers will reject. This is circumvented by delaying the loading of the CTI by a couple of seconds. This config parameter controls this delay.

+

This should only be used in rare circumstances.

+

CRMs known to need this parameter set are:

+
    +
  • Pipedrive
    • +
+

Render quick access button

+

App Connect injects a small handle in the lower right hand corner of your CRM. Some users have expressed concern that this handle obscures the page content, and therefore wish to remove it. Toggle this parameter to turn off/on the dialer handle in the lower-righthand corner.

+

Disabling the quick access button does not impact the operability of the extension.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/users/sms/index.html b/users/sms/index.html new file mode 100644 index 00000000..6f8225d4 --- /dev/null +++ b/users/sms/index.html @@ -0,0 +1,2051 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Sending SMS - App Connect for RingEX + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Sending SMS

+

App Connect has the ability to send and receive SMS messages. You can access this functionality from the Messages tab and works more or less like your phone. Click on the conversation you want to view, and then send messages to that individual or group.

+

SMS templates

+

Engaging with communications from customers can be overwhelming, and responding to the same questions individually can be taxing. SMS templates allow you to compose responses to common inquiries ahead of time. Then when it comes time to author a message, rather than composing your response manually, select from one of your pre-written responses, populate the message into the messaging box, make any small edits you need, and then click send.

+
+

Google Chrome Web store +

+
Use SMS templates to quickly compose responses to common inquiries
+
+

Managing SMS templates

+

The SMS templates used in App Connect are the same templates you create and manage inside of the RingCentral desktop application to ensure consistency between these two clients.

+
+

Google Chrome Web store +

+
Use SMS templates as seen from the RingCentral desktop application
+
+

Logging SMS conversations

+

Similar to call logging, App Connect can also log SMS messages. To help prevent a CRM from being overwhelmed by individual records for each SMS, App Connect creates a single CRM record that contains a digest of all the SMS messages sent between you and a recipient sent in a single day.

+

SMS logging settings

+ + + + + + + + + + + + + + + + + +
SettingDescription
Log SMS conversations automaticallyThis toggles the auto log feature which will always attemp to log your SMS messages unless any conflict is found.
Open call SMS logging page after messageThis is a sub-setting under auto log. When enabled, App Connect will open a logging page when an SMS message is sent. It only prompts you in this manner for the first message logged that day.
+

Logging SMS conversations follows many of the same rules as logging phone calls, especially as it relates to resolving conflicts and so forth. Please consult call logging for more information.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file
    +
  1. +

    Login to Bullhorn.

    +
    2. +
  2. +

    While visiting a Bullhorn application page, click the quick access badge to open or bring the dialer to the foreground.

    +
    3. +
  3. +

    Navigate to the Settings screen in App Connect, and find the option labeled "Bullhorn."

    +

    Connect to Bullhorn

    +
    4. +
  4. +

    Click the "Connect" button.

    +
    5. +
  5. +

    A window will be opened prompting you to enter your Bullhorn username and password. Login to Bullhorn.

    +
    6. +