iframe-coordinator-cli 6.4.0 → 6.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist/assets/index-DEUCFuke.css +1 -0
  2. package/dist/assets/index-DejhDHus.js +57 -0
  3. package/dist/favicon.svg +1 -0
  4. package/dist/ifc-docs/assets/hierarchy.js +1 -1
  5. package/dist/ifc-docs/assets/highlight.css +130 -91
  6. package/dist/ifc-docs/assets/icons.js +20 -17
  7. package/dist/ifc-docs/assets/icons.svg +1 -1
  8. package/dist/ifc-docs/assets/main.js +2535 -5
  9. package/dist/ifc-docs/assets/navigation.js +2 -1
  10. package/dist/ifc-docs/assets/search.js +2 -1
  11. package/dist/ifc-docs/assets/style.css +1571 -1581
  12. package/dist/ifc-docs/classes/client.Client.html +2388 -99
  13. package/dist/ifc-docs/classes/client.WorkerClient.html +2164 -0
  14. package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
  15. package/dist/ifc-docs/classes/host.WorkerPool.html +879 -0
  16. package/dist/ifc-docs/documents/client-setup.html +579 -75
  17. package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
  18. package/dist/ifc-docs/hierarchy.html +168 -1
  19. package/dist/ifc-docs/index.html +432 -31
  20. package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
  21. package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -0
  22. package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
  23. package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
  24. package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
  25. package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -0
  26. package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -0
  27. package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -0
  28. package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -0
  29. package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -0
  30. package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -0
  31. package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -0
  32. package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -0
  33. package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -0
  34. package/dist/ifc-docs/interfaces/messages.Notification.html +435 -0
  35. package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -0
  36. package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -0
  37. package/dist/ifc-docs/interfaces/messages.Publication.html +443 -0
  38. package/dist/ifc-docs/modules/client.html +742 -2
  39. package/dist/ifc-docs/modules/host.html +647 -1
  40. package/dist/ifc-docs/modules/messages.html +462 -0
  41. package/dist/ifc-docs/modules.html +359 -1
  42. package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -5
  43. package/dist/ifc-docs/types/client.EventHandler.html +247 -2
  44. package/dist/index.html +3 -3
  45. package/package.json +3 -4
  46. package/dist/assets/index-BLdxgMq2.css +0 -1
  47. package/dist/assets/index-IcxzuslN.js +0 -49
  48. package/dist/ifc-docs/classes/client.EventEmitter.html +0 -14
  49. package/dist/ifc-docs/interfaces/client.Breadcrumb.html +0 -6
  50. package/dist/ifc-docs/interfaces/client.EnvData.html +0 -11
  51. package/dist/ifc-docs/interfaces/client.KeyData.html +0 -12
  52. package/dist/ifc-docs/interfaces/client.ModalRequest.html +0 -6
  53. package/dist/ifc-docs/interfaces/client.NavRequest.html +0 -9
  54. package/dist/ifc-docs/interfaces/client.Notification.html +0 -9
  55. package/dist/ifc-docs/interfaces/client.PageMetadata.html +0 -8
  56. package/dist/ifc-docs/interfaces/client.PromptOnLeave.html +0 -9
  57. package/dist/ifc-docs/interfaces/client.Publication.html +0 -11
