@acrobits/ipc-sdk 0.9.3 → 0.10.0
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.
- package/docs/assets/search.js +1 -1
- package/docs/classes/IPCManager.html +21 -19
- package/docs/interfaces/UriContactItem.html +3 -3
- package/docs/types/HostType.html +1 -1
- package/docs/types/IpcProtocolVersion.html +1 -1
- package/lib/index.d.ts +4 -0
- package/lib/ipc-sdk.js +66 -81
- package/lib/ipc-sdk.js.map +1 -1
- package/lib/ipc-sdk.umd.cjs +3 -3
- package/lib/ipc-sdk.umd.cjs.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +2 -2
package/docs/assets/search.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
window.searchData = "data:application/octet-stream;base64,
|
|
1
|
+
window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61b33PbOA7+X5RX1w0pkrbzdpe9mctM76bX2exLJ9NxZCbRVJG0ktxuJ5P//UhJtgAF0K/sUysbwAfiAyCQZl6CIvtZBldfX4LvcXoIrrarIN0/2+AquPl8/a8fNq3KYBUci8R9YtPjc/nx/Pn6qXpO3JdRsi9L64wEwevqZEeYs6F/7g+P9n9HW/watHSB5IDRVZDvCyeGfCKRPsUPNvoVJXYYCIotwvl8LJ9+z77bdBgHis3AkYiD/+zT/aMtzkitoY/dV4M8aCHP1qIsLaviGFXZqLkLLMt6f/IOuH8p1RnxKSurUahWaClGlGTHw81hfEVnuXch3Za2qJ8n4QHppaiHuMyT/a//TsHEsksRk+xxQsZdnMU6nKo8fIjLD3kR/9hXdmau2CSfgHoW+3tQk7isbGqLcny5QHIxtjRSKAUrsrJ/jZdIJzeD0x5WXF5naWqjyo7XCpZdjpnax6yKXWAOf7jAxVk6ikxpzMG/VF33PNjKFs9xaq8nhplQWIodp3G9jDaOU5ZOqizFL23ibPh17KNqPLnfiC/Ffd5X0dNk2L70UtTC/nm0ZfX2vcwBEwpLse/92HKbH5ryH4bFsu9c7T/y/Ist7Xhav5VfipzlNr0tklHETm5x/sb59T4ZR+rkFq8p7QbPL02kxtdH6iz34DyR1tPgBPg3CsuxpxcNlp2BaLQOu+n527fqVz5eKwBtDf7/QazPBsZcWDM2uGDYH/vk2HTgSe+Lt/LLBwMNN0ylbZviTWWfz27EDqV42EfOk57I8FYMzjso9CMGLwbD3Pdy4ng+hjk2pk+ETW31Myu+zwCGGnOhIXvXcO4foZGTfT+fg5aHiWUXMGtbNNmXafukRU7R7E9wp5cEbS3H6ZMt4mYmXuzYYGIOu0Zn6Dudk5e7jdDdIQGVsT5dnHMT85Ox+Gl/bxPaZP3VEpu/w+xHJv03SyzefrmhDbovhu2BFvCbrfZxYg8j1U+Ivb/wOaPDNU95PL+yWOyxpj4XfqjbDDsx2mhmuDJYyqwb4++ZGS4ci3gWeCP/bljqTGoK/JTzqRlu5EX24EQ/x1F1LCzcmExxhtJe4tJA5cNuwrs01loWMH4yOYdw7yx3SoZ69wTYk8IC4H5j/ndWUn3+9PHkpnzzCR9rglW0X428L9DJ0v3xcczSxUmK2aa0/rAHSA/ZKEIrtAggycZX0MgsMv9zX6Sj9luhRQC2KLJRNi9OUtMhcPa5zVp/N9jkX/fFrDHjJo8+F1mVRVnSPxJt7b4RmGX/Ni2P92VUxPfWn4vc76PvPQBCYhBhcPM+bPJiZKdOOUsX720RjwxTWOL9cxRhb3iE6rk4r31TaEOtexrYwKhGAc7d+kxzYnBKotyYv83pO3K3chgH+1dw9RL8aKvsKpDrcL1zag+xTQ7+N+/gNAhmz8/e0F373R/W/+zpJRqRj5fB6uvlKtyu9Ube3a2+njTqL+oPajHhngQlJpCYdE+SEpNILHRPISUWIjHlnhQlppCYdk+aEtNIzLgnQ4kZJLZxT5uV1E5sh8Q2SGzrnrar8HJ9ucNiWyTmSPm6W4XhWhmFxHY4vD7aguRB9IiomaCpwFwIH3NBsiEwHcKHXZCECMyI8JEXJCcCkyJ88AVJi8C8CB9/QTIjMDXCUyA2pCRmR3gWxJaUxAQJT4TYkZKYI+mJkCRHEnMkPRGS5Ej26qUuGLpiMEfSEyFJjiTmSHoiJMmRxBxJT4QkOZKYI+mJkCRHEnMkPRGS5EhijqQnQm6p4pCYI+mJkCRHEnMUeiJCkqMQcxR6IkKxkpu13hosiTkKJdcRwl5Xq9uaJE1iikLPQ0h3QExRqHk3MUWh4TpSiBkK2Q4XYoLCLb8eTFDoWQjJlAsxQaomiEw5hQlSNUFkyilMkPI0hGTKKcyQqhki24LqvXoUG3eFGVKaC6fCBCmWIIUJUhs27gozpGqGdqRNzJBiX0QKE6Q9C4qsII0J0p4FRXY5jQnSknVTY4K0Z0GR/VBjgnQ9HJAlpHvjgadBkcmpMUPa86DoUQJTpD0PikxOjSnSngdFJqfGFGlPhCKTU2OOTM0R2Q8N5sh4IjTJpsEcGU+EJtk0mCPjidAkRwZzZBTb4Q3myNQzHMmm6U1xhi1MgzkyGzbrDObIbLkSNpgis2Mr0zQU1eO5m8vdFH/TjOlu0D5tFV+Cb+3s3t2DfAncy+7q5XUVuJC4f1+7md0/eYj6ZsWfzeXRzoToLIghxWN7JQOAA1XJ65Y2ajYecb0t7fTd+/Ws796qtH694YoPUG/TqW2aJbsXaPNv++w6ZhOK7ZDV4/mcu7MN4tmG0731Gptmii1uqSFYKscPuk/a6epOVfOaJKoCqLth3fY0EigDXMWy0yj307I7DHG6XGa0uvUWHqgCdpUcUK2Pm0Aagwi7zQat1542dloKBpcj+NAexXJRBjmjeGRko7doBSpJc/E637yjVg8CLth1NL8s9FN+16nu2lTncqU9KQSOA2XDJcnpCgjhtwT6kkM9XWcFy4VNi4tXc2e6UwIh4iLkVfq5rEBiaa5049NFX6AHik9zhdscTgMl4KTesErNJcgIXIIEsQEFJFgTeUSwoUFDNlxYnapt/+ah0wSKXBY4vefTPX2wYFA7vGLenvaeDqqgzyAVDNcv4jLq7uqCUAF0wcG/aYxKAo64ek+6v58A2Q6SndU736AGfgJFwWpmuLOBNNDca/Bt1grApOCorK+kRucrqUAblLPgyrm7vkzQKUBDFlzVtKefeCoIQZDCsH13t+9w1c4FhvMpS7vhqDhdVgTEAa8k51WWnkm3zY1DYADUteS6T5bmx/Kpau4OAl3ApOQK2t8m9SfHUA80LsnlafsDb978wNuzoEAyaC4ZSJ/huMPotWHe53nR3LgFnsNC4fK91adDBhyXnOPNfW4yjcEbXXC1U7q+VN+qBbCgn0iun7yZlUADC0Wbt+38qlSbt1zKHLtfh6LzT1mgOYJAGo6I/gAGali19aPb+dpw6edsMNORBqlguNJpfuMEiQcI0GTNuv1RHuc2ceOQ2xrdvb7+H+heByqmNwAA";
|
|
@@ -4,6 +4,7 @@ create the instance as a singleton and use it throughout the app.</p>
|
|
|
4
4
|
</div></section><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:29</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">Constructors</h3><div class="tsd-index-list"><a href="IPCManager.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
5
5
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="IPCManager.html#cloudId" class="tsd-index-link"><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>
|
|
6
6
|
<a href="IPCManager.html#cloudUsername" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Username?</span></a>
|
|
7
|
+
<a href="IPCManager.html#displayName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
7
8
|
<a href="IPCManager.html#helper" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>helper</span></a>
|
|
8
9
|
<a href="IPCManager.html#host" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host?</span></a>
|
|
9
10
|
<a href="IPCManager.html#listeners" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listeners</span></a>
|
|
@@ -29,51 +30,52 @@ create the instance as a singleton and use it throughout the app.</p>
|
|
|
29
30
|
will be used.</p>
|
|
30
31
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="IPCManager.html" class="tsd-signature-type tsd-kind-class">IPCManager</a></h4><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>Ideally, there should only be one instance of the IPCManager in the app. It is recommended to
|
|
31
32
|
create the instance as a singleton and use it throughout the app.</p>
|
|
32
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
33
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:87</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="cloudId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>The cloud ID of the <code>Host</code> app the <code>Client</code> is embedded in.</p>
|
|
33
34
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:38</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="cloudUsername" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cloud<wbr/>Username</span><a href="#cloudUsername" 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/>Username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The cloud username of the logged in user.</p>
|
|
34
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member
|
|
35
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
35
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="displayName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>display<wbr/>Name</span><a href="#displayName" 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">display<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The display name of the logged in user.</p>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:48</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="helper" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>helper</span><a href="#helper" 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">helper</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IpcHelper</span></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:51</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="host" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>host</span><a href="#host" 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">host</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HostType.html" class="tsd-signature-type tsd-kind-type-alias">HostType</a></div><div class="tsd-comment tsd-typography"><p>The type of the <code>Host</code> app the <code>Client</code> is embedded in.</p>
|
|
37
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:33</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="listeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>listeners</span><a href="#listeners" 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">listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><a href="../enums/IPCEvents.html" class="tsd-signature-type tsd-kind-enum">IPCEvents</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GenericCallback</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>logger</span><a href="#logger" 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">logger</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ILogger.html" class="tsd-signature-type tsd-kind-interface">ILogger</a></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:50</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="context" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="context.context-1"><span class="tsd-signature-keyword">get</span> context<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether the app is running inside a native WebView (<code>host</code> context) or as a
|
|
36
38
|
<code>standalone</code> app.</p>
|
|
37
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
38
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
39
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../types/IpcProtocolVersion.html" class="tsd-signature-type tsd-kind-type-alias">IpcProtocolVersion</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
39
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:59</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isConnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="isConnected.isConnected-1"><span class="tsd-signature-keyword">get</span> isConnected<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the app is connected to a <code>Host</code> app.</p>
|
|
40
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:66</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="negotiatedVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>negotiated<wbr/>Version</span><a href="#negotiatedVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="negotiatedVersion.negotiatedVersion-1"><span class="tsd-signature-keyword">get</span> negotiatedVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/IpcProtocolVersion.html" class="tsd-signature-type tsd-kind-type-alias">IpcProtocolVersion</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The negotiated IPC protocol version.</p>
|
|
41
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../types/IpcProtocolVersion.html" class="tsd-signature-type tsd-kind-type-alias">IpcProtocolVersion</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:73</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="badgeUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>badge<wbr/>Update</span><a href="#badgeUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="badgeUpdate.badgeUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">badge<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">count</span>, <span class="tsd-kind-parameter">isActivity</span><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><a href="#badgeUpdate.badgeUpdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the current badge count to the <code>Host</code> app.</p>
|
|
40
42
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">count</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The count to update the badge to.</p>
|
|
41
43
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">isActivity</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><em>Optional</em>. Whether the update is for an activity instead of a badge.</p>
|
|
42
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
44
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:290</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="determineContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>determine<wbr/>Context</span><a href="#determineContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="determineContext.determineContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">determine<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span><span class="tsd-signature-symbol">></span><a href="#determineContext.determineContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the app is embedded in a Host app or native CSP clients.</p>
|
|
43
45
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span><span class="tsd-signature-symbol">></span></h4><p>A promise with <a href="../types/IPCContext.html" class="tsd-kind-type-alias">IPCContext</a> the app is running under.</p>
|
|
44
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
45
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
46
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:102</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="evaluateContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>evaluate<wbr/>Context</span><a href="#evaluateContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="evaluateContext.evaluateContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">evaluate<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span><a href="#evaluateContext.evaluateContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">AppContext</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"standalone"</span></h4><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:387</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="initiateConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>initiate<wbr/>Connection</span><a href="#initiateConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="initiateConnection.initiateConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">initiate<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#initiateConnection.initiateConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initiates the IPC handshake with the <code>Host</code> app.</p>
|
|
47
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:113</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="matchContacts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>match<wbr/>Contacts</span><a href="#matchContacts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="matchContacts.matchContacts-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">match<wbr/>Contacts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contacts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DetailedContactItem.html" class="tsd-signature-type tsd-kind-interface">DetailedContactItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#matchContacts.matchContacts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Matches batch of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> objects against the Host's contact list to fetch detailed
|
|
46
48
|
contact information.</p>
|
|
47
49
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contacts</span>: <a href="../types/ContactItem.html" class="tsd-signature-type tsd-kind-type-alias">ContactItem</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>List of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> collection to match against the Host's contact
|
|
48
50
|
list.</p>
|
|
49
51
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DetailedContactItem.html" class="tsd-signature-type tsd-kind-interface">DetailedContactItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A collection of <a href="../interfaces/DetailedContactItem.html" class="tsd-kind-interface">DetailedContactItem</a> objects which were matched against the
|
|
50
52
|
Host's contact list.</p>
|
|
51
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
53
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:269</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onBadgeQueryRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Badge<wbr/>Query<wbr/>Request</span><a href="#onBadgeQueryRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="onBadgeQueryRequest.onBadgeQueryRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Badge<wbr/>Query<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/UnsubscribeCallback.html" class="tsd-signature-type tsd-kind-type-alias">UnsubscribeCallback</a><a href="#onBadgeQueryRequest.onBadgeQueryRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback to be invoked when a <a href="../enums/IPCEvents.html#BadgeQuery" class="tsd-kind-enum-member">IPCEvents.BadgeQuery</a> is received.</p>
|
|
52
54
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>A callback function to be invoked when a <a href="../enums/IPCEvents.html#BadgeQuery" class="tsd-kind-enum-member">IPCEvents.BadgeQuery</a> event
|
|
53
55
|
is received.</p>
|
|
54
56
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/UnsubscribeCallback.html" class="tsd-signature-type tsd-kind-type-alias">UnsubscribeCallback</a></h4><p>An unsubscribe callback to remove the listener.</p>
|
|
55
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
57
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:338</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onLifecycleEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Lifecycle<wbr/>Event</span><a href="#onLifecycleEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="onLifecycleEvent.onLifecycleEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Lifecycle<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/UnsubscribeCallback.html" class="tsd-signature-type tsd-kind-type-alias">UnsubscribeCallback</a><a href="#onLifecycleEvent.onLifecycleEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback to be invoked when a <a href="../enums/IPCEvents.html#Lifecycle" class="tsd-kind-enum-member">IPCEvents.Lifecycle</a> event is received.</p>
|
|
56
58
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>A callback function to be invoked when a <a href="../enums/IPCEvents.html#Lifecycle" class="tsd-kind-enum-member">IPCEvents.Lifecycle</a> event
|
|
57
59
|
is received.</p>
|
|
58
60
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">payload</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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/UnsubscribeCallback.html" class="tsd-signature-type tsd-kind-type-alias">UnsubscribeCallback</a></h4><p>An unsubscribe callback to remove the listener.</p>
|
|
59
61
|
<div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>The <code>eventName</code> and <code>payload</code> are defined by the <code>Host</code> app and can vary for each LIFECYCLE
|
|
60
62
|
event. The payload can be an empty object for events without any additional data.</p>
|
|
61
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
63
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:358</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onPushToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Push<wbr/>Token</span><a href="#onPushToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="onPushToken.onPushToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Push<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">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">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><a href="#onPushToken.onPushToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback to be invoked when a <a href="../enums/IPCEvents.html#PushToken" class="tsd-kind-enum-member">IPCEvents.PushToken</a> event is received.</p>
|
|
62
64
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">selector</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>A callback function to be invoked when a <a href="../enums/IPCEvents.html#PushToken" class="tsd-kind-enum-member">IPCEvents.PushToken</a> event
|
|
63
65
|
is received.</p>
|
|
64
66
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">selector</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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">selector</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <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-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h4><p>An unsubscribe callback to remove the listener.</p>
|
|
65
67
|
<ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="onPushToken.onPushToken-1.__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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>The <code>token</code>, <code>appId</code>, <code>selector</code> and <code>expiry</code> are defined by the <code>Host</code> app and can vary for
|
|
66
68
|
each Push Token event.</p>
|
|
67
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
69
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:379</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="openUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>open<wbr/>Url</span><a href="#openUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="openUrl.openUrl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">open<wbr/>Url</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="IPCManager.html#openUrl.openUrl-1.TData">TData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">data</span><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><a href="#openUrl.openUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the given URL in an external browser.</p>
|
|
68
70
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="openUrl.openUrl-1.TData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>URL to open in the external browser</p>
|
|
69
71
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="IPCManager.html#openUrl.openUrl-1.TData">TData</a></span><div class="tsd-comment tsd-typography"><p><em>Optional</em>. Any additional data to be sent along with the URL</p>
|
|
70
72
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>Any additional data to be posted alongside the URL is included with the <code>data</code> parameter.</p>
|
|
71
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
73
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:316</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestAppReset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>App<wbr/>Reset</span><a href="#requestAppReset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestAppReset.requestAppReset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>App<wbr/>Reset</span><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><a href="#requestAppReset.requestAppReset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to reset the app and log out the user.</p>
|
|
72
74
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>For added security, the Host can confirm the user's intention to reset the app by displaying
|
|
73
75
|
a confirmation dialog. The user can decide to cancel the reset operation.</p>
|
|
74
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
76
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:302</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestPushToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Push<wbr/>Token</span><a href="#requestPushToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestPushToken.requestPushToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Push<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#requestPushToken.requestPushToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to provide the Push Token for the current device.</p>
|
|
75
77
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>A promise with the Push Token as <code>string</code>.</p>
|
|
76
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
78
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:279</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="selectContacts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select<wbr/>Contacts</span><a href="#selectContacts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="selectContacts.selectContacts-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">select<wbr/>Contacts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">corelationId</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">contactType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ContactItem.html" class="tsd-signature-type tsd-kind-type-alias">ContactItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#selectContacts.selectContacts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the contact selection UI.</p>
|
|
77
79
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">corelationId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An identifier for the message stream</p>
|
|
78
80
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">mode</span>: <span class="tsd-signature-type">"single"</span></span><div class="tsd-comment tsd-typography"><p><em>Optional</em>. Whether to allow <code>single</code> or <code>multi</code> contact selection.</p>
|
|
79
81
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">contactType</span>: <a href="../types/ContactType.html" class="tsd-signature-type tsd-kind-type-alias">ContactType</a></span><div class="tsd-comment tsd-typography"><p><em>Optional</em>. The type of contacts to be selected. This can be either
|
|
@@ -82,7 +84,7 @@ a confirmation dialog. The user can decide to cancel the reset operation.</p>
|
|
|
82
84
|
<code>corelationId</code>.</p>
|
|
83
85
|
<div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>When requesting a <code>single</code> contact, the <code>Host</code> app will return immediately
|
|
84
86
|
after contact selection.</p>
|
|
85
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
87
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:169</li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="selectContacts.selectContacts-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">select<wbr/>Contacts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">corelationId</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">currentContacts</span>, <span class="tsd-kind-parameter">contactType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ContactItem.html" class="tsd-signature-type tsd-kind-type-alias">ContactItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#selectContacts.selectContacts-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the contact selection UI.</p>
|
|
86
88
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">corelationId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An identifier for the message stream</p>
|
|
87
89
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <span class="tsd-signature-type">"multi"</span></span><div class="tsd-comment tsd-typography"><p>Whether to allow <code>single</code> or <code>multi</code> contact selection.</p>
|
|
88
90
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">currentContacts</span>: <a href="../types/ContactItem.html" class="tsd-signature-type tsd-kind-type-alias">ContactItem</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>A list of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> objects that are currently selected.
|
|
@@ -95,6 +97,6 @@ This is used to highlight the current contacts from the selection UI.</p>
|
|
|
95
97
|
UI. The <code>Host</code> app will return the selected contacts when the user closes the UI.</p>
|
|
96
98
|
<p>When requesting a <code>multi</code> contact, the <code>currentContacts</code> parameter is required. This will
|
|
97
99
|
be used to highlight the contacts that are already selected.</p>
|
|
98
|
-
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
100
|
+
</div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:195</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sipCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sip<wbr/>Call</span><a href="#sipCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sipCall.sipCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sip<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sipCall.sipCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initiates a SIP call to the given <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a>.</p>
|
|
99
101
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/ContactItem.html" class="tsd-signature-type tsd-kind-type-alias">ContactItem</a></span><div class="tsd-comment tsd-typography"><p><a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> for the callee.</p>
|
|
100
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
102
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:326</li></ul></aside></li></ul></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="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#cloudId" class=""><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="#cloudUsername" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Username</span></a><a href="#displayName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name</span></a><a href="#helper" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>helper</span></a><a href="#host" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host</span></a><a href="#listeners" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listeners</span></a><a href="#logger" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a><a href="#context" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>context</span></a><a href="#isConnected" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Connected</span></a><a href="#negotiatedVersion" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>negotiated<wbr/>Version</span></a><a href="#badgeUpdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>badge<wbr/>Update</span></a><a href="#determineContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>determine<wbr/>Context</span></a><a href="#evaluateContext" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>evaluate<wbr/>Context</span></a><a href="#initiateConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initiate<wbr/>Connection</span></a><a href="#matchContacts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match<wbr/>Contacts</span></a><a href="#onBadgeQueryRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Badge<wbr/>Query<wbr/>Request</span></a><a href="#onLifecycleEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Lifecycle<wbr/>Event</span></a><a href="#onPushToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Push<wbr/>Token</span></a><a href="#openUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open<wbr/>Url</span></a><a href="#requestAppReset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>App<wbr/>Reset</span></a><a href="#requestPushToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Push<wbr/>Token</span></a><a href="#selectContacts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Contacts</span></a><a href="#sipCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sip<wbr/>Call</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,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">"uri"</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:
|
|
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">"uri"</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:3238</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">"uri"</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:
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:
|
|
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:3239</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:3243</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>
|
package/docs/types/HostType.html
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HostType | 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="HostType.html">HostType</a></li></ul><h1>Type alias HostType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Host<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"webrtc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"desktop"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ios"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"android"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ios_jitsi"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"electron"</span></div><div class="tsd-comment tsd-typography"><p>Type of the Host app. Valid values are only <code>webrtc</code>, <code>desktop</code>, <code>ios</code>, <code>android</code>, <code>ios_jitsi</code>
|
|
2
2
|
and <code>electron</code>.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-protocol/lib/index.d.ts:1202</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>
|