@acrobits/ipc-sdk 0.9.1 → 0.9.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.
@@ -1,10 +1,10 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><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(() => 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="UriContactItem.html">UriContactItem</a></li></ul><h1>Interface UriContactItem</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defines the properties of a SIP URI based contact item.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UriContactItem</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#cloudId">cloudId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#networkId">networkId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;uri&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#uri">uri</a><span class="tsd-signature-symbol">: </span><a href="../types/ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#UriContactItem">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="BaseContactItem.html" class="tsd-signature-type tsd-kind-interface">BaseContactItem</a><ul class="tsd-hierarchy"><li><span class="target">UriContactItem</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:3196</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="UriContactItem.html#cloudId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id</span></a>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UriContactItem</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#cloudId">cloudId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#networkId">networkId</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;uri&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="UriContactItem.html#uri">uri</a><span class="tsd-signature-symbol">: </span><a href="../types/ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#UriContactItem">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="BaseContactItem.html" class="tsd-signature-type tsd-kind-interface">BaseContactItem</a><ul class="tsd-hierarchy"><li><span class="target">UriContactItem</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:3234</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="UriContactItem.html#cloudId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id</span></a>
3
3
  <a href="UriContactItem.html#networkId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a>
4
4
  <a href="UriContactItem.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
5
5
  <a href="UriContactItem.html#uri" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uri</span></a>
6
6
  </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="cloudId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cloud<wbr/>Id</span><a href="#cloudId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cloud<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Cloud ID associated with the contact.</p>
7
7
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseContactItem.html">BaseContactItem</a>.<a href="BaseContactItem.html#cloudId">cloudId</a></p><ul><li>Defined in ipc-protocol/lib/index.d.ts:85</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="networkId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>network<wbr/>Id</span><a href="#networkId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">network<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Network ID for the contact.</p>
8
8
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseContactItem.html">BaseContactItem</a>.<a href="BaseContactItem.html#networkId">networkId</a></p><ul><li>Defined in ipc-protocol/lib/index.d.ts:89</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;uri&quot;</span></div><div class="tsd-comment tsd-typography"><p>Type of contact item.</p>
9
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BaseContactItem.html">BaseContactItem</a>.<a href="BaseContactItem.html#type">type</a></p><ul><li>Defined in ipc-protocol/lib/index.d.ts:3197</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uri" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uri</span><span class="tsd-signature-symbol">:</span> <a href="../types/ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a></div><div class="tsd-comment tsd-typography"><p>URI or number associated with the contact with prefix (e.g. sip: or tel:)</p>
10
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:3201</li></ul></aside></section></section></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><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cloudId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id</span></a><a href="#networkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uri" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uri</span></a></div></details></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>
9
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BaseContactItem.html">BaseContactItem</a>.<a href="BaseContactItem.html#type">type</a></p><ul><li>Defined in ipc-protocol/lib/index.d.ts:3235</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uri" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uri</span><span class="tsd-signature-symbol">:</span> <a href="../types/ContactURI.html" class="tsd-signature-type tsd-kind-type-alias">ContactURI</a></div><div class="tsd-comment tsd-typography"><p>URI or number associated with the contact with prefix (e.g. sip: or tel:)</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:3239</li></ul></aside></section></section></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><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cloudId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id</span></a><a href="#networkId" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>network<wbr/>Id</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uri" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uri</span></a></div></details></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,2 +1,2 @@
1
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:2190</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>
2
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:2201</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>
package/lib/ipc-sdk.js CHANGED
@@ -9,7 +9,7 @@ var w = /* @__PURE__ */ ((n) => (n.BadgeQuery = "BADGE QUERY", n.Lifecycle = "LI
9
9
  Object.prototype.hasOwnProperty.call(r, s) && (e[s] = r[s]);
10
10
  }, q(n, t);
11
11
  };
12
- function M(n, t) {
12
+ function C(n, t) {
13
13
  if (typeof t != "function" && t !== null)
14
14
  throw new TypeError("Class extends value " + String(t) + " is not a constructor or null");
15
15
  q(n, t);
@@ -206,7 +206,7 @@ function U(n) {
206
206
  n();
207
207
  }
208
208
  var Z = function(n) {
209
- M(t, n);
209
+ C(t, n);
210
210
  function t(e) {
211
211
  var r = n.call(this) || this;
212
212
  return r.isStopped = !1, e ? (r.destination = e, me(e) && e.add(r)) : r.destination = $e, r;
@@ -272,7 +272,7 @@ var Le = function() {
272
272
  }
273
273
  }, n;
274
274
  }(), H = function(n) {
275
- M(t, n);
275
+ C(t, n);
276
276
  function t(e, r, s) {
277
277
  var i = n.call(this) || this, o;
278
278
  if (S(e) || !e)
@@ -392,7 +392,7 @@ function ke(n) {
392
392
  function Ne(n) {
393
393
  return S(n == null ? void 0 : n.lift);
394
394
  }
395
- function Ce(n) {
395
+ function Me(n) {
396
396
  return function(t) {
397
397
  if (Ne(t))
398
398
  return t.lift(function(e) {
@@ -405,11 +405,11 @@ function Ce(n) {
405
405
  throw new TypeError("Unable to lift unknown Observable type");
406
406
  };
407
407
  }
408
- function Me(n, t, e, r, s) {
408
+ function Ce(n, t, e, r, s) {
409
409
  return new Ve(n, t, e, r, s);
410
410
  }
411
411
  var Ve = function(n) {
412
- M(t, n);
412
+ C(t, n);
413
413
  function t(e, r, s, i, o, a) {
414
414
  var c = n.call(this, e) || this;
415
415
  return c.onFinalize = o, c.shouldUnsubscribe = a, c._next = r ? function(u) {
@@ -448,7 +448,7 @@ var Ve = function(n) {
448
448
  n(this), this.name = "ObjectUnsubscribedError", this.message = "object unsubscribed";
449
449
  };
450
450
  }), xe = function(n) {
451
- M(t, n);
451
+ C(t, n);
452
452
  function t() {
453
453
  var e = n.call(this) || this;
454
454
  return e.closed = !1, e.currentObservers = null, e.observers = [], e.isStopped = !1, e.hasError = !1, e.thrownError = null, e;
@@ -528,7 +528,7 @@ var Ve = function(n) {
528
528
  return new ae(e, r);
529
529
  }, t;
530
530
  }(B), ae = function(n) {
531
- M(t, n);
531
+ C(t, n);
532
532
  function t(e, r) {
533
533
  var s = n.call(this) || this;
534
534
  return s.destination = e, s.source = r, s;
@@ -552,7 +552,7 @@ var Ve = function(n) {
552
552
  },
553
553
  delegate: void 0
554
554
  }, qe = function(n) {
555
- M(t, n);
555
+ C(t, n);
556
556
  function t(e, r) {
557
557
  return n.call(this) || this;
558
558
  }
@@ -571,7 +571,7 @@ var Ve = function(n) {
571
571
  },
572
572
  delegate: void 0
573
573
  }, Ge = function(n) {
574
- M(t, n);
574
+ C(t, n);
575
575
  function t(e, r) {
576
576
  var s = n.call(this, e, r) || this;
577
577
  return s.scheduler = e, s.work = r, s.pending = !1, s;
@@ -620,7 +620,7 @@ var Ve = function(n) {
620
620
  return e === void 0 && (e = 0), new this.schedulerActionCtor(this, t).schedule(r, e);
621
621
  }, n.now = Qe.now, n;
622
622
  }(), Be = function(n) {
623
- M(t, n);
623
+ C(t, n);
624
624
  function t(e, r) {
625
625
  r === void 0 && (r = ce.now);
626
626
  var s = n.call(this, e, r) || this;
@@ -668,9 +668,9 @@ function Ke(n) {
668
668
  return n instanceof Date && !isNaN(n);
669
669
  }
670
670
  function O(n, t) {
671
- return Ce(function(e, r) {
671
+ return Me(function(e, r) {
672
672
  var s = 0;
673
- e.subscribe(Me(r, function(i) {
673
+ e.subscribe(Ce(r, function(i) {
674
674
  r.next(n.call(t, i, s++));
675
675
  }));
676
676
  });
@@ -687,11 +687,11 @@ function Je(n, t, e) {
687
687
  }
688
688
  function Xe(n, t, e) {
689
689
  var r = S(n) || t || e ? { next: n, error: t, complete: e } : n;
690
- return r ? Ce(function(s, i) {
690
+ return r ? Me(function(s, i) {
691
691
  var o;
692
692
  (o = r.subscribe) === null || o === void 0 || o.call(r);
693
693
  var a = !0;
694
- s.subscribe(Me(i, function(c) {
694
+ s.subscribe(Ce(i, function(c) {
695
695
  var u;
696
696
  (u = r.next) === null || u === void 0 || u.call(r, c), i.next(c);
697
697
  }, function() {
@@ -706,10 +706,10 @@ function Xe(n, t, e) {
706
706
  }));
707
707
  }) : Ee;
708
708
  }
709
- var Ze = Object.defineProperty, et = (n, t, e) => t in n ? Ze(n, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : n[t] = e, C = (n, t, e) => (et(n, typeof t != "symbol" ? t + "" : t, e), e);
709
+ var Ze = Object.defineProperty, et = (n, t, e) => t in n ? Ze(n, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : n[t] = e, M = (n, t, e) => (et(n, typeof t != "symbol" ? t + "" : t, e), e);
710
710
  class d extends Error {
711
711
  constructor(t) {
712
- super(`Incorrect context (${t}). Cannot perform the requested operation.`), C(this, "context"), this.context = t;
712
+ super(`Incorrect context (${t}). Cannot perform the requested operation.`), M(this, "context"), this.context = t;
713
713
  }
714
714
  }
715
715
  class I extends Error {
@@ -1262,11 +1262,11 @@ function ne(n, t) {
1262
1262
  function Et(n, t) {
1263
1263
  return ne(n, t) === 1;
1264
1264
  }
1265
- function Ct(n, t) {
1265
+ function Mt(n, t) {
1266
1266
  return ne(n, t) >= 0;
1267
1267
  }
1268
1268
  const ye = "2.0";
1269
- class Mt {
1269
+ class Ct {
1270
1270
  /**
1271
1271
  * Create a new instance of the {@link IpcHelper | IPC Protocol Helper}.
1272
1272
  *
@@ -1277,7 +1277,7 @@ class Mt {
1277
1277
  * @param logService - An instance of a logging service or utility
1278
1278
  */
1279
1279
  constructor(t, e) {
1280
- if (C(this, "negotiatedProtocolVersion"), C(this, "currentContext"), C(this, "incomingMessages$"), C(this, "inIframe", !1), C(this, "embeddedResult"), C(this, "iframePort1"), C(this, "iframePort2"), this.supportedVersions = t, this.logService = e, this.incomingMessages$ = new xe(), this.supportedVersions = t.filter((r) => Ct(r, ye)), !this.supportedVersions.length)
1280
+ if (M(this, "negotiatedProtocolVersion"), M(this, "currentContext"), M(this, "incomingMessages$"), M(this, "inIframe", !1), M(this, "embeddedResult"), M(this, "iframePort1"), M(this, "iframePort2"), this.supportedVersions = t, this.logService = e, this.incomingMessages$ = new xe(), this.supportedVersions = t.filter((r) => Mt(r, ye)), !this.supportedVersions.length)
1281
1281
  throw new le(t, ye);
1282
1282
  this.negotiatedProtocolVersion = this.supportedVersions[0], this.embeddedResult = null, this.iframePort2 = null;
1283
1283
  }
@@ -1898,6 +1898,22 @@ class Mt {
1898
1898
  f(this.logReceived())
1899
1899
  );
1900
1900
  }
1901
+ /**
1902
+ * Sends a {@link RequestLogsMessageReply} to the Host app, to reply to a
1903
+ * {@link RequestLogsMessage} which had `responseType` set to `file`.
1904
+ *
1905
+ * @param fileId - UUIDv4 string to identify the file
1906
+ * @param fileHash - SHA256 hash of the file
1907
+ * @param fileSize - Size of the file in bytes
1908
+ * @param format - Format of the file. Can be either `gzip` or `text`
1909
+ * @param replyTo - The message ID to which the reply should be sent
1910
+ */
1911
+ sendRequestLogsMessageReply(t, e, r, s, i) {
1912
+ if (!this.isEmbedded())
1913
+ throw new d(this.currentContext);
1914
+ const o = "REQUEST LOGS", a = this.createMessage(o, !1, i);
1915
+ a.fileId = t, a.fileHash = e, a.fileSize = r, a.format = s, this.logCreated(o, a), this.port2.postMessage(a), this.logSent(o, a);
1916
+ }
1901
1917
  /**
1902
1918
  * Send a {@link ViewTransitionMessage} to the `Host` app, notifying it of a view transition
1903
1919
  * happening in the `Client` app.
@@ -2561,7 +2577,7 @@ class Rt {
2561
2577
  x(this, "logger");
2562
2578
  x(this, "helper");
2563
2579
  x(this, "listeners");
2564
- this.logger = t ?? console, this.helper = new Mt(It, this.logger), this.listeners = /* @__PURE__ */ new Map(), this.listeners.set(w.BadgeQuery, /* @__PURE__ */ new Set()), this.listeners.set(w.Lifecycle, /* @__PURE__ */ new Set()), this.listeners.set(w.PushToken, /* @__PURE__ */ new Set());
2580
+ this.logger = t ?? console, this.helper = new Ct(It, this.logger), this.listeners = /* @__PURE__ */ new Map(), this.listeners.set(w.BadgeQuery, /* @__PURE__ */ new Set()), this.listeners.set(w.Lifecycle, /* @__PURE__ */ new Set()), this.listeners.set(w.PushToken, /* @__PURE__ */ new Set());
2565
2581
  }
2566
2582
  /**
2567
2583
  * Returns whether the app is running inside a native WebView (`host` context) or as a