iframe-coordinator-cli 6.4.0-beta.4c9e753.0 → 6.4.0-beta.561c590.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/dist/assets/{index-CDTqnPd7.js → index-BOsblqbY.js} +19 -19
- package/dist/ifc-docs/assets/navigation.js +1 -1
- package/dist/ifc-docs/assets/search.js +1 -1
- package/dist/ifc-docs/classes/client.Client.html +22 -22
- package/dist/ifc-docs/classes/host.FrameRouterElement.html +8 -8
- package/dist/ifc-docs/classes/workerClient.WorkerClient.html +22 -20
- package/dist/ifc-docs/classes/workerPool.WorkerPool.html +18 -3
- package/dist/ifc-docs/documents/client-setup.html +2 -2
- package/dist/ifc-docs/functions/host.registerCustomElements.html +2 -2
- package/dist/ifc-docs/hierarchy.html +1 -1
- package/dist/ifc-docs/index.html +2 -2
- package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +3 -3
- package/dist/ifc-docs/interfaces/host.ClientConfig.html +7 -0
- package/dist/ifc-docs/interfaces/host.ClientRegistration.html +7 -7
- package/dist/ifc-docs/interfaces/host.RoutingMap.html +2 -2
- package/dist/ifc-docs/interfaces/workerPool.AppData.html +6 -0
- package/dist/ifc-docs/interfaces/workerPool.WorkerConfig.html +7 -0
- package/dist/ifc-docs/interfaces/workerPool.WorkerItem.html +6 -0
- package/dist/ifc-docs/interfaces/workerPool.WorkerRegistry.html +2 -0
- package/dist/ifc-docs/modules/client.html +2 -2
- package/dist/ifc-docs/modules/host.html +1 -1
- package/dist/ifc-docs/modules/workerClient.html +1 -1
- package/dist/ifc-docs/modules/workerPool.html +1 -1
- package/dist/ifc-docs/modules.html +1 -1
- package/dist/index.html +1 -1
- package/package.json +1 -1
|
@@ -1,24 +1,24 @@
|
|
|
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>FrameRouterElement | iframe-coordinator - v6.4.0-beta.
|
|
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>FrameRouterElement | iframe-coordinator - v6.4.0-beta.561c590.0</title><meta name="description" content="Documentation for iframe-coordinator"/><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">iframe-coordinator - v6.4.0-beta.561c590.0</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="../modules/host.html">host</a></li><li><a href="" aria-current="page">FrameRouterElement</a></li></ul><h1>Class FrameRouterElement</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A custom element responsible for rendering an iframe and communicating with
|
|
2
2
|
configured client applications that will render in that frame. It will be
|
|
3
3
|
registered as <code>frame-router</code> by a call to [[registerCustomElements]] and
|
|
4
4
|
should not be created directly. Instead, add a <code><frame-router></code> element to your
|
|
5
5
|
markup or use <code>document.createElement('frame-router')</code> after calling
|
|
6
6
|
[[registerCustomElements]].</p>
|
|
7
|
-
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
7
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="192"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">HTMLElement</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FrameRouterElement</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L30">elements/frame-router.ts:30</a></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">Accessors</h3><div class="tsd-index-list"><a href="#clientconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>client<wbr/>Config</span></a>
|
|
8
8
|
<a href="#messaging" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>messaging</span></a>
|
|
9
9
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#changeroute" 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>change<wbr/>Route</span></a>
|
|
10
10
|
<a href="#publish" 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>publish</span></a>
|
|
11
11
|
<a href="#setupframes" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup<wbr/>Frames</span></a>
|
|
12
|
-
</div></section></div></details></section></section><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="clientconfig"><span>client<wbr/>Config</span><a href="#clientconfig" 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="clientconfigclientconfig"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">clientConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <
|
|
13
|
-
</div><h4 class="tsd-returns-title">Returns <
|
|
14
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
12
|
+
</div></section></div></details></section></section><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="clientconfig"><span>client<wbr/>Config</span><a href="#clientconfig" 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="clientconfigclientconfig"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">clientConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/host.ClientConfig.html" class="tsd-signature-type tsd-kind-interface">ClientConfig</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A property that can be set to initialize the host frame</p>
|
|
13
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/host.ClientConfig.html" class="tsd-signature-type tsd-kind-interface">ClientConfig</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L188">elements/frame-router.ts:188</a></li></ul></aside></div></li><li><div class="tsd-signature" id="clientconfigclientconfig-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">clientConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientConfig</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/host.ClientConfig.html" class="tsd-signature-type tsd-kind-interface">ClientConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div 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">clientConfig</span>: <a href="../interfaces/host.ClientConfig.html" class="tsd-signature-type tsd-kind-interface">ClientConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L192">elements/frame-router.ts:192</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="messaging"><span>messaging</span><a href="#messaging" 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="messagingmessaging"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">messaging</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Eventing for published messages from the host application.</p>
|
|
14
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L104">elements/frame-router.ts:104</a></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="changeroute"><span>change<wbr/>Route</span><a href="#changeroute" 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="changeroute-1"><span class="tsd-kind-call-signature">changeRoute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">newPath</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><a href="#changeroute-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>Changes the route the client fragment is rendering.</p>
|
|
15
15
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">newPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a new route which matches those provided originally.</p>
|
|
16
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
16
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L126">elements/frame-router.ts:126</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publish"><span>publish</span><a href="#publish" 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="publish-1"><span class="tsd-kind-call-signature">publish</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">publication</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#publish-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>Publish a message to the client fragment.</p>
|
|
17
17
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">publication</span>: <span class="tsd-signature-type">Publication</span></span><div class="tsd-comment tsd-typography"><p>The information published to the client fragment.
|
|
18
18
|
The topic may not be of interest, and could be ignored.</p>
|
|
19
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
19
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L114">elements/frame-router.ts:114</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setupframes"><span class="deprecated">setup<wbr/>Frames</span><a href="#setupframes" 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="setupframes-1"><span class="tsd-kind-call-signature">setupFrames</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clients</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/host.RoutingMap.html" class="tsd-signature-type tsd-kind-interface">RoutingMap</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">envData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EnvData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setupframes-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>Initializes this host frame with the possible clients and
|
|
20
20
|
the environmental data required the clients.</p>
|
|
21
21
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clients</span>: <a href="../interfaces/host.RoutingMap.html" class="tsd-signature-type tsd-kind-interface">RoutingMap</a></span><div class="tsd-comment tsd-typography"><p>The map of registrations for the available clients.</p>
|
|
22
22
|
</div></li><li><span><span class="tsd-kind-parameter">envData</span>: <span class="tsd-signature-type">EnvData</span></span><div class="tsd-comment tsd-typography"><p>Information about the host environment.</p>
|
|
23
23
|
</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-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 new <a href="#clientconfig" class="tsd-kind-accessor">clientConfig</a> property instead</p>
|
|
24
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
24
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/elements/frame-router.ts#L90">elements/frame-router.ts:90</a></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-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></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-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="#clientconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>client<wbr/>Config</span></a><a href="#messaging"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>messaging</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="#changeroute"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>Route</span></a><a href="#publish"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a><a href="#setupframes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup<wbr/>Frames</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">iframe-coordinator - v6.4.0-beta.561c590.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,6 @@
|
|
|
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>WorkerClient | iframe-coordinator - v6.4.0-beta.
|
|
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>WorkerClient | iframe-coordinator - v6.4.0-beta.561c590.0</title><meta name="description" content="Documentation for iframe-coordinator"/><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">iframe-coordinator - v6.4.0-beta.561c590.0</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="../modules/workerClient.html">workerClient</a></li><li><a href="" aria-current="page">WorkerClient</a></li></ul><h1>Class WorkerClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Client class allowing web workers to interact with the larger
|
|
2
|
+
iframe-coordinator feature set.</p>
|
|
3
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="125"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">WorkerClient</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/workerClient.ts#L8">workerClient.ts:8</a></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>
|
|
2
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#environmentdata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>environment<wbr/>Data</span></a>
|
|
3
5
|
<a href="#messaging" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>messaging</span></a>
|
|
4
6
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#addlistener" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
|
@@ -16,43 +18,43 @@
|
|
|
16
18
|
<a href="#stop" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
|
|
17
19
|
<a href="#urlfromclientpath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>url<wbr/>From<wbr/>Client<wbr/>Path</span></a>
|
|
18
20
|
<a href="#urlfromhostpath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>url<wbr/>From<wbr/>Host<wbr/>Path</span></a>
|
|
19
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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="constructorworkerclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkerClient</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkerClient</a><a href="#constructorworkerclient" 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>Creates a new client.</p>
|
|
20
|
-
</div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkerClient</a></h4><aside class="tsd-sources"><p>Overrides IfcClient<DedicatedWorkerGlobalScope>.constructor</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
21
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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="constructorworkerclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkerClient</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkerClient</a><a href="#constructorworkerclient" 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>Creates a new Web Worker client.</p>
|
|
22
|
+
</div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkerClient</a></h4><aside class="tsd-sources"><p>Overrides IfcClient<DedicatedWorkerGlobalScope>.constructor</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/workerClient.ts#L12">workerClient.ts:12</a></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-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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="environmentdata"><span>environment<wbr/>Data</span><a href="#environmentdata" 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 tsd-is-inherited"><li><div class="tsd-signature" id="environmentdataenvironmentdata"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">environmentData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EnvData</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the environmental data provided by the host application. This includes
|
|
21
23
|
the locale the client should use, the base URL of the host app, and any
|
|
22
24
|
custom data sent by the host.</p>
|
|
23
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EnvData</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.environmentData</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
25
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EnvData</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.environmentData</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L183">BaseClient.ts:183</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="messaging"><span>messaging</span><a href="#messaging" 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 tsd-is-inherited"><li><div class="tsd-signature" id="messagingmessaging"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">messaging</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accessor for the general-purpose pub-sub bus between client and host applications.
|
|
24
26
|
The content of messages on this bus are not defined by this API beyond a basic
|
|
25
27
|
data wrapper of topic and payload. This is for application-specific messages
|
|
26
28
|
agreed upon as a shared API between host and client.</p>
|
|
27
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.messaging</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
29
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.messaging</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L283">BaseClient.ts:283</a></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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="addlistener"><span>add<wbr/>Listener</span><a href="#addlistener" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="addlistener-1"><span class="tsd-kind-call-signature">addListener</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"environmentalData"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EnvDataHandler</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">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span><a href="#addlistener-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>Sets up a function that will be called whenever the specified event type is delivered to the target.
|
|
28
30
|
This should not be confused with the general-purpose pub-sub listeners that can be set via the
|
|
29
31
|
IfcClient.messaging | messaging interface.</p>
|
|
30
32
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">"environmentalData"</span></span><div class="tsd-comment tsd-typography"><p>A case-sensitive string representing the event type to listen for. Currently, hosts only
|
|
31
33
|
send <code>environmentalData</code> events.</p>
|
|
32
34
|
</div></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">EnvDataHandler</span></span><div class="tsd-comment tsd-typography"><p>The handler which receives a notification when an event of the specified type occurs.</p>
|
|
33
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.addListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
35
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.addListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L81">BaseClient.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ashosturl"><span class="deprecated">as<wbr/>Host<wbr/>Url</span><a href="#ashosturl" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="ashosturl-1"><span class="tsd-kind-call-signature">asHostUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientRouteLegacy</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">string</span><a href="#ashosturl-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>Translates a client route like <code>/foo/bar</code> to the full URL used in the host
|
|
34
36
|
app for the same page, e.g. <code>https://hostapp.com/#/client-app/foo/bar</code>.</p>
|
|
35
37
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clientRouteLegacy</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The /-separated path within the client app to link to.</p>
|
|
36
38
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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 new <a href="#urlfromclientpath" class="tsd-kind-method">urlFromClientPath</a> method instead</p>
|
|
37
|
-
</div></div><aside class="tsd-sources"><p>Inherited from IfcClient.asHostUrl</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
38
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.clearPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
39
|
+
</div></div><aside class="tsd-sources"><p>Inherited from IfcClient.asHostUrl</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L226">BaseClient.ts:226</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clearpromptonleave"><span>clear<wbr/>Prompt<wbr/>On<wbr/>Leave</span><a href="#clearpromptonleave" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="clearpromptonleave-1"><span class="tsd-kind-call-signature">clearPromptOnLeave</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearpromptonleave-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>Asks the host application to clear the prompt on leave dialog.</p>
|
|
40
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.clearPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L401">BaseClient.ts:401</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="publish"><span>publish</span><a href="#publish" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="publish-1"><span class="tsd-kind-call-signature">publish</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">publication</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Publication</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#publish-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>Publish a general message to the host application.</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">publication</span>: <span class="tsd-signature-type">Publication</span></span><div class="tsd-comment tsd-typography"><p>The data object to be published.</p>
|
|
40
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.publish</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
42
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.publish</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L305">BaseClient.ts:305</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removealllisteners"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removealllisteners" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="removealllisteners-1"><span class="tsd-kind-call-signature">removeAllListeners</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"environmentalData"</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">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span><a href="#removealllisteners-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>Removes all event listeners previously registered with IfcClient.addListener | addListener.</p>
|
|
41
43
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">"environmentalData"</span></span><div class="tsd-comment tsd-typography"><p>A string which specifies the type of event for which to remove an event listener.</p>
|
|
42
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.removeAllListeners</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
44
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.removeAllListeners</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L106">BaseClient.ts:106</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removelistener"><span>remove<wbr/>Listener</span><a href="#removelistener" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="removelistener-1"><span class="tsd-kind-call-signature">removeListener</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"environmentalData"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EnvDataHandler</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">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span><a href="#removelistener-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>Removes an event listener previously registered with IfcClient.addListener | addListener.</p>
|
|
43
45
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">"environmentalData"</span></span><div class="tsd-comment tsd-typography"><p>A string which specifies the type of event for which to remove an event listener.</p>
|
|
44
46
|
</div></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">EnvDataHandler</span></span><div class="tsd-comment tsd-typography"><p>The event handler to remove from the event target.</p>
|
|
45
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.removeListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
47
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IfcClient</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DedicatedWorkerGlobalScope</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.removeListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L94">BaseClient.ts:94</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="requestmodal"><span>request<wbr/>Modal</span><a href="#requestmodal" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="requestmodal-1"><span class="tsd-kind-call-signature">requestModal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modalRequest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ModalRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#requestmodal-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>Asks the host application to open a modal dialog.</p>
|
|
46
48
|
<p>The modalId property names the modal that should be displayed
|
|
47
49
|
Data passed via the modalData property can be used by the host application to set up initial state specific to that modal</p>
|
|
48
50
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">modalRequest</span>: <span class="tsd-signature-type">ModalRequest</span></span><div class="tsd-comment tsd-typography"><p>the ID and any data specific to the modal instance required</p>
|
|
49
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.requestModal</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
51
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.requestModal</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L321">BaseClient.ts:321</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="requestnavigation"><span>request<wbr/>Navigation</span><a href="#requestnavigation" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="requestnavigation-1"><span class="tsd-kind-call-signature">requestNavigation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NavRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#requestnavigation-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>Asks the host application to navigate to a new location.</p>
|
|
50
52
|
<p>By requesting navigation from the host app instead of navigating directly in the client frame,
|
|
51
53
|
a host-client pair can maintain a consistent browser history even if the client frame is removed
|
|
52
54
|
from the page in some situations. It also helps avoid any corner-case differences in how older
|
|
53
55
|
browsers handle iframe history</p>
|
|
54
56
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">destination</span>: <span class="tsd-signature-type">NavRequest</span></span><div class="tsd-comment tsd-typography"><p>a description of where the client wants to navigate the app to.</p>
|
|
55
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.requestNavigation</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
57
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.requestNavigation</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L381">BaseClient.ts:381</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="requestnotification"><span>request<wbr/>Notification</span><a href="#requestnotification" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="requestnotification-1"><span class="tsd-kind-call-signature">requestNotification</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">notification</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Notification</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#requestnotification-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>Asks the host application to display a user notification.</p>
|
|
56
58
|
<p>The page embedding the client app is responsible for handling the fired custom event and
|
|
57
59
|
presenting/styling the notification. Application-specific concerns such as level, TTLs,
|
|
58
60
|
ids for action callbacks (notification click, notification action buttons), etc. can be passed via
|
|
@@ -67,25 +69,25 @@ the <code>custom</code> property of the <code>notification</code> type.</p>
|
|
|
67
69
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-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><pre><code class="typescript"><span class="hl-4">client</span><span class="hl-2">.</span><span class="hl-5">requestNotification</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-4">title:</span><span class="hl-2"> </span><span class="hl-3">'Hello'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-4">message:</span><span class="hl-2"> </span><span class="hl-3">'World'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-4">custom:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-4">displaySeconds:</span><span class="hl-2"> </span><span class="hl-12">5</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-4">level:</span><span class="hl-2"> </span><span class="hl-3">'info'</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">});</span>
|
|
68
70
|
</code><button type="button">Copy</button></pre>
|
|
69
71
|
|
|
70
|
-
</div></div><aside class="tsd-sources"><p>Inherited from IfcClient.requestNotification</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
71
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">messagePrompt</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><aside class="tsd-sources"><p>Inherited from IfcClient.requestPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
72
|
+
</div></div><aside class="tsd-sources"><p>Inherited from IfcClient.requestNotification</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L363">BaseClient.ts:363</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="requestpromptonleave"><span>request<wbr/>Prompt<wbr/>On<wbr/>Leave</span><a href="#requestpromptonleave" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="requestpromptonleave-1"><span class="tsd-kind-call-signature">requestPromptOnLeave</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">messagePrompt</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><a href="#requestpromptonleave-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>Asks the host application to display a prompt on leave dialog.</p>
|
|
73
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">messagePrompt</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><aside class="tsd-sources"><p>Inherited from IfcClient.requestPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L391">BaseClient.ts:391</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="sendpagemetadata"><span>send<wbr/>Page<wbr/>Metadata</span><a href="#sendpagemetadata" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="sendpagemetadata-1"><span class="tsd-kind-call-signature">sendPageMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PageMetadata</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sendpagemetadata-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 page metadata to host for display and browser settings</p>
|
|
72
74
|
<p>title property is for the page title in the browser
|
|
73
75
|
breadcrumbs is an array of breadcrumb data for display in host application
|
|
74
76
|
custom is any custom data wanting to be sent by client app</p>
|
|
75
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">metadata</span>: <span class="tsd-signature-type">PageMetadata</span></span><div class="tsd-comment tsd-typography"><p>data that will be used for display in host application and browser page title</p>
|
|
76
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.sendPageMetadata</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
77
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.start</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
78
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.sendPageMetadata</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L417">BaseClient.ts:417</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="start"><span>start</span><a href="#start" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="start-1"><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#start-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 responding to events triggered by the host application.</p>
|
|
79
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.start</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L266">BaseClient.ts:266</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="stop"><span>stop</span><a href="#stop" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="stop-1"><span class="tsd-kind-call-signature">stop</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stop-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>Disconnects this client from the host application. This is mostly provided for
|
|
78
80
|
the sake of API completeness. It's unlikely to be used by most applications.</p>
|
|
79
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.stop</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
81
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.stop</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L291">BaseClient.ts:291</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="urlfromclientpath"><span>url<wbr/>From<wbr/>Client<wbr/>Path</span><a href="#urlfromclientpath" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="urlfromclientpath-1"><span class="tsd-kind-call-signature">urlFromClientPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientRoute</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">string</span><a href="#urlfromclientpath-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>Translates a client route like <code>/foo/bar</code> to the full URL used in the host
|
|
80
82
|
app for the same page, e.g. <code>https://hostapp.com/#/client-app/foo/bar</code>.
|
|
81
83
|
You should use this whenever generating an internal link within a client
|
|
82
84
|
application so that the user gets a nice experience if they open a link in
|
|
83
85
|
a new tab, or copy and paste a link URL into a chat message or email.</p>
|
|
84
86
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clientRoute</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The /-separated path within the client app to link to.</p>
|
|
85
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.urlFromClientPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
87
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.urlFromClientPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L196">BaseClient.ts:196</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="urlfromhostpath"><span>url<wbr/>From<wbr/>Host<wbr/>Path</span><a href="#urlfromhostpath" 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 tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="urlfromhostpath-1"><span class="tsd-kind-call-signature">urlFromHostPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hostRoute</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">string</span><a href="#urlfromhostpath-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>Translates a host route like <code>/app2</code> to the full URL used in the host
|
|
86
88
|
app, e.g. <code>https://hostapp.com/#/app2</code>.
|
|
87
89
|
You should use this whenever generating a host link within a client
|
|
88
90
|
application so that the user gets a nice experience if they open a link in
|
|
89
91
|
a new tab, or copy and paste a link URL into a chat message or email.</p>
|
|
90
92
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hostRoute</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The /-separated path within the host app to link to.</p>
|
|
91
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.urlFromHostPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/
|
|
93
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from IfcClient.urlFromHostPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/10cc162dd92457c590c059bfc3f7dff2ed01249a/packages/iframe-coordinator/src/BaseClient.ts#L212">BaseClient.ts:212</a></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-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></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-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="#environmentdata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>environment<wbr/>Data</span></a><a href="#messaging" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>messaging</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="#addlistener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#ashosturl" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Host<wbr/>Url</span></a><a href="#clearpromptonleave" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Prompt<wbr/>On<wbr/>Leave</span></a><a href="#publish" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a><a href="#removealllisteners" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#removelistener" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a><a href="#requestmodal" class="tsd-is-inherited"><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/>Modal</span></a><a href="#requestnavigation" class="tsd-is-inherited"><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/>Navigation</span></a><a href="#requestnotification" class="tsd-is-inherited"><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/>Notification</span></a><a href="#requestpromptonleave" class="tsd-is-inherited"><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/>Prompt<wbr/>On<wbr/>Leave</span></a><a href="#sendpagemetadata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Page<wbr/>Metadata</span></a><a href="#start" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a><a href="#stop" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a><a href="#urlfromclientpath" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>url<wbr/>From<wbr/>Client<wbr/>Path</span></a><a href="#urlfromhostpath" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>url<wbr/>From<wbr/>Host<wbr/>Path</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">iframe-coordinator - v6.4.0-beta.561c590.0</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>
|