@acrobits/ipc-sdk 0.10.1 → 0.11.2-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/docs/assets/hierarchy.js +1 -0
  2. package/docs/assets/icons.js +17 -14
  3. package/docs/assets/icons.svg +1 -1
  4. package/docs/assets/main.js +5 -4
  5. package/docs/assets/navigation.js +1 -1
  6. package/docs/assets/search.js +1 -1
  7. package/docs/assets/style.css +1446 -1225
  8. package/docs/classes/IPCManager.html +91 -71
  9. package/docs/enums/IPCEvents.html +10 -8
  10. package/docs/hierarchy.html +1 -1
  11. package/docs/index.html +10 -8
  12. package/docs/interfaces/DetailedContactURI.html +6 -6
  13. package/docs/interfaces/ILogger.html +7 -7
  14. package/docs/modules.html +1 -17
  15. package/docs/types/BaseContactItem.html +14 -0
  16. package/docs/types/CloudUsernameContactItem.html +6 -0
  17. package/docs/types/ContactItem.html +2 -2
  18. package/docs/types/ContactLabel.html +2 -2
  19. package/docs/types/ContactType.html +2 -2
  20. package/docs/types/ContactURI.html +5 -4
  21. package/docs/types/DetailedContactItem.html +23 -0
  22. package/docs/types/HostType.html +2 -2
  23. package/docs/types/IPCContext.html +3 -3
  24. package/docs/types/IpcProtocolVersion.html +2 -2
  25. package/docs/types/UnsubscribeCallback.html +2 -2
  26. package/docs/types/UriContactItem.html +3 -0
  27. package/lib/index.d.ts +238 -34
  28. package/lib/ipc-sdk.js +1230 -824
  29. package/lib/ipc-sdk.js.map +1 -1
  30. package/lib/ipc-sdk.umd.cjs +4 -4
  31. package/lib/ipc-sdk.umd.cjs.map +1 -1
  32. package/lib/tsdoc-metadata.json +1 -1
  33. package/package.json +9 -9
  34. package/docs/interfaces/BaseContactItem.html +0 -8
  35. package/docs/interfaces/CloudUsernameContactItem.html +0 -10
  36. package/docs/interfaces/DetailedContactItem.html +0 -17
  37. package/docs/interfaces/UriContactItem.html +0 -10
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPCContext | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Acrobits IPC SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Acrobits IPC SDK</a></li><li><a href="IPCContext.html">IPCContext</a></li></ul><h1>Type alias IPCContext</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">IPCContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;host&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;standalone&quot;</span></div><div class="tsd-comment tsd-typography"><p>Defines the context the web app is running under.</p>
2
- </div><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>The value <code>host</code> means that the app is embedded inside a native Acrobits Cloudsoftphone app.</p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPCContext | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Acrobits IPC SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">IPCContext</a></li></ul><h1>Type Alias IPCContext</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">IPCContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;host&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;standalone&quot;</span></div><div class="tsd-comment tsd-typography"><p>Defines the context the web app is running under.</p>
2
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The value <code>host</code> means that the app is embedded inside a native Acrobits Cloudsoftphone app.</p>
3
3
  <p>The value <code>standalone</code> means that the app is running as a standalone web app.</p>