@@ -1,24 +1,850 @@
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</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</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
- configured client applications that will render in that frame. It will be
3
- registered as <code>frame-router</code> by a call to [[registerCustomElements]] and
4
- should not be created directly. Instead, add a <code>&lt;frame-router&gt;</code> element to your
5
- markup or use <code>document.createElement('frame-router')</code> after calling
6
- [[registerCustomElements]].</p>
7
- </div></section><section class="tsd-panel tsd-hierarchy" data-refl="99"><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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L29">elements/frame-router.ts:29</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
- <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
- </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
- <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
- <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> <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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L187">elements/frame-router.ts:187</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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L191">elements/frame-router.ts:191</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> <a href="client.EventEmitter.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/client.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a><span class="tsd-signature-symbol">&gt;</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 <a href="client.EventEmitter.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/client.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L103">elements/frame-router.ts:103</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
- </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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L125">elements/frame-router.ts:125</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> <a href="../interfaces/client.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a><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
- </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>: <a href="../interfaces/client.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a></span><div class="tsd-comment tsd-typography"><p>The information published to the client fragment.
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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L113">elements/frame-router.ts:113</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> <a href="../interfaces/client.EnvData.html" class="tsd-signature-type tsd-kind-interface">EnvData</a><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
- the environmental data required the clients.</p>
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
- </div></li><li><span><span class="tsd-kind-parameter">envData</span>: <a href="../interfaces/client.EnvData.html" class="tsd-signature-type tsd-kind-interface">EnvData</a></span><div class="tsd-comment tsd-typography"><p>Information about the host environment.</p>
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/0927c82358918a080e4b0ebe1e2829fb81b8ba67/packages/iframe-coordinator/src/elements/frame-router.ts#L89">elements/frame-router.ts:89</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</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
+ <!doctype html>
2
+ <html class="default" lang="en" data-base="../">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>FrameRouterElement | iframe-coordinator - v6.5.1</title>
7
+ <meta name="description" content="Documentation for iframe-coordinator" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ window.app
24
+ ? app.showPage()
25
+ : document.body.style.removeProperty("display"),
26
+ 500,
27
+ );
28
+ </script>
29
+ <header class="tsd-page-toolbar">
30
+ <div class="tsd-toolbar-contents container">
31
+ <a href="../index.html" class="title">iframe-coordinator - v6.5.1</a>
32
+ <div id="tsd-toolbar-links"></div>
33
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
34
+ <svg
35
+ width="16"
36
+ height="16"
37
+ viewBox="0 0 16 16"
38
+ fill="none"
39
+ aria-hidden="true"
40
+ >
41
+ <use href="../assets/icons.svg#icon-search"></use>
42
+ </svg>
43
+ </button>
44
+ <dialog id="tsd-search" aria-label="Search">
45
+ <input
46
+ role="combobox"
47
+ id="tsd-search-input"
48
+ aria-controls="tsd-search-results"
49
+ aria-autocomplete="list"
50
+ aria-expanded="true"
51
+ autocapitalize="off"
52
+ autocomplete="off"
53
+ placeholder="Search the docs"
54
+ maxlength="100"
55
+ />
56
+ <ul role="listbox" id="tsd-search-results"></ul>
57
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
58
+ <div>Preparing search index...</div>
59
+ </div>
60
+ </dialog>
61
+ <a
62
+ href="#"
63
+ class="tsd-widget menu"
64
+ id="tsd-toolbar-menu-trigger"
65
+ data-toggle="menu"
66
+ aria-label="Menu"
67
+ ><svg
68
+ width="16"
69
+ height="16"
70
+ viewBox="0 0 16 16"
71
+ fill="none"
72
+ aria-hidden="true"
73
+ >
74
+ <use href="../assets/icons.svg#icon-menu"></use></svg
75
+ ></a>
76
+ </div>
77
+ </header>
78
+ <div class="container container-main">
79
+ <div class="col-content">
80
+ <div class="tsd-page-title">
81
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
82
+ <li><a href="../modules/host.html">host</a></li>
83
+ <li><a href="" aria-current="page">FrameRouterElement</a></li>
84
+ </ul>
85
+ <h1>Class FrameRouterElement</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ A custom element responsible for rendering an iframe and
91
+ communicating with configured client applications that will render
92
+ in that frame. It will be registered as
93
+ <code>frame-router</code> by a call to [[registerCustomElements]]
94
+ and should not be created directly. Instead, add a
95
+ <code>&lt;frame-router&gt;</code> element to your markup or use
96
+ <code>document.createElement('frame-router')</code> after calling
97
+ [[registerCustomElements]].
98
+ </p>
99
+ </div>
100
+ </section>
101
+ <section class="tsd-panel tsd-hierarchy" data-refl="42">
102
+ <h4>Hierarchy</h4>
103
+ <ul class="tsd-hierarchy">
104
+ <li class="tsd-hierarchy-item">
105
+ <a
106
+ href="https://developer.mozilla.org/docs/Web/API/HTMLElement"
107
+ class="tsd-signature-type external"
108
+ target="_blank"
109
+ >HTMLElement</a
110
+ >
111
+ <ul class="tsd-hierarchy">
112
+ <li class="tsd-hierarchy-item">
113
+ <span class="tsd-hierarchy-target">FrameRouterElement</span>
114
+ </li>
115
+ </ul>
116
+ </li>
117
+ </ul>
118
+ </section>
119
+ <aside class="tsd-sources">
120
+ <ul>
121
+ <li>
122
+ Defined in
123
+ <a
124
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L30"
125
+ >elements/frame-router.ts:30</a
126
+ >
127
+ </li>
128
+ </ul>
129
+ </aside>
130
+ <section class="tsd-panel-group tsd-index-group">
131
+ <section class="tsd-panel tsd-index-panel">
132
+ <details class="tsd-index-content tsd-accordion" open>
133
+ <summary class="tsd-accordion-summary tsd-index-summary">
134
+ <svg
135
+ width="20"
136
+ height="20"
137
+ viewBox="0 0 24 24"
138
+ fill="none"
139
+ aria-hidden="true"
140
+ >
141
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
142
+ </svg>
143
+ <h5 class="tsd-index-heading uppercase">Index</h5>
144
+ </summary>
145
+ <div class="tsd-accordion-details">
146
+ <section class="tsd-index-section">
147
+ <h3 class="tsd-index-heading">Accessors</h3>
148
+ <div class="tsd-index-list">
149
+ <a href="#clientconfig" class="tsd-index-link"
150
+ ><svg
151
+ class="tsd-kind-icon"
152
+ viewBox="0 0 24 24"
153
+ aria-label="Accessor"
154
+ >
155
+ <use href="../assets/icons.svg#icon-262144"></use></svg
156
+ ><span>client<wbr />Config</span></a
157
+ >
158
+ <a href="#messaging" class="tsd-index-link"
159
+ ><svg
160
+ class="tsd-kind-icon"
161
+ viewBox="0 0 24 24"
162
+ aria-label="Accessor"
163
+ >
164
+ <use href="../assets/icons.svg#icon-262144"></use></svg
165
+ ><span>messaging</span></a
166
+ >
167
+ </div>
168
+ </section>
169
+ <section class="tsd-index-section">
170
+ <h3 class="tsd-index-heading">Methods</h3>
171
+ <div class="tsd-index-list">
172
+ <a href="#changeroute" class="tsd-index-link"
173
+ ><svg
174
+ class="tsd-kind-icon"
175
+ viewBox="0 0 24 24"
176
+ aria-label="Method"
177
+ >
178
+ <use href="../assets/icons.svg#icon-2048"></use></svg
179
+ ><span>change<wbr />Route</span></a
180
+ >
181
+ <a href="#publish" class="tsd-index-link"
182
+ ><svg
183
+ class="tsd-kind-icon"
184
+ viewBox="0 0 24 24"
185
+ aria-label="Method"
186
+ >
187
+ <use href="../assets/icons.svg#icon-2048"></use></svg
188
+ ><span>publish</span></a
189
+ >
190
+ <a href="#setupframes" class="tsd-index-link deprecated"
191
+ ><svg
192
+ class="tsd-kind-icon"
193
+ viewBox="0 0 24 24"
194
+ aria-label="Method"
195
+ >
196
+ <use href="../assets/icons.svg#icon-2048"></use></svg
197
+ ><span>setup<wbr />Frames</span></a
198
+ >
199
+ </div>
200
+ </section>
201
+ </div>
202
+ </details>
203
+ </section>
204
+ </section>
205
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
206
+ <summary class="tsd-accordion-summary" data-key="section-Accessors">
207
+ <svg
208
+ width="20"
209
+ height="20"
210
+ viewBox="0 0 24 24"
211
+ fill="none"
212
+ aria-hidden="true"
213
+ >
214
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
215
+ </svg>
216
+ <h2>Accessors</h2>
217
+ </summary>
218
+ <section>
219
+ <section class="tsd-panel tsd-member">
220
+ <h3 class="tsd-anchor-link" id="clientconfig">
221
+ <span>client<wbr />Config</span
222
+ ><a
223
+ href="#clientconfig"
224
+ aria-label="Permalink"
225
+ class="tsd-anchor-icon"
226
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
227
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
228
+ ></a>
229
+ </h3>
230
+ <ul class="tsd-signatures">
231
+ <li>
232
+ <div class="tsd-signature" id="clientconfigclientconfig">
233
+ <span class="tsd-signature-keyword">get</span>
234
+ <span class="tsd-kind-get-signature">clientConfig</span
235
+ ><span class="tsd-signature-symbol">()</span
236
+ ><span class="tsd-signature-symbol">:</span>
237
+ <a
238
+ href="../interfaces/host.ClientConfig.html"
239
+ class="tsd-signature-type tsd-kind-interface"
240
+ >ClientConfig</a
241
+ >
242
+ </div>
243
+ <div class="tsd-description">
244
+ <div class="tsd-comment tsd-typography">
245
+ <p>
246
+ A property that can be set to initialize the host frame
247
+ </p>
248
+ </div>
249
+ <h4 class="tsd-returns-title">
250
+ Returns
251
+ <a
252
+ href="../interfaces/host.ClientConfig.html"
253
+ class="tsd-signature-type tsd-kind-interface"
254
+ >ClientConfig</a
255
+ >
256
+ </h4>
257
+ <aside class="tsd-sources">
258
+ <ul>
259
+ <li>
260
+ Defined in
261
+ <a
262
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L188"
263
+ >elements/frame-router.ts:188</a
264
+ >
265
+ </li>
266
+ </ul>
267
+ </aside>
268
+ </div>
269
+ </li>
270
+ <li>
271
+ <div class="tsd-signature" id="clientconfigclientconfig-1">
272
+ <span class="tsd-signature-keyword">set</span>
273
+ <span class="tsd-kind-set-signature">clientConfig</span
274
+ ><span class="tsd-signature-symbol">(</span
275
+ ><span class="tsd-kind-parameter">clientConfig</span
276
+ ><span class="tsd-signature-symbol">:</span>
277
+ <a
278
+ href="../interfaces/host.ClientConfig.html"
279
+ class="tsd-signature-type tsd-kind-interface"
280
+ >ClientConfig</a
281
+ ><span class="tsd-signature-symbol">)</span
282
+ ><span class="tsd-signature-symbol">:</span>
283
+ <span class="tsd-signature-type">void</span>
284
+ </div>
285
+ <div class="tsd-description">
286
+ <div class="tsd-parameters">
287
+ <h4 class="tsd-parameters-title">Parameters</h4>
288
+ <ul class="tsd-parameter-list">
289
+ <li>
290
+ <span
291
+ ><span class="tsd-kind-parameter">clientConfig</span
292
+ >:
293
+ <a
294
+ href="../interfaces/host.ClientConfig.html"
295
+ class="tsd-signature-type tsd-kind-interface"
296
+ >ClientConfig</a
297
+ ></span
298
+ >
299
+ </li>
300
+ </ul>
301
+ </div>
302
+ <h4 class="tsd-returns-title">
303
+ Returns <span class="tsd-signature-type">void</span>
304
+ </h4>
305
+ <aside class="tsd-sources">
306
+ <ul>
307
+ <li>
308
+ Defined in
309
+ <a
310
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L192"
311
+ >elements/frame-router.ts:192</a
312
+ >
313
+ </li>
314
+ </ul>
315
+ </aside>
316
+ </div>
317
+ </li>
318
+ </ul>
319
+ </section>
320
+ <section class="tsd-panel tsd-member">
321
+ <h3 class="tsd-anchor-link" id="messaging">
322
+ <span>messaging</span
323
+ ><a
324
+ href="#messaging"
325
+ aria-label="Permalink"
326
+ class="tsd-anchor-icon"
327
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
328
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
329
+ ></a>
330
+ </h3>
331
+ <ul class="tsd-signatures">
332
+ <li>
333
+ <div class="tsd-signature" id="messagingmessaging">
334
+ <span class="tsd-signature-keyword">get</span>
335
+ <span class="tsd-kind-get-signature">messaging</span
336
+ ><span class="tsd-signature-symbol">()</span
337
+ ><span class="tsd-signature-symbol">:</span>
338
+ <a
339
+ href="../interfaces/client.EventEmitter.html"
340
+ class="tsd-signature-type tsd-kind-interface"
341
+ >EventEmitter</a
342
+ ><span class="tsd-signature-symbol">&lt;</span
343
+ ><a
344
+ href="../interfaces/messages.Publication.html"
345
+ class="tsd-signature-type tsd-kind-interface"
346
+ >Publication</a
347
+ ><span class="tsd-signature-symbol">&gt;</span>
348
+ </div>
349
+ <div class="tsd-description">
350
+ <div class="tsd-comment tsd-typography">
351
+ <p>
352
+ Eventing for published messages from the host
353
+ application.
354
+ </p>
355
+ </div>
356
+ <h4 class="tsd-returns-title">
357
+ Returns
358
+ <a
359
+ href="../interfaces/client.EventEmitter.html"
360
+ class="tsd-signature-type tsd-kind-interface"
361
+ >EventEmitter</a
362
+ ><span class="tsd-signature-symbol">&lt;</span
363
+ ><a
364
+ href="../interfaces/messages.Publication.html"
365
+ class="tsd-signature-type tsd-kind-interface"
366
+ >Publication</a
367
+ ><span class="tsd-signature-symbol">&gt;</span>
368
+ </h4>
369
+ <aside class="tsd-sources">
370
+ <ul>
371
+ <li>
372
+ Defined in
373
+ <a
374
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L104"
375
+ >elements/frame-router.ts:104</a
376
+ >
377
+ </li>
378
+ </ul>
379
+ </aside>
380
+ </div>
381
+ </li>
382
+ </ul>
383
+ </section>
384
+ </section>
385
+ </details>
386
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
387
+ <summary class="tsd-accordion-summary" data-key="section-Methods">
388
+ <svg
389
+ width="20"
390
+ height="20"
391
+ viewBox="0 0 24 24"
392
+ fill="none"
393
+ aria-hidden="true"
394
+ >
395
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
396
+ </svg>
397
+ <h2>Methods</h2>
398
+ </summary>
399
+ <section>
400
+ <section class="tsd-panel tsd-member">
401
+ <h3 class="tsd-anchor-link" id="changeroute">
402
+ <span>change<wbr />Route</span
403
+ ><a
404
+ href="#changeroute"
405
+ aria-label="Permalink"
406
+ class="tsd-anchor-icon"
407
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
408
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
409
+ ></a>
410
+ </h3>
411
+ <ul class="tsd-signatures">
412
+ <li class="">
413
+ <div class="tsd-signature tsd-anchor-link" id="changeroute-1">
414
+ <span class="tsd-kind-call-signature">changeRoute</span
415
+ ><span class="tsd-signature-symbol">(</span
416
+ ><span class="tsd-kind-parameter">newPath</span
417
+ ><span class="tsd-signature-symbol">:</span>
418
+ <span class="tsd-signature-type">string</span
419
+ ><span class="tsd-signature-symbol">)</span
420
+ ><span class="tsd-signature-symbol">:</span>
421
+ <span class="tsd-signature-type">void</span
422
+ ><a
423
+ href="#changeroute-1"
424
+ aria-label="Permalink"
425
+ class="tsd-anchor-icon"
426
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
427
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
428
+ ></a>
429
+ </div>
430
+ <div class="tsd-description">
431
+ <div class="tsd-comment tsd-typography">
432
+ <p>Changes the route the client fragment is rendering.</p>
433
+ </div>
434
+ <div class="tsd-parameters">
435
+ <h4 class="tsd-parameters-title">Parameters</h4>
436
+ <ul class="tsd-parameter-list">
437
+ <li>
438
+ <span
439
+ ><span class="tsd-kind-parameter">newPath</span>:
440
+ <span class="tsd-signature-type">string</span></span
441
+ >
442
+ <div class="tsd-comment tsd-typography">
443
+ <p>
444
+ a new route which matches those provided
445
+ originally.
446
+ </p>
447
+ </div>
448
+ </li>
449
+ </ul>
450
+ </div>
451
+ <h4 class="tsd-returns-title">
452
+ Returns <span class="tsd-signature-type">void</span>
453
+ </h4>
454
+ <aside class="tsd-sources">
455
+ <ul>
456
+ <li>
457
+ Defined in
458
+ <a
459
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L126"
460
+ >elements/frame-router.ts:126</a
461
+ >
462
+ </li>
463
+ </ul>
464
+ </aside>
465
+ </div>
466
+ </li>
467
+ </ul>
468
+ </section>
469
+ <section class="tsd-panel tsd-member">
470
+ <h3 class="tsd-anchor-link" id="publish">
471
+ <span>publish</span
472
+ ><a
473
+ href="#publish"
474
+ aria-label="Permalink"
475
+ class="tsd-anchor-icon"
476
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
477
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
478
+ ></a>
479
+ </h3>
480
+ <ul class="tsd-signatures">
481
+ <li class="">
482
+ <div class="tsd-signature tsd-anchor-link" id="publish-1">
483
+ <span class="tsd-kind-call-signature">publish</span
484
+ ><span class="tsd-signature-symbol">(</span
485
+ ><span class="tsd-kind-parameter">publication</span
486
+ ><span class="tsd-signature-symbol">:</span>
487
+ <a
488
+ href="../interfaces/messages.Publication.html"
489
+ class="tsd-signature-type tsd-kind-interface"
490
+ >Publication</a
491
+ ><span class="tsd-signature-symbol">)</span
492
+ ><span class="tsd-signature-symbol">:</span>
493
+ <span class="tsd-signature-type">void</span
494
+ ><a
495
+ href="#publish-1"
496
+ aria-label="Permalink"
497
+ class="tsd-anchor-icon"
498
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
499
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
500
+ ></a>
501
+ </div>
502
+ <div class="tsd-description">
503
+ <div class="tsd-comment tsd-typography">
504
+ <p>Publish a message to the client fragment.</p>
505
+ </div>
506
+ <div class="tsd-parameters">
507
+ <h4 class="tsd-parameters-title">Parameters</h4>
508
+ <ul class="tsd-parameter-list">
509
+ <li>
510
+ <span
511
+ ><span class="tsd-kind-parameter">publication</span
512
+ >:
513
+ <a
514
+ href="../interfaces/messages.Publication.html"
515
+ class="tsd-signature-type tsd-kind-interface"
516
+ >Publication</a
517
+ ></span
518
+ >
519
+ <div class="tsd-comment tsd-typography">
520
+ <p>
521
+ The information published to the client fragment.
522
+ The topic may not be of interest, and could be
523
+ ignored.
524
+ </p>
525
+ </div>
526
+ </li>
527
+ </ul>
528
+ </div>
529
+ <h4 class="tsd-returns-title">
530
+ Returns <span class="tsd-signature-type">void</span>
531
+ </h4>
532
+ <aside class="tsd-sources">
533
+ <ul>
534
+ <li>
535
+ Defined in
536
+ <a
537
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L114"
538
+ >elements/frame-router.ts:114</a
539
+ >
540
+ </li>
541
+ </ul>
542
+ </aside>
543
+ </div>
544
+ </li>
545
+ </ul>
546
+ </section>
547
+ <section class="tsd-panel tsd-member">
548
+ <h3 class="tsd-anchor-link" id="setupframes">
549
+ <span class="deprecated">setup<wbr />Frames</span
550
+ ><a
551
+ href="#setupframes"
552
+ aria-label="Permalink"
553
+ class="tsd-anchor-icon"
554
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
555
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
556
+ ></a>
557
+ </h3>
558
+ <ul class="tsd-signatures">
559
+ <li class="">
560
+ <div class="tsd-signature tsd-anchor-link" id="setupframes-1">
561
+ <span class="tsd-kind-call-signature">setupFrames</span
562
+ ><span class="tsd-signature-symbol">(</span
563
+ ><span class="tsd-kind-parameter">clients</span
564
+ ><span class="tsd-signature-symbol">:</span>
565
+ <a
566
+ href="../interfaces/host.RoutingMap.html"
567
+ class="tsd-signature-type tsd-kind-interface"
568
+ >RoutingMap</a
569
+ ><span class="tsd-signature-symbol">,</span>
570
+ <span class="tsd-kind-parameter">envData</span
571
+ ><span class="tsd-signature-symbol">:</span>
572
+ <a
573
+ href="../interfaces/messages.EnvData.html"
574
+ class="tsd-signature-type tsd-kind-interface"
575
+ >EnvData</a
576
+ ><span class="tsd-signature-symbol">)</span
577
+ ><span class="tsd-signature-symbol">:</span>
578
+ <span class="tsd-signature-type">void</span
579
+ ><a
580
+ href="#setupframes-1"
581
+ aria-label="Permalink"
582
+ class="tsd-anchor-icon"
583
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
584
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
585
+ ></a>
586
+ </div>
587
+ <div class="tsd-description">
588
+ <div class="tsd-comment tsd-typography">
589
+ <p>
590
+ Initializes this host frame with the possible clients
591
+ and the environmental data required the clients.
592
+ </p>
593
+ </div>
594
+ <div class="tsd-parameters">
595
+ <h4 class="tsd-parameters-title">Parameters</h4>
596
+ <ul class="tsd-parameter-list">
597
+ <li>
598
+ <span
599
+ ><span class="tsd-kind-parameter">clients</span>:
600
+ <a
601
+ href="../interfaces/host.RoutingMap.html"
602
+ class="tsd-signature-type tsd-kind-interface"
603
+ >RoutingMap</a
604
+ ></span
605
+ >
606
+ <div class="tsd-comment tsd-typography">
607
+ <p>
608
+ The map of registrations for the available
609
+ clients.
610
+ </p>
611
+ </div>
612
+ </li>
613
+ <li>
614
+ <span
615
+ ><span class="tsd-kind-parameter">envData</span>:
616
+ <a
617
+ href="../interfaces/messages.EnvData.html"
618
+ class="tsd-signature-type tsd-kind-interface"
619
+ >EnvData</a
620
+ ></span
621
+ >
622
+ <div class="tsd-comment tsd-typography">
623
+ <p>Information about the host environment.</p>
624
+ </div>
625
+ </li>
626
+ </ul>
627
+ </div>
628
+ <h4 class="tsd-returns-title">
629
+ Returns <span class="tsd-signature-type">void</span>
630
+ </h4>
631
+ <div class="tsd-comment tsd-typography">
632
+ <div class="tsd-tag-deprecated">
633
+ <h4 class="tsd-anchor-link" id="deprecated">
634
+ Deprecated<a
635
+ href="#deprecated"
636
+ aria-label="Permalink"
637
+ class="tsd-anchor-icon"
638
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
639
+ <use
640
+ href="../assets/icons.svg#icon-anchor"
641
+ ></use></svg
642
+ ></a>
643
+ </h4>
644
+ <p>
645
+ Use the new
646
+ <a href="#clientconfig" class="tsd-kind-accessor"
647
+ >clientConfig</a
648
+ >
649
+ property instead
650
+ </p>
651
+ </div>
652
+ </div>
653
+ <aside class="tsd-sources">
654
+ <ul>
655
+ <li>
656
+ Defined in
657
+ <a
658
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/elements/frame-router.ts#L90"
659
+ >elements/frame-router.ts:90</a
660
+ >
661
+ </li>
662
+ </ul>
663
+ </aside>
664
+ </div>
665
+ </li>
666
+ </ul>
667
+ </section>
668
+ </section>
669
+ </details>
670
+ </div>
671
+ <div class="col-sidebar">
672
+ <div class="page-menu">
673
+ <div class="tsd-navigation settings">
674
+ <details class="tsd-accordion">
675
+ <summary class="tsd-accordion-summary">
676
+ <svg
677
+ width="20"
678
+ height="20"
679
+ viewBox="0 0 24 24"
680
+ fill="none"
681
+ aria-hidden="true"
682
+ >
683
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
684
+ </svg>
685
+ <h3>Settings</h3>
686
+ </summary>
687
+ <div class="tsd-accordion-details">
688
+ <div class="tsd-filter-visibility">
689
+ <span class="settings-label">Member Visibility</span>
690
+ <ul id="tsd-filter-options">
691
+ <li class="tsd-filter-item">
692
+ <label class="tsd-filter-input"
693
+ ><input
694
+ type="checkbox"
695
+ id="tsd-filter-inherited"
696
+ name="inherited"
697
+ checked
698
+ /><svg
699
+ width="32"
700
+ height="32"
701
+ viewBox="0 0 32 32"
702
+ aria-hidden="true"
703
+ >
704
+ <rect
705
+ class="tsd-checkbox-background"
706
+ width="30"
707
+ height="30"
708
+ x="1"
709
+ y="1"
710
+ rx="6"
711
+ fill="none"
712
+ ></rect>
713
+ <path
714
+ class="tsd-checkbox-checkmark"
715
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
716
+ stroke="none"
717
+ stroke-width="3.5"
718
+ stroke-linejoin="round"
719
+ fill="none"
720
+ ></path></svg
721
+ ><span>Inherited</span></label
722
+ >
723
+ </li>
724
+ </ul>
725
+ </div>
726
+ <div class="tsd-theme-toggle">
727
+ <label class="settings-label" for="tsd-theme">Theme</label
728
+ ><select id="tsd-theme">
729
+ <option value="os">OS</option>
730
+ <option value="light">Light</option>
731
+ <option value="dark">Dark</option>
732
+ </select>
733
+ </div>
734
+ </div>
735
+ </details>
736
+ </div>
737
+ <details open class="tsd-accordion tsd-page-navigation">
738
+ <summary class="tsd-accordion-summary">
739
+ <svg
740
+ width="20"
741
+ height="20"
742
+ viewBox="0 0 24 24"
743
+ fill="none"
744
+ aria-hidden="true"
745
+ >
746
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
747
+ </svg>
748
+ <h3>On This Page</h3>
749
+ </summary>
750
+ <div class="tsd-accordion-details">
751
+ <details open class="tsd-accordion tsd-page-navigation-section">
752
+ <summary
753
+ class="tsd-accordion-summary"
754
+ data-key="section-Accessors"
755
+ >
756
+ <svg
757
+ width="20"
758
+ height="20"
759
+ viewBox="0 0 24 24"
760
+ fill="none"
761
+ aria-hidden="true"
762
+ >
763
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
764
+ >Accessors
765
+ </summary>
766
+ <div>
767
+ <a href="#clientconfig"
768
+ ><svg
769
+ class="tsd-kind-icon"
770
+ viewBox="0 0 24 24"
771
+ aria-label="Accessor"
772
+ >
773
+ <use href="../assets/icons.svg#icon-262144"></use></svg
774
+ ><span>client<wbr />Config</span></a
775
+ ><a href="#messaging"
776
+ ><svg
777
+ class="tsd-kind-icon"
778
+ viewBox="0 0 24 24"
779
+ aria-label="Accessor"
780
+ >
781
+ <use href="../assets/icons.svg#icon-262144"></use></svg
782
+ ><span>messaging</span></a
783
+ >
784
+ </div>
785
+ </details>
786
+ <details open class="tsd-accordion tsd-page-navigation-section">
787
+ <summary
788
+ class="tsd-accordion-summary"
789
+ data-key="section-Methods"
790
+ >
791
+ <svg
792
+ width="20"
793
+ height="20"
794
+ viewBox="0 0 24 24"
795
+ fill="none"
796
+ aria-hidden="true"
797
+ >
798
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
799
+ >Methods
800
+ </summary>
801
+ <div>
802
+ <a href="#changeroute"
803
+ ><svg
804
+ class="tsd-kind-icon"
805
+ viewBox="0 0 24 24"
806
+ aria-label="Method"
807
+ >
808
+ <use href="../assets/icons.svg#icon-2048"></use></svg
809
+ ><span>change<wbr />Route</span></a
810
+ ><a href="#publish"
811
+ ><svg
812
+ class="tsd-kind-icon"
813
+ viewBox="0 0 24 24"
814
+ aria-label="Method"
815
+ >
816
+ <use href="../assets/icons.svg#icon-2048"></use></svg
817
+ ><span>publish</span></a
818
+ ><a href="#setupframes"
819
+ ><svg
820
+ class="tsd-kind-icon"
821
+ viewBox="0 0 24 24"
822
+ aria-label="Method"
823
+ >
824
+ <use href="../assets/icons.svg#icon-2048"></use></svg
825
+ ><span>setup<wbr />Frames</span></a
826
+ >
827
+ </div>
828
+ </details>
829
+ </div>
830
+ </details>
831
+ </div>
832
+ <div class="site-menu">
833
+ <nav class="tsd-navigation">
834
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
835
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
836
+ <li>Loading...</li>
837
+ </ul>
838
+ </nav>
839
+ </div>
840
+ </div>
841
+ </div>
842
+ <footer>
843
+ <p class="tsd-generator">
844
+ Generated using
845
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
846
+ </p>
847
+ </footer>
848
+ <div class="overlay"></div>
849
+ </body>
850
+ </html>