@acrobits/ipc-sdk 0.11.2-alpha.8 → 0.12.0-alpha.11
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/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/IPCManager.html +50 -31
- package/docs/classes/InvalidParameterError.html +9 -0
- package/docs/classes/UnsupportedVersionError.html +7 -0
- package/docs/enums/IPCEvents.html +7 -5
- package/docs/interfaces/CallInfoItem.html +16 -0
- package/docs/interfaces/DetailedContactURI.html +3 -3
- package/docs/interfaces/ILogger.html +2 -2
- package/docs/interfaces/RemoteUser.html +6 -0
- package/docs/modules.html +1 -1
- package/docs/types/BaseContactItem.html +7 -7
- package/docs/types/CallState.html +26 -0
- package/docs/types/CloudUsernameContactItem.html +2 -2
- package/docs/types/ContactItem.html +1 -1
- package/docs/types/ContactLabel.html +1 -1
- package/docs/types/ContactType.html +1 -1
- package/docs/types/ContactURI.html +1 -1
- package/docs/types/DetailedContactItem.html +8 -8
- package/docs/types/HostType.html +1 -1
- package/docs/types/IPCContext.html +1 -1
- package/docs/types/IpcProtocolVersion.html +1 -1
- package/docs/types/UnsubscribeCallback.html +1 -1
- package/docs/types/UriContactItem.html +1 -1
- package/lib/index.d.ts +354 -210
- package/lib/ipc-sdk.js +858 -698
- package/lib/ipc-sdk.js.map +1 -1
- package/lib/ipc-sdk.umd.cjs +4 -4
- package/lib/ipc-sdk.umd.cjs.map +1 -1
- package/package.json +3 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IPCManager | Acrobits IPC SDK</title><meta name="description" content="Documentation for Acrobits IPC SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Acrobits IPC SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">IPCManager</a></li></ul><h1>Class IPCManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A class that manages the IPC communication between the <code>Client</code> and the <code>Host</code>.</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Ideally, there should only be one instance of the IPCManager in the app. It is recommended to
|
|
3
3
|
create the instance as a singleton and use it throughout the app.</p>
|
|
4
|
-
</div></div></section><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
4
|
+
</div></div></section><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:39</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">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="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><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="#cloudid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id?</span></a>
|
|
6
6
|
<a href="#cloudusername" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Username?</span></a>
|
|
7
7
|
<a href="#displayname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
|
|
@@ -14,11 +14,13 @@ create the instance as a singleton and use it throughout the app.</p>
|
|
|
14
14
|
<a href="#initiateconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initiate<wbr/>Connection</span></a>
|
|
15
15
|
<a href="#matchcontacts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match<wbr/>Contacts</span></a>
|
|
16
16
|
<a href="#onbadgequeryrequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Badge<wbr/>Query<wbr/>Request</span></a>
|
|
17
|
+
<a href="#oncallinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Call<wbr/>Info</span></a>
|
|
17
18
|
<a href="#onlifecycleevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Lifecycle<wbr/>Event</span></a>
|
|
18
19
|
<a href="#onpushtoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Push<wbr/>Token</span></a>
|
|
19
20
|
<a href="#onrequestlogsmessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Request<wbr/>Logs<wbr/>Message</span></a>
|
|
20
21
|
<a href="#openurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open<wbr/>Url</span></a>
|
|
21
22
|
<a href="#requestappreset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>App<wbr/>Reset</span></a>
|
|
23
|
+
<a href="#requestcallinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Call<wbr/>Info</span></a>
|
|
22
24
|
<a href="#requestpushtoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Push<wbr/>Token</span></a>
|
|
23
25
|
<a href="#selectcontacts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Contacts</span></a>
|
|
24
26
|
<a href="#sipcall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sip<wbr/>Call</span></a>
|
|
@@ -27,63 +29,77 @@ create the instance as a singleton and use it throughout the app.</p>
|
|
|
27
29
|
will be used.</p>
|
|
28
30
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">IPCManager</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Ideally, there should only be one instance of the IPCManager in the app. It is recommended to
|
|
29
31
|
create the instance as a singleton and use it throughout the app.</p>
|
|
30
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
31
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
32
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
33
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
34
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
32
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:97</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cloudid"><code class="tsd-tag">Optional</code><span>cloud<wbr/>Id</span><a href="#cloudid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cloudId</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
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:48</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cloudusername"><code class="tsd-tag">Optional</code><span>cloud<wbr/>Username</span><a href="#cloudusername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cloudUsername</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 packages/ipc-sdk/src/lib/sdk.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="displayname"><code class="tsd-tag">Optional</code><span>display<wbr/>Name</span><a href="#displayname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">displayName</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>
|
|
35
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:58</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="host"><code class="tsd-tag">Optional</code><span>host</span><a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></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>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:43</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="context"><span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="contextcontext"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">context</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></div><div 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
|
|
35
37
|
<code>standalone</code> app.</p>
|
|
36
|
-
</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:
|
|
37
|
-
</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:
|
|
38
|
-
</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:
|
|
38
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:69</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isconnected"><span>is<wbr/>Connected</span><a href="#isconnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="isconnectedisconnected"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isConnected</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the app is connected to a <code>Host</code> app.</p>
|
|
39
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:76</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="negotiatedversion"><span>negotiated<wbr/>Version</span><a href="#negotiatedversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="negotiatedversionnegotiatedversion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">negotiatedVersion</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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The negotiated IPC protocol version.</p>
|
|
40
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:83</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="badgeupdate"><span>badge<wbr/>Update</span><a href="#badgeupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="badgeupdate-1"><span class="tsd-kind-call-signature">badgeUpdate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">isActivity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#badgeupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the current badge count to the <code>Host</code> app.</p>
|
|
39
41
|
</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>
|
|
40
42
|
</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>
|
|
41
|
-
</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:
|
|
43
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:449</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="determinecontext"><span>determine<wbr/>Context</span><a href="#determinecontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="determinecontext-1"><span class="tsd-kind-call-signature">determineContext</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
42
44
|
</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>
|
|
43
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
44
|
-
</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:
|
|
45
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:114</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initiateconnection"><span>initiate<wbr/>Connection</span><a href="#initiateconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="initiateconnection-1"><span class="tsd-kind-call-signature">initiateConnection</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initiates the IPC handshake with the <code>Host</code> app.</p>
|
|
46
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:125</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="matchcontacts"><span>match<wbr/>Contacts</span><a href="#matchcontacts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="matchcontacts-1"><span class="tsd-kind-call-signature">matchContacts</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">contacts</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><br/><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><br/> <span class="tsd-signature-symbol">|</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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/DetailedContactItem.html" class="tsd-signature-type tsd-kind-type-alias">DetailedContactItem</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">CloudUsernameDetailedContactItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#matchcontacts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
|
|
45
47
|
contact information.</p>
|
|
46
48
|
</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
|
|
47
49
|
list.</p>
|
|
48
50
|
</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><br/> <span class="tsd-signature-symbol">|</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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/DetailedContactItem.html" class="tsd-signature-type tsd-kind-type-alias">DetailedContactItem</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">CloudUsernameDetailedContactItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><p>A collection of <a href="../types/DetailedContactItem.html" class="tsd-kind-type-alias">DetailedContactItem</a> objects which were matched against the
|
|
49
51
|
Host's contact list.</p>
|
|
50
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
52
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:428</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onbadgequeryrequest"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="onbadgequeryrequest-1"><span class="tsd-kind-call-signature">onBadgeQueryRequest</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-type">void</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
51
53
|
</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-type">void</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
|
|
52
54
|
is received.</p>
|
|
53
55
|
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
54
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
56
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:516</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="oncallinfo"><span>on<wbr/>Call<wbr/>Info</span><a href="#oncallinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="oncallinfo-1"><span class="tsd-kind-call-signature">onCallInfo</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-kind-parameter">calls</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CallInfoItem.html" class="tsd-signature-type tsd-kind-interface">CallInfoItem</a><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 class="tsd-signature-symbol">:</span> <a href="../types/UnsubscribeCallback.html" class="tsd-signature-type tsd-kind-type-alias">UnsubscribeCallback</a><a href="#oncallinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback to be invoked when a <a href="../enums/IPCEvents.html#callinfo" class="tsd-kind-enum-member">IPCEvents.CallInfo</a> event is received.</p>
|
|
57
|
+
</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-kind-parameter">calls</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CallInfoItem.html" class="tsd-signature-type tsd-kind-interface">CallInfoItem</a><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><div class="tsd-comment tsd-typography"><p>A callback function to be invoked when a <a href="../enums/IPCEvents.html#callinfo" class="tsd-kind-enum-member">IPCEvents.CallInfo</a> event
|
|
58
|
+
is received. The callback receives an array of <a href="../interfaces/CallInfoItem.html" class="tsd-kind-interface">CallInfoItem</a> objects.</p>
|
|
59
|
+
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
60
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-2">Remarks<a href="#remarks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The Host app sends CALL INFO updates when call state changes occur. This includes
|
|
61
|
+
new calls, call state transitions, and call terminations.</p>
|
|
62
|
+
<p>Note: This event is only available on protocol version 2.2 or higher. On lower versions,
|
|
63
|
+
the callback will never be invoked.</p>
|
|
64
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:625</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onlifecycleevent"><span>on<wbr/>Lifecycle<wbr/>Event</span><a href="#onlifecycleevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="onlifecycleevent-1"><span class="tsd-kind-call-signature">onLifecycleEvent</span><span class="tsd-signature-symbol">(</span><br/> <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-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">:</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 class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
55
65
|
</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-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">:</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 class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</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
|
|
56
66
|
is received.</p>
|
|
57
67
|
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
58
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
68
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-3">Remarks<a href="#remarks-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The <code>eventName</code> and <code>payload</code> are defined by the <code>Host</code> app and can vary for each LIFECYCLE
|
|
59
69
|
event. The payload can be an empty object for events without any additional data.</p>
|
|
60
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
70
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:536</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onpushtoken"><span>on<wbr/>Push<wbr/>Token</span><a href="#onpushtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="onpushtoken-1"><span class="tsd-kind-call-signature">onPushToken</span><span class="tsd-signature-symbol">(</span><br/> <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-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">selector</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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><br/><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><a href="#onpushtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
61
71
|
</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-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">appId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">selector</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</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
|
|
62
72
|
is received.</p>
|
|
63
73
|
</div><div class="tsd-comment tsd-typography"></div></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-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></h4><p>An unsubscribe callback to remove the listener.</p>
|
|
64
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
74
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-4">Remarks<a href="#remarks-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The <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
|
|
65
75
|
each Push Token event.</p>
|
|
66
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
76
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:557</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onrequestlogsmessage"><span>on<wbr/>Request<wbr/>Logs<wbr/>Message</span><a href="#onrequestlogsmessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="onrequestlogsmessage-1"><span class="tsd-kind-call-signature">onRequestLogsMessage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">skipCompression</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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><br/><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><a href="#onrequestlogsmessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback to be invoked when a <a href="../enums/IPCEvents.html#requestlogs" class="tsd-kind-enum-member">IPCEvents.RequestLogs</a> event is received.</p>
|
|
67
77
|
</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-kind-parameter">skipCompression</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>A callback function to be invoked when a <a href="../enums/IPCEvents.html#requestlogs" class="tsd-kind-enum-member">IPCEvents.RequestLogs</a> event
|
|
68
78
|
is received. The callback receives an optional skipCompression parameter.</p>
|
|
69
79
|
</div><div class="tsd-comment tsd-typography"></div></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-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></h4><p>An unsubscribe callback to remove the listener.</p>
|
|
70
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
80
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-5">Remarks<a href="#remarks-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The Host app can request logs from the Client app by sending a RequestLogs event. The callback
|
|
71
81
|
will receive a skipCompression parameter indicating whether the logs should be compressed or not.</p>
|
|
72
82
|
<p>When skipCompression is true, the logs should be sent uncompressed. When false or undefined,
|
|
73
83
|
the logs should be compressed before sending.</p>
|
|
74
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
84
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:580</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="openurl"><span>open<wbr/>Url</span><a href="#openurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="openurl-1"><span class="tsd-kind-call-signature">openUrl</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#openurltdata">TData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#openurltdata">TData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#openurl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
75
85
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="openurltdata"><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>
|
|
76
86
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#openurltdata">TData</a></span><div class="tsd-comment tsd-typography"><p><em>Optional</em>. Any additional data to be sent along with the URL</p>
|
|
77
|
-
</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 class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
87
|
+
</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 class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-6">Remarks<a href="#remarks-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Any additional data to be posted alongside the URL is included with the <code>data</code> parameter.</p>
|
|
78
88
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// import the IPCManager</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">IPCManager</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">'@acrobits/ipc-sdk'</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// create an instance of IPCManager</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">manager</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">IPCManager</span><span class="hl-2">();</span><br/><br/><span class="hl-0">// open the URL with additional data</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">url</span><span class="hl-2"> = </span><span class="hl-3">'https://example.com'</span><span class="hl-2">;</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">data</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">'John Doe'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">age:</span><span class="hl-2"> </span><span class="hl-9">30</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-5">manager</span><span class="hl-2">.</span><span class="hl-1">openUrl</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">, </span><span class="hl-5">data</span><span class="hl-2">);</span>
|
|
79
89
|
</code><button type="button">Copy</button></pre>
|
|
80
90
|
|
|
81
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
82
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
91
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:494</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestappreset"><span>request<wbr/>App<wbr/>Reset</span><a href="#requestappreset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="requestappreset-1"><span class="tsd-kind-call-signature">requestAppReset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#requestappreset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
92
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-7">Remarks<a href="#remarks-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>For added security, the Host can confirm the user's intention to reset the app by displaying
|
|
83
93
|
a confirmation dialog. The user can decide to cancel the reset operation.</p>
|
|
84
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
94
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:461</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestcallinfo"><span>request<wbr/>Call<wbr/>Info</span><a href="#requestcallinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="requestcallinfo-1"><span class="tsd-kind-call-signature">requestCallInfo</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/CallInfoItem.html" class="tsd-signature-type tsd-kind-interface">CallInfoItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestcallinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the current call information from the <code>Host</code> app.</p>
|
|
95
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CallInfoItem.html" class="tsd-signature-type tsd-kind-interface">CallInfoItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A promise with an array of <a href="../interfaces/CallInfoItem.html" class="tsd-kind-interface">CallInfoItem</a> objects representing
|
|
96
|
+
the current calls.</p>
|
|
97
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-8">Remarks<a href="#remarks-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This method requires protocol version 2.2 or higher. If the negotiated version
|
|
98
|
+
is lower, an <a href="UnsupportedVersionError.html" class="tsd-kind-class">UnsupportedVersionError</a> will be thrown.</p>
|
|
99
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="UnsupportedVersionError.html" class="tsd-kind-class">UnsupportedVersionError</a> if the negotiated version is below 2.2.</p>
|
|
100
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:600</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestpushtoken"><span>request<wbr/>Push<wbr/>Token</span><a href="#requestpushtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="requestpushtoken-1"><span class="tsd-kind-call-signature">requestPushToken</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
85
101
|
</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>
|
|
86
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
102
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:438</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selectcontacts"><span>select<wbr/>Contacts</span><a href="#selectcontacts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="selectcontacts-1"><span class="tsd-kind-call-signature">selectContacts</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">corelationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SelectContactsOptions</span><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the contact selection UI.</p>
|
|
87
103
|
</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>
|
|
88
104
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">SelectContactsOptions</span></span><div class="tsd-comment tsd-typography"><p>Configuration options for contact selection:</p>
|
|
89
105
|
<ul>
|
|
@@ -93,7 +109,10 @@ a confirmation dialog. The user can decide to cancel the reset operation.</p>
|
|
|
93
109
|
<li><code>includeOffNetworkContacts</code>: Whether to include contacts not on the network. Defaults to false</li>
|
|
94
110
|
</ul>
|
|
95
111
|
</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="../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></h4><p>A collection of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> objects which the user selected</p>
|
|
96
|
-
<div class="tsd-comment tsd-typography"
|
|
112
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-9">Remarks<a href="#remarks-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This overload requires protocol version 2.1 or higher. If the negotiated version
|
|
113
|
+
is 2.0, an <a href="UnsupportedVersionError.html" class="tsd-kind-class">UnsupportedVersionError</a> will be thrown.</p>
|
|
114
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="UnsupportedVersionError.html" class="tsd-kind-class">UnsupportedVersionError</a> if the negotiated version is 2.0.</p>
|
|
115
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:205</li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="selectcontacts-2"><span class="tsd-kind-call-signature">selectContacts</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">corelationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"single"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">contactType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ContactType.html" class="tsd-signature-type tsd-kind-type-alias">ContactType</a><span class="tsd-signature-symbol">,</span><br/><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-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the contact selection UI.</p>
|
|
97
116
|
</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>
|
|
98
117
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">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>
|
|
99
118
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">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
|
|
@@ -101,9 +120,9 @@ a confirmation dialog. The user can decide to cancel the reset operation.</p>
|
|
|
101
120
|
</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="../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></h4><p>A collection of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> objects which the user selected along with the
|
|
102
121
|
<code>corelationId</code>.</p>
|
|
103
122
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use the <code>selectContacts</code> method with the <code>options</code> parameter instead.</p>
|
|
104
|
-
</div><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
123
|
+
</div><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-10">Remarks<a href="#remarks-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When requesting a <code>single</code> contact, the <code>Host</code> app will return immediately
|
|
105
124
|
after contact selection.</p>
|
|
106
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
125
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:224</li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="selectcontacts-3"><span class="tsd-kind-call-signature">selectContacts</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">corelationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"multi"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">currentContacts</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><br/> <span class="tsd-kind-parameter">contactType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ContactType.html" class="tsd-signature-type tsd-kind-type-alias">ContactType</a><span class="tsd-signature-symbol">,</span><br/><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-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the <code>Host</code> app to open the contact selection UI.</p>
|
|
107
126
|
</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>
|
|
108
127
|
</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>
|
|
109
128
|
</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.
|
|
@@ -113,10 +132,10 @@ This is used to highlight the current contacts from the selection UI.</p>
|
|
|
113
132
|
</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="../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></h4><p>A collection of <a href="../types/ContactItem.html" class="tsd-kind-type-alias">ContactItem</a> objects which the user selected along with the
|
|
114
133
|
<code>corelationId</code>.</p>
|
|
115
134
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use the <code>selectContacts</code> method with the <code>options</code> parameter instead.</p>
|
|
116
|
-
</div><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
135
|
+
</div><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-11">Remarks<a href="#remarks-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When requesting a <code>multi</code> contact, the user will have to manually close the contact selection
|
|
117
136
|
UI. The <code>Host</code> app will return the selected contacts when the user closes the UI.</p>
|
|
118
137
|
<p>When requesting a <code>multi</code> contact, the <code>currentContacts</code> parameter is required. This will
|
|
119
138
|
be used to highlight the contacts that are already selected.</p>
|
|
120
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in ipc-sdk/src/lib/sdk.ts:
|
|
139
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in packages/ipc-sdk/src/lib/sdk.ts:252</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sipcall"><span>sip<wbr/>Call</span><a href="#sipcall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sipcall-1"><span class="tsd-kind-call-signature">sipCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</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> <span class="tsd-signature-type">void</span><a href="#sipcall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
121
140
|
</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>
|
|
122
|
-
</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:
|
|
141
|
+
</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 packages/ipc-sdk/src/lib/sdk.ts:504</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cloudid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Id</span></a><a href="#cloudusername"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cloud<wbr/>Username</span></a><a href="#displayname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name</span></a><a href="#host"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#context"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>context</span></a><a href="#isconnected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Connected</span></a><a href="#negotiatedversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>negotiated<wbr/>Version</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#badgeupdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>badge<wbr/>Update</span></a><a href="#determinecontext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>determine<wbr/>Context</span></a><a href="#initiateconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initiate<wbr/>Connection</span></a><a href="#matchcontacts"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match<wbr/>Contacts</span></a><a href="#onbadgequeryrequest"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Badge<wbr/>Query<wbr/>Request</span></a><a href="#oncallinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Call<wbr/>Info</span></a><a href="#onlifecycleevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Lifecycle<wbr/>Event</span></a><a href="#onpushtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Push<wbr/>Token</span></a><a href="#onrequestlogsmessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Request<wbr/>Logs<wbr/>Message</span></a><a href="#openurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open<wbr/>Url</span></a><a href="#requestappreset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>App<wbr/>Reset</span></a><a href="#requestcallinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Call<wbr/>Info</span></a><a href="#requestpushtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Push<wbr/>Token</span></a><a href="#selectcontacts"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Contacts</span></a><a href="#sipcall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sip<wbr/>Call</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Acrobits IPC SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|