4
- </div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/IPCContext.ts:11</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Acrobits IPC SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
4
+ </div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/IPCContext.ts:11</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Acrobits IPC SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,2 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IpcProtocolVersion | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Acrobits IPC SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Acrobits IPC SDK</a></li><li><a href="IpcProtocolVersion.html">IpcProtocolVersion</a></li></ul><h1>Type alias IpcProtocolVersion</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Ipc<wbr/>Protocol<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;0.1&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.4&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.5&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.6&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.7&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.9&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;0.10&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;2.0&quot;</span></div><div class="tsd-comment tsd-typography"><p>Supported versions of the IPC Protocol.</p>
2
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:2205</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Acrobits IPC SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IpcProtocolVersion | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Acrobits IPC SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">IpcProtocolVersion</a></li></ul><h1>Type Alias IpcProtocolVersion</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">IpcProtocolVersion</span><span class="tsd-signature-symbol">:</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.1&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.2&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.3&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.4&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.5&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.6&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.7&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.8&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.9&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;0.10&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;2.0&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;2.1&quot;</span></div><div class="tsd-comment tsd-typography"><p>Supported versions of the IPC Protocol.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:2658</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Acrobits IPC SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,2 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnsubscribeCallback | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Acrobits IPC SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Acrobits IPC SDK</a></li><li><a href="UnsubscribeCallback.html">UnsubscribeCallback</a></li></ul><h1>Type alias UnsubscribeCallback</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Unsubscribe<wbr/>Callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>A callback function to unsubscribe the registered listener.</p>
2
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/UnsubscribeCallback.ts:7</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Acrobits IPC SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnsubscribeCallback | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Acrobits IPC SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">UnsubscribeCallback</a></li></ul><h1>Type Alias UnsubscribeCallback</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">UnsubscribeCallback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>A callback function to unsubscribe the registered listener.</p>
2
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/UnsubscribeCallback.ts:7</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Acrobits IPC SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UriContactItem | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Acrobits IPC SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">UriContactItem</a></li></ul><h1>Type Alias UriContactItem</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">UriContactItem</span><span class="tsd-signature-symbol">:</span> <a href="BaseContactItem.html" class="tsd-signature-type tsd-kind-type-alias">BaseContactItem</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;uri&quot;</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">uri</span><span class="tsd-signature-symbol">:</span> <a href="ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Defines the properties of a SIP URI based contact item.</p>
2
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;uri&quot;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">uri</span><span class="tsd-signature-symbol">: </span><a href="ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a></h5><div class="tsd-comment tsd-typography"><p>URI or number associated with the contact with prefix (e.g. sip: or tel:)</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:3920</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Acrobits IPC SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/lib/index.d.ts CHANGED
@@ -1,13 +1,50 @@
1
+ import { CloudUsernameDetailedContactItem } from '@acrobits/ipc-protocol';
2
+ import { DetailedContactItem as DetailedContactItem_2 } from '@acrobits/ipc-protocol';
3
+
1
4
  /**
2
5
  * Defines the base properties of a contact item.
3
6
  *
4
7
  * @public
5
8
  */
6
- export declare interface BaseContactItem {
9
+ export declare type BaseContactItem = {
10
+ /**
11
+ * Unique ID for the contact item.
12
+ *
13
+ * @remarks
14
+ * This value is required since v2.1.
15
+ *
16
+ * @since 2.1
17
+ */
18
+ contactId?: string;
7
19
  /**
8
20
  * Type of contact item.
9
21
  */
10
22
  type: ContactType;
23
+ /**
24
+ * Cloud ID associated with the contact.
25
+ *
26
+ * @deprecated Use {@link CloudContact.cloudId} instead.
27
+ */
28
+ cloudId?: string;
29
+ /**
30
+ * Network ID for the contact.
31
+ *
32
+ * @deprecated Use {@link CloudContact.networkId} instead.
33
+ */
34
+ networkId?: string;
35
+ };
36
+
37
+ /**
38
+ * Defines cloud-username contact information.
39
+ *
40
+ * @public
41
+ * @since 2.1
42
+ */
43
+ declare type CloudContact = {
44
+ /**
45
+ * Cloud username associated with the contact.
46
+ */
47
+ cloudUsername: string;
11
48
  /**
12
49
  * Cloud ID associated with the contact.
13
50
  */
@@ -16,27 +53,47 @@ export declare interface BaseContactItem {
16
53
  * Network ID for the contact.
17
54
  */
18
55
  networkId: string;
19
- }
56
+ };
20
57
 
21
58
  /**
22
59
  * Defines the properties of a CloudUsername based contact item.
23
60
  *
24
61
  * @public
25
62
  */
26
- export declare interface CloudUsernameContactItem extends BaseContactItem {
63
+ export declare type CloudUsernameContactItem = BaseContactItem & {
27
64
  type: 'cloudUsername';
65
+ /**
66
+ * Cloud user associated with the contact.
67
+ *
68
+ * @since 2.1
69
+ */
70
+ contactUser: CloudContact;
28
71
  /**
29
72
  * Cloud username associated with the contact.
73
+ *
74
+ * @deprecated Use {@link CloudContact.cloudUsername} instead.
30
75
  */
31
- cloudUsername: string;
32
- }
76
+ cloudUsername?: string;
77
+ };
78
+
79
+ /**
80
+ * Defines an email for a contact item.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const email1 = 'test@example.com';
85
+ * const email2 = 'test@example.com';
86
+ *
87
+ * @public
88
+ */
89
+ declare type ContactEmail = `${string}@${string}`;
33
90
 
34
91
  /**
35
- * Represents either a CloudUsername or Sip URI based contact item.
92
+ * Represents either a CloudUsername, Number or Sip URI based contact item.
36
93
  *
37
94
  * @public
38
95
  */
39
- export declare type ContactItem = CloudUsernameContactItem | UriContactItem;
96
+ export declare type ContactItem = CloudUsernameContactItem | UriContactItem | NumberContactItem | EmailContactItem;
40
97
 
41
98
  /**
42
99
  * Label of contact being described.
@@ -45,12 +102,25 @@ export declare type ContactItem = CloudUsernameContactItem | UriContactItem;
45
102
  */
46
103
  export declare type ContactLabel = 'home' | 'work' | 'mobile' | 'other';
47
104
 
105
+ /**
106
+ * Defines a number for a contact item. Number should be in E.164 format.
107
+ *
108
+ * @example
109
+ * ```ts
110
+ * const number1 = '1234567890';
111
+ * const number2 = '+1234567890';
112
+ * ```
113
+ *
114
+ * @public
115
+ */
116
+ declare type ContactNumber = `${number}` | `+${number}`;
117
+
48
118
  /**
49
119
  * Defines a basic Contact Item type.
50
120
  *
51
121
  * @public
52
122
  */
53
- export declare type ContactType = 'cloudUsername' | 'uri';
123
+ export declare type ContactType = 'cloudUsername' | 'uri' | 'number' | 'email';
54
124
 
55
125
  /**
56
126
  * Defines a URI for a contact item.
@@ -63,35 +133,46 @@ export declare type ContactType = 'cloudUsername' | 'uri';
63
133
  *
64
134
  * @public
65
135
  */
66
- export declare type ContactURI = `sip:${string}` | `tel:${string}` | `sips:${string}` | `tels:${string}`;
136
+ export declare type ContactURI = `sip:${string}` | `tel:${ContactNumber}` | `sips:${string}` | `tels:${ContactNumber}`;
67
137
 
68
138
  /**
69
- * Defines a {@link DetailedContactItem} object with additional fields like profile picture,
70
- * SIP URIs and contact type etc.
139
+ * Defines an email and its associated label.
71
140
  *
72
141
  * @public
142
+ * @since 2.1
73
143
  */
74
- export declare interface DetailedContactItem {
144
+ declare type DetailedContactEmail = {
75
145
  /**
76
- * Type of contact item.
146
+ * Email associated with the contact.
77
147
  */
78
- type: ContactType;
79
- /**
80
- * Cloud ID associated with the contact.
81
- */
82
- cloudId: string;
83
- /**
84
- * Cloud username associated with the contact.
85
- */
86
- cloudUsername: string;
148
+ email: ContactEmail;
87
149
  /**
88
- * Network ID for the contact.
150
+ * Label associated with this email.
89
151
  */
90
- networkId: string;
152
+ label: ContactLabel;
153
+ };
154
+
155
+ /**
156
+ * Defines a unified contact item with all possible contact methods.
157
+ * At least one contact method (contactUser, uri, or numbers) should be defined.
158
+ *
159
+ * @remarks
160
+ * This is a unified type that replaces the previous union type of different contact subtypes.
161
+ * For backward compatibility, the contactId field is optional but it is required since v2.1.
162
+ *
163
+ * @public
164
+ * @since 2.1
165
+ */
166
+ export declare type DetailedContactItem = {
91
167
  /**
92
- * URI or number associated with the contact with prefix (e.g. sip: or tel:)
168
+ * Unique ID for the contact item.
169
+ *
170
+ * @remarks
171
+ * This value is required since v2.1.
172
+ *
173
+ * @since 2.1
93
174
  */
94
- uri: ContactURI | DetailedContactURI[];
175
+ contactId?: string;
95
176
  /**
96
177
  * Name of the contact entry.
97
178
  */
@@ -100,16 +181,49 @@ export declare interface DetailedContactItem {
100
181
  * An optional URL for the contact's profile picture.
101
182
  */
102
183
  profilePictureUrl?: string;
103
- }
184
+ /**
185
+ * Cloud contact information.
186
+ * Contains cloudUsername, cloudId, and networkId.
187
+ */
188
+ contactUser?: CloudContact;
189
+ /**
190
+ * URIs associated with the contact.
191
+ */
192
+ uri?: DetailedContactURI[];
193
+ /**
194
+ * Numbers associated with the contact.
195
+ */
196
+ numbers?: DetailedContactNumber[];
197
+ /**
198
+ * Emails associated with the contact.
199
+ */
200
+ emails?: DetailedContactEmail[];
201
+ };
104
202
 
105
203
  /**
106
- * Defines a SIP URI and it's associated label.
204
+ * Defines a number and its associated label.
205
+ *
206
+ * @public
207
+ */
208
+ declare type DetailedContactNumber = {
209
+ /**
210
+ * Number associated with the contact.
211
+ */
212
+ number: ContactNumber;
213
+ /**
214
+ * Label associated with this number.
215
+ */
216
+ label: ContactLabel;
217
+ };
218
+
219
+ /**
220
+ * Defines a SIP URI and its associated label.
107
221
  *
108
222
  * @public
109
223
  */
110
224
  export declare interface DetailedContactURI {
111
225
  /**
112
- * URI or number associated with the contact with prefix (e.g. sip: or tel:)
226
+ * URI associated with the contact with prefix (e.g. sip: or tel:)
113
227
  */
114
228
  uri: ContactURI;
115
229
  /**
@@ -118,6 +232,19 @@ export declare interface DetailedContactURI {
118
232
  label: ContactLabel;
119
233
  }
120
234
 
235
+ /**
236
+ * Defines the properties of an email based contact item.
237
+ *
238
+ * @public
239
+ */
240
+ declare type EmailContactItem = BaseContactItem & {
241
+ type: 'email';
242
+ /**
243
+ * Email associated with the contact.
244
+ */
245
+ emails: ContactEmail[];
246
+ };
247
+
121
248
  /**
122
249
  * Type of the Host app. Valid values are only `webrtc`, `desktop`, `ios`, `android`, `ios_jitsi`
123
250
  * and `electron`.
@@ -169,7 +296,11 @@ export declare const enum IPCEvents {
169
296
  /**
170
297
  * Event that is fired when the `Host` app sends a new PUSH TOKEN.
171
298
  */
172
- PushToken = "PUSH TOKEN"
299
+ PushToken = "PUSH TOKEN",
300
+ /**
301
+ * Event that is fired when the `Host` app sends a REQUEST LOGS event.
302
+ */
303
+ RequestLogs = "REQUEST LOGS"
173
304
  }
174
305
 
175
306
  /**
@@ -238,6 +369,21 @@ export declare class IPCManager {
238
369
  /**
239
370
  * Requests the `Host` app to open the contact selection UI.
240
371
  *
372
+ * @param corelationId - An identifier for the message stream
373
+ * @param options - Configuration options for contact selection:
374
+ * - `mode`: Whether to allow 'single' or 'multi' contact selection
375
+ * - `currentContacts`: For multi-select mode, the list of currently selected contacts
376
+ * - `contactType`: The type of contacts to select ('cloudUsername' or 'uri'). Defaults to 'cloudUsername'
377
+ * - `includeOffNetworkContacts`: Whether to include contacts not on the network. Defaults to false
378
+ *
379
+ * @returns A collection of {@link ContactItem} objects which the user selected
380
+ */
381
+ selectContacts(corelationId: number, options: SelectContactsOptions): Promise<ContactItem[]>;
382
+ /**
383
+ * Requests the `Host` app to open the contact selection UI.
384
+ *
385
+ * @deprecated Use the `selectContacts` method with the `options` parameter instead.
386
+ *
241
387
  * @remarks
242
388
  * When requesting a `single` contact, the `Host` app will return immediately
243
389
  * after contact selection.
@@ -254,6 +400,8 @@ export declare class IPCManager {
254
400
  /**
255
401
  * Requests the `Host` app to open the contact selection UI.
256
402
  *
403
+ * @deprecated Use the `selectContacts` method with the `options` parameter instead.
404
+ *
257
405
  * @remarks
258
406
  * When requesting a `multi` contact, the user will have to manually close the contact selection
259
407
  * UI. The `Host` app will return the selected contacts when the user closes the UI.
@@ -272,6 +420,8 @@ export declare class IPCManager {
272
420
  * `corelationId`.
273
421
  */
274
422
  selectContacts(corelationId: number, mode: 'multi', currentContacts: ContactItem[], contactType?: ContactType): Promise<ContactItem[]>;
423
+ private selectContacts_V2_0;
424
+ private selectContacts_V2_1;
275
425
  /**
276
426
  * Matches batch of {@link ContactItem} objects against the Host's contact list to fetch detailed
277
427
  * contact information.
@@ -281,7 +431,7 @@ export declare class IPCManager {
281
431
  * @returns A collection of {@link DetailedContactItem} objects which were matched against the
282
432
  * Host's contact list.
283
433
  */
284
- matchContacts(contacts: ContactItem[]): Promise<DetailedContactItem[]>;
434
+ matchContacts(contacts: ContactItem[]): Promise<Record<string, DetailedContactItem_2 | null | undefined> | CloudUsernameDetailedContactItem[]>;
285
435
  /**
286
436
  * Requests the `Host` app to provide the Push Token for the current device.
287
437
  *
@@ -309,6 +459,25 @@ export declare class IPCManager {
309
459
  * @remarks
310
460
  * Any additional data to be posted alongside the URL is included with the `data` parameter.
311
461
  *
462
+ * @example
463
+ *
464
+ * ```ts
465
+ * // import the IPCManager
466
+ * import { IPCManager } from '@acrobits/ipc-sdk';
467
+ *
468
+ * // create an instance of IPCManager
469
+ * const manager = new IPCManager();
470
+ *
471
+ * // open the URL with additional data
472
+ * const url = 'https://example.com';
473
+ * const data = {
474
+ * name: 'John Doe',
475
+ * age: 30
476
+ * };
477
+ *
478
+ * manager.openUrl(url, data);
479
+ * ```
480
+ *
312
481
  * @param url - URL to open in the external browser
313
482
  * @param data - _Optional_. Any additional data to be sent along with the URL
314
483
  */
@@ -352,6 +521,22 @@ export declare class IPCManager {
352
521
  * @returns An unsubscribe callback to remove the listener.
353
522
  */
354
523
  onPushToken(callback: (token: string, appId: string, selector: string) => void): () => boolean | undefined;
524
+ /**
525
+ * Registers a callback to be invoked when a {@link IPCEvents.RequestLogs} event is received.
526
+ *
527
+ * @remarks
528
+ * The Host app can request logs from the Client app by sending a RequestLogs event. The callback
529
+ * will receive a skipCompression parameter indicating whether the logs should be compressed or not.
530
+ *
531
+ * When skipCompression is true, the logs should be sent uncompressed. When false or undefined,
532
+ * the logs should be compressed before sending.
533
+ *
534
+ * @param callback - A callback function to be invoked when a {@link IPCEvents.RequestLogs} event
535
+ * is received. The callback receives an optional skipCompression parameter.
536
+ *
537
+ * @returns An unsubscribe callback to remove the listener.
538
+ */
539
+ onRequestLogsMessage(callback: (skipCompression?: boolean) => void): () => boolean | undefined;
355
540
  private evaluateContext;
356
541
  }
357
542
 
@@ -360,7 +545,26 @@ export declare class IPCManager {
360
545
  *
361
546
  * @public
362
547
  */
363
- export declare type IpcProtocolVersion = '0.1' | '0.2' | '0.3' | '0.4' | '0.5' | '0.6' | '0.7' | '0.8' | '0.9' | '0.10' | '2.0';
548
+ export declare type IpcProtocolVersion = '0.1' | '0.2' | '0.3' | '0.4' | '0.5' | '0.6' | '0.7' | '0.8' | '0.9' | '0.10' | '2.0' | '2.1';
549
+
550
+ /**
551
+ * Defines the properties of a number based contact item.
552
+ *
553
+ * @public
554
+ */
555
+ declare type NumberContactItem = BaseContactItem & {
556
+ type: 'number';
557
+ /**
558
+ * Number associated with the contact.
559
+ */
560
+ numbers: ContactNumber[];
561
+ };
562
+
563
+ declare type SelectContactsOptions = {
564
+ mode: 'single' | 'multi';
565
+ currentContacts?: ContactItem[];
566
+ resultTypes?: ContactType[];
567
+ };
364
568
 
365
569
  /**
366
570
  * A callback function to unsubscribe the registered listener.
@@ -374,12 +578,12 @@ export declare type UnsubscribeCallback = () => void;
374
578
  *
375
579
  * @public
376
580
  */
377
- export declare interface UriContactItem extends BaseContactItem {
581
+ export declare type UriContactItem = BaseContactItem & {
378
582
  type: 'uri';
379
583
  /**
380
584
  * URI or number associated with the contact with prefix (e.g. sip: or tel:)
381
585
  */
382
586
  uri: ContactURI;
383
- }
587
+ };
384
588
 
385
589
  export { }