iframe-coordinator-cli 6.5.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 (43) hide show
  1. package/dist/assets/{index-DkVijnku.js → index-DejhDHus.js} +3 -3
  2. package/dist/ifc-docs/assets/hierarchy.js +1 -1
  3. package/dist/ifc-docs/assets/highlight.css +130 -91
  4. package/dist/ifc-docs/assets/icons.js +20 -17
  5. package/dist/ifc-docs/assets/icons.svg +1 -1
  6. package/dist/ifc-docs/assets/main.js +2535 -5
  7. package/dist/ifc-docs/assets/navigation.js +2 -1
  8. package/dist/ifc-docs/assets/search.js +2 -1
  9. package/dist/ifc-docs/assets/style.css +1571 -1581
  10. package/dist/ifc-docs/classes/client.Client.html +2388 -98
  11. package/dist/ifc-docs/classes/client.WorkerClient.html +2161 -92
  12. package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
  13. package/dist/ifc-docs/classes/host.WorkerPool.html +879 -29
  14. package/dist/ifc-docs/documents/client-setup.html +579 -75
  15. package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
  16. package/dist/ifc-docs/hierarchy.html +168 -1
  17. package/dist/ifc-docs/index.html +432 -31
  18. package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
  19. package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -14
  20. package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
  21. package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
  22. package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
  23. package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -6
  24. package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -7
  25. package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -6
  26. package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -2
  27. package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -6
  28. package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -11
  29. package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -12
  30. package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -6
  31. package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -9
  32. package/dist/ifc-docs/interfaces/messages.Notification.html +435 -9
  33. package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -8
  34. package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -9
  35. package/dist/ifc-docs/interfaces/messages.Publication.html +443 -11
  36. package/dist/ifc-docs/modules/client.html +742 -2
  37. package/dist/ifc-docs/modules/host.html +647 -1
  38. package/dist/ifc-docs/modules/messages.html +462 -1
  39. package/dist/ifc-docs/modules.html +359 -1
  40. package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -1
  41. package/dist/ifc-docs/types/client.EventHandler.html +247 -2
  42. package/dist/index.html +1 -1
  43. package/package.json +3 -3
package/dist/ifc-docs/classes/client.Client.html CHANGED
@@ -1,101 +1,2391 @@
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>Client | iframe-coordinator - v6.5.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.5.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/client.html">client</a></li><li><a href="" aria-current="page">Client</a></li></ul><h1>Class Client</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="152"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">AbstractClient</span><span class="tsd-signature-symbol">&lt;</span><a href="https://developer.mozilla.org/docs/Web/API/Window" class="tsd-signature-type external" target="_blank">Window</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Client</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L16">IframeClient.ts:16</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
- </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
- <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
- </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>
5
- <a href="#ashosturl" class="tsd-index-link deprecated 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>
6
- <a href="#clearpromptonleave" 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>clear<wbr/>Prompt<wbr/>On<wbr/>Leave</span></a>
7
- <a href="#publish" 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>publish</span></a>
8
- <a href="#registercustomelements" 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>register<wbr/>Custom<wbr/>Elements</span></a>
9
- <a href="#removealllisteners" 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>remove<wbr/>All<wbr/>Listeners</span></a>
10
- <a href="#removelistener" 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>remove<wbr/>Listener</span></a>
11
- <a href="#requestmodal" 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>request<wbr/>Modal</span></a>
12
- <a href="#requestnavigation" 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>request<wbr/>Navigation</span></a>
13
- <a href="#requestnotification" 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>request<wbr/>Notification</span></a>
14
- <a href="#requestpromptonleave" 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>request<wbr/>Prompt<wbr/>On<wbr/>Leave</span></a>
15
- <a href="#sendpagemetadata" 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>send<wbr/>Page<wbr/>Metadata</span></a>
16
- <a href="#start" 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>start</span></a>
17
- <a href="#startinterceptinglinks" 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>start<wbr/>Intercepting<wbr/>Links</span></a>
18
- <a href="#stop" 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>stop</span></a>
19
- <a href="#stopinterceptinglinks" 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>stop<wbr/>Intercepting<wbr/>Links</span></a>
20
- <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>
21
- <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>
22
- </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="constructorclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/client.ClientConfigOptions.html" class="tsd-signature-type tsd-kind-interface">ClientConfigOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Client</a><a href="#constructorclient" 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-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">configOptions</span>: <a href="../interfaces/client.ClientConfigOptions.html" class="tsd-signature-type tsd-kind-interface">ClientConfigOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Client</a></h4><aside class="tsd-sources"><p>Overrides AbstractClient&lt;Window&gt;.constructor</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L20">IframeClient.ts:20</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> <a href="../interfaces/messages.EnvData.html" class="tsd-signature-type tsd-kind-interface">EnvData</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the environmental data provided by the host application. This includes
23
- the locale the client should use, the base URL of the host app, and any
24
- custom data sent by the host.</p>
25
- </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/messages.EnvData.html" class="tsd-signature-type tsd-kind-interface">EnvData</a></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.environmentData</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L171">AbstractClient.ts:171</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> <a href="../interfaces/client.EventEmitter.html" class="tsd-signature-type tsd-kind-interface">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/messages.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>Accessor for the general-purpose pub-sub bus between client and host applications.
26
- The content of messages on this bus are not defined by this API beyond a basic
27
- data wrapper of topic and payload. This is for application-specific messages
28
- agreed upon as a shared API between host and client.</p>
29
- </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/client.EventEmitter.html" class="tsd-signature-type tsd-kind-interface">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/messages.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.messaging</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L271">AbstractClient.ts:271</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><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;environmentalData&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <a href="../types/client.EnvDataHandler.html" class="tsd-signature-type tsd-kind-type-alias">EnvDataHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</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.
30
- This should not be confused with the general-purpose pub-sub listeners that can be set via the
31
- <a href="#messaging" class="tsd-kind-accessor">messaging</a> interface. Handlers should be set before calling <a href="#start" class="tsd-kind-method">start</a>, otherwise
32
- there is a risk of missing messages between when the host begins delivering data and the listener
33
- is added.</p>
34
- </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">&quot;environmentalData&quot;</span></span><div class="tsd-comment tsd-typography"><p>A case-sensitive string representing the event type to listen for. Currently, hosts only
35
- send <code>environmentalData</code> events.</p>
36
- </div></li><li><span><span class="tsd-kind-parameter">listener</span>: <a href="../types/client.EnvDataHandler.html" class="tsd-signature-type tsd-kind-type-alias">EnvDataHandler</a></span><div class="tsd-comment tsd-typography"><p>The handler which receives a notification when an event of the specified type occurs.</p>
37
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.addListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L69">AbstractClient.ts:69</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
38
- app for the same page, e.g. <code>https://hostapp.com/#/client-app/foo/bar</code>.</p>
39
- </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>
40
- </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>
41
- </div></div><aside class="tsd-sources"><p>Inherited from AbstractClient.asHostUrl</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L214">AbstractClient.ts:214</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>
42
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.clearPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L389">AbstractClient.ts:389</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> <a href="../interfaces/messages.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 general message to the host application.</p>
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">publication</span>: <a href="../interfaces/messages.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a></span><div class="tsd-comment tsd-typography"><p>The data object to be published.</p>
44
- </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 AbstractClient.publish</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L293">AbstractClient.ts:293</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="registercustomelements"><span>register<wbr/>Custom<wbr/>Elements</span><a href="#registercustomelements" 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="registercustomelements-1"><span class="tsd-kind-call-signature">registerCustomElements</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#registercustomelements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers custom elements used by the client application</p>
45
- </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/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L46">IframeClient.ts:46</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><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;environmentalData&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</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 <a href="#addlistener" class="tsd-kind-method">addListener</a>.</p>
46
- </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">&quot;environmentalData&quot;</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>
47
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.removeAllListeners</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L94">AbstractClient.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="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><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;environmentalData&quot;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <a href="../types/client.EnvDataHandler.html" class="tsd-signature-type tsd-kind-type-alias">EnvDataHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</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 <a href="#addlistener" class="tsd-kind-method">addListener</a>.</p>
48
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">&quot;environmentalData&quot;</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>
49
- </div></li><li><span><span class="tsd-kind-parameter">listener</span>: <a href="../types/client.EnvDataHandler.html" class="tsd-signature-type tsd-kind-type-alias">EnvDataHandler</a></span><div class="tsd-comment tsd-typography"><p>The event handler to remove from the event target.</p>
50
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Inherited from AbstractClient.removeListener</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L82">AbstractClient.ts:82</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> <a href="../interfaces/messages.ModalRequest.html" class="tsd-signature-type tsd-kind-interface">ModalRequest</a><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>
51
- <p>The modalId property names the modal that should be displayed
52
- Data passed via the modalData property can be used by the host application to set up initial state specific to that modal</p>
53
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">modalRequest</span>: <a href="../interfaces/messages.ModalRequest.html" class="tsd-signature-type tsd-kind-interface">ModalRequest</a></span><div class="tsd-comment tsd-typography"><p>the ID and any data specific to the modal instance required</p>
54
- </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 AbstractClient.requestModal</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L309">AbstractClient.ts:309</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> <a href="../interfaces/messages.NavRequest.html" class="tsd-signature-type tsd-kind-interface">NavRequest</a><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>
55
- <p>By requesting navigation from the host app instead of navigating directly in the client frame,
56
- a host-client pair can maintain a consistent browser history even if the client frame is removed
57
- from the page in some situations. It also helps avoid any corner-case differences in how older
58
- browsers handle iframe history</p>
59
- </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>: <a href="../interfaces/messages.NavRequest.html" class="tsd-signature-type tsd-kind-interface">NavRequest</a></span><div class="tsd-comment tsd-typography"><p>a description of where the client wants to navigate the app to.</p>
60
- </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 AbstractClient.requestNavigation</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L369">AbstractClient.ts:369</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> <a href="../interfaces/messages.Notification.html" class="tsd-signature-type tsd-kind-interface">Notification</a><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>
61
- <p>The page embedding the client app is responsible for handling the fired custom event and
62
- presenting/styling the notification. Application-specific concerns such as level, TTLs,
63
- ids for action callbacks (notification click, notification action buttons), etc. can be passed via
64
- the <code>custom</code> property of the <code>notification</code> type.</p>
65
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">notification</span>: <a href="../interfaces/messages.Notification.html" class="tsd-signature-type tsd-kind-interface">Notification</a></span><div class="tsd-comment tsd-typography"><p>the desired notification configuration.</p>
66
- </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-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-4">client</span><span class="hl-2">.</span><span class="hl-5">requestNotification</span><span class="hl-2">({ </span><span class="hl-4">title:</span><span class="hl-2"> </span><span class="hl-3">&#39;Hello world&#39;</span><span class="hl-2"> });</span>
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>Client | 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/client.html">client</a></li>
83
+ <li><a href="" aria-current="page">Client</a></li>
84
+ </ul>
85
+ <h1>Class Client</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-hierarchy" data-refl="152">
88
+ <h4>Hierarchy</h4>
89
+ <ul class="tsd-hierarchy">
90
+ <li class="tsd-hierarchy-item">
91
+ <span class="tsd-signature-type">AbstractClient</span
92
+ ><span class="tsd-signature-symbol">&lt;</span
93
+ ><a
94
+ href="https://developer.mozilla.org/docs/Web/API/Window"
95
+ class="tsd-signature-type external"
96
+ target="_blank"
97
+ >Window</a
98
+ ><span class="tsd-signature-symbol">&gt;</span>
99
+ <ul class="tsd-hierarchy">
100
+ <li class="tsd-hierarchy-item">
101
+ <span class="tsd-hierarchy-target">Client</span>
102
+ </li>
103
+ </ul>
104
+ </li>
105
+ </ul>
106
+ </section>
107
+ <aside class="tsd-sources">
108
+ <ul>
109
+ <li>
110
+ Defined in
111
+ <a
112
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L16"
113
+ >IframeClient.ts:16</a
114
+ >
115
+ </li>
116
+ </ul>
117
+ </aside>
118
+ <section class="tsd-panel-group tsd-index-group">
119
+ <section class="tsd-panel tsd-index-panel">
120
+ <details class="tsd-index-content tsd-accordion" open>
121
+ <summary class="tsd-accordion-summary tsd-index-summary">
122
+ <svg
123
+ width="20"
124
+ height="20"
125
+ viewBox="0 0 24 24"
126
+ fill="none"
127
+ aria-hidden="true"
128
+ >
129
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
130
+ </svg>
131
+ <h5 class="tsd-index-heading uppercase">Index</h5>
132
+ </summary>
133
+ <div class="tsd-accordion-details">
134
+ <section class="tsd-index-section">
135
+ <h3 class="tsd-index-heading">Constructors</h3>
136
+ <div class="tsd-index-list">
137
+ <a href="#constructor" class="tsd-index-link"
138
+ ><svg
139
+ class="tsd-kind-icon"
140
+ viewBox="0 0 24 24"
141
+ aria-label="Constructor"
142
+ >
143
+ <use href="../assets/icons.svg#icon-512"></use></svg
144
+ ><span>constructor</span></a
145
+ >
146
+ </div>
147
+ </section>
148
+ <section class="tsd-index-section">
149
+ <h3 class="tsd-index-heading">Accessors</h3>
150
+ <div class="tsd-index-list">
151
+ <a
152
+ href="#environmentdata"
153
+ class="tsd-index-link tsd-is-inherited"
154
+ ><svg
155
+ class="tsd-kind-icon"
156
+ viewBox="0 0 24 24"
157
+ aria-label="Accessor"
158
+ >
159
+ <use href="../assets/icons.svg#icon-262144"></use></svg
160
+ ><span>environment<wbr />Data</span></a
161
+ >
162
+ <a href="#messaging" class="tsd-index-link tsd-is-inherited"
163
+ ><svg
164
+ class="tsd-kind-icon"
165
+ viewBox="0 0 24 24"
166
+ aria-label="Accessor"
167
+ >
168
+ <use href="../assets/icons.svg#icon-262144"></use></svg
169
+ ><span>messaging</span></a
170
+ >
171
+ </div>
172
+ </section>
173
+ <section class="tsd-index-section">
174
+ <h3 class="tsd-index-heading">Methods</h3>
175
+ <div class="tsd-index-list">
176
+ <a
177
+ href="#addlistener"
178
+ class="tsd-index-link tsd-is-inherited"
179
+ ><svg
180
+ class="tsd-kind-icon"
181
+ viewBox="0 0 24 24"
182
+ aria-label="Method"
183
+ >
184
+ <use href="../assets/icons.svg#icon-2048"></use></svg
185
+ ><span>add<wbr />Listener</span></a
186
+ >
187
+ <a
188
+ href="#ashosturl"
189
+ class="tsd-index-link deprecated tsd-is-inherited"
190
+ ><svg
191
+ class="tsd-kind-icon"
192
+ viewBox="0 0 24 24"
193
+ aria-label="Method"
194
+ >
195
+ <use href="../assets/icons.svg#icon-2048"></use></svg
196
+ ><span>as<wbr />Host<wbr />Url</span></a
197
+ >
198
+ <a
199
+ href="#clearpromptonleave"
200
+ class="tsd-index-link tsd-is-inherited"
201
+ ><svg
202
+ class="tsd-kind-icon"
203
+ viewBox="0 0 24 24"
204
+ aria-label="Method"
205
+ >
206
+ <use href="../assets/icons.svg#icon-2048"></use></svg
207
+ ><span>clear<wbr />Prompt<wbr />On<wbr />Leave</span></a
208
+ >
209
+ <a href="#publish" class="tsd-index-link tsd-is-inherited"
210
+ ><svg
211
+ class="tsd-kind-icon"
212
+ viewBox="0 0 24 24"
213
+ aria-label="Method"
214
+ >
215
+ <use href="../assets/icons.svg#icon-2048"></use></svg
216
+ ><span>publish</span></a
217
+ >
218
+ <a href="#registercustomelements" class="tsd-index-link"
219
+ ><svg
220
+ class="tsd-kind-icon"
221
+ viewBox="0 0 24 24"
222
+ aria-label="Method"
223
+ >
224
+ <use href="../assets/icons.svg#icon-2048"></use></svg
225
+ ><span>register<wbr />Custom<wbr />Elements</span></a
226
+ >
227
+ <a
228
+ href="#removealllisteners"
229
+ class="tsd-index-link tsd-is-inherited"
230
+ ><svg
231
+ class="tsd-kind-icon"
232
+ viewBox="0 0 24 24"
233
+ aria-label="Method"
234
+ >
235
+ <use href="../assets/icons.svg#icon-2048"></use></svg
236
+ ><span>remove<wbr />All<wbr />Listeners</span></a
237
+ >
238
+ <a
239
+ href="#removelistener"
240
+ class="tsd-index-link tsd-is-inherited"
241
+ ><svg
242
+ class="tsd-kind-icon"
243
+ viewBox="0 0 24 24"
244
+ aria-label="Method"
245
+ >
246
+ <use href="../assets/icons.svg#icon-2048"></use></svg
247
+ ><span>remove<wbr />Listener</span></a
248
+ >
249
+ <a
250
+ href="#requestmodal"
251
+ class="tsd-index-link tsd-is-inherited"
252
+ ><svg
253
+ class="tsd-kind-icon"
254
+ viewBox="0 0 24 24"
255
+ aria-label="Method"
256
+ >
257
+ <use href="../assets/icons.svg#icon-2048"></use></svg
258
+ ><span>request<wbr />Modal</span></a
259
+ >
260
+ <a
261
+ href="#requestnavigation"
262
+ class="tsd-index-link tsd-is-inherited"
263
+ ><svg
264
+ class="tsd-kind-icon"
265
+ viewBox="0 0 24 24"
266
+ aria-label="Method"
267
+ >
268
+ <use href="../assets/icons.svg#icon-2048"></use></svg
269
+ ><span>request<wbr />Navigation</span></a
270
+ >
271
+ <a
272
+ href="#requestnotification"
273
+ class="tsd-index-link tsd-is-inherited"
274
+ ><svg
275
+ class="tsd-kind-icon"
276
+ viewBox="0 0 24 24"
277
+ aria-label="Method"
278
+ >
279
+ <use href="../assets/icons.svg#icon-2048"></use></svg
280
+ ><span>request<wbr />Notification</span></a
281
+ >
282
+ <a
283
+ href="#requestpromptonleave"
284
+ class="tsd-index-link tsd-is-inherited"
285
+ ><svg
286
+ class="tsd-kind-icon"
287
+ viewBox="0 0 24 24"
288
+ aria-label="Method"
289
+ >
290
+ <use href="../assets/icons.svg#icon-2048"></use></svg
291
+ ><span>request<wbr />Prompt<wbr />On<wbr />Leave</span></a
292
+ >
293
+ <a
294
+ href="#sendpagemetadata"
295
+ class="tsd-index-link tsd-is-inherited"
296
+ ><svg
297
+ class="tsd-kind-icon"
298
+ viewBox="0 0 24 24"
299
+ aria-label="Method"
300
+ >
301
+ <use href="../assets/icons.svg#icon-2048"></use></svg
302
+ ><span>send<wbr />Page<wbr />Metadata</span></a
303
+ >
304
+ <a href="#start" class="tsd-index-link"
305
+ ><svg
306
+ class="tsd-kind-icon"
307
+ viewBox="0 0 24 24"
308
+ aria-label="Method"
309
+ >
310
+ <use href="../assets/icons.svg#icon-2048"></use></svg
311
+ ><span>start</span></a
312
+ >
313
+ <a href="#startinterceptinglinks" class="tsd-index-link"
314
+ ><svg
315
+ class="tsd-kind-icon"
316
+ viewBox="0 0 24 24"
317
+ aria-label="Method"
318
+ >
319
+ <use href="../assets/icons.svg#icon-2048"></use></svg
320
+ ><span>start<wbr />Intercepting<wbr />Links</span></a
321
+ >
322
+ <a href="#stop" class="tsd-index-link"
323
+ ><svg
324
+ class="tsd-kind-icon"
325
+ viewBox="0 0 24 24"
326
+ aria-label="Method"
327
+ >
328
+ <use href="../assets/icons.svg#icon-2048"></use></svg
329
+ ><span>stop</span></a
330
+ >
331
+ <a href="#stopinterceptinglinks" class="tsd-index-link"
332
+ ><svg
333
+ class="tsd-kind-icon"
334
+ viewBox="0 0 24 24"
335
+ aria-label="Method"
336
+ >
337
+ <use href="../assets/icons.svg#icon-2048"></use></svg
338
+ ><span>stop<wbr />Intercepting<wbr />Links</span></a
339
+ >
340
+ <a
341
+ href="#urlfromclientpath"
342
+ class="tsd-index-link tsd-is-inherited"
343
+ ><svg
344
+ class="tsd-kind-icon"
345
+ viewBox="0 0 24 24"
346
+ aria-label="Method"
347
+ >
348
+ <use href="../assets/icons.svg#icon-2048"></use></svg
349
+ ><span>url<wbr />From<wbr />Client<wbr />Path</span></a
350
+ >
351
+ <a
352
+ href="#urlfromhostpath"
353
+ class="tsd-index-link tsd-is-inherited"
354
+ ><svg
355
+ class="tsd-kind-icon"
356
+ viewBox="0 0 24 24"
357
+ aria-label="Method"
358
+ >
359
+ <use href="../assets/icons.svg#icon-2048"></use></svg
360
+ ><span>url<wbr />From<wbr />Host<wbr />Path</span></a
361
+ >
362
+ </div>
363
+ </section>
364
+ </div>
365
+ </details>
366
+ </section>
367
+ </section>
368
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
369
+ <summary
370
+ class="tsd-accordion-summary"
371
+ data-key="section-Constructors"
372
+ >
373
+ <svg
374
+ width="20"
375
+ height="20"
376
+ viewBox="0 0 24 24"
377
+ fill="none"
378
+ aria-hidden="true"
379
+ >
380
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
381
+ </svg>
382
+ <h2>Constructors</h2>
383
+ </summary>
384
+ <section>
385
+ <section class="tsd-panel tsd-member">
386
+ <h3 class="tsd-anchor-link" id="constructor">
387
+ <span>constructor</span
388
+ ><a
389
+ href="#constructor"
390
+ aria-label="Permalink"
391
+ class="tsd-anchor-icon"
392
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
393
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
394
+ ></a>
395
+ </h3>
396
+ <ul class="tsd-signatures">
397
+ <li class="">
398
+ <div
399
+ class="tsd-signature tsd-anchor-link"
400
+ id="constructorclient"
401
+ >
402
+ <span class="tsd-signature-keyword">new</span>
403
+ <span class="tsd-kind-constructor-signature">Client</span
404
+ ><span class="tsd-signature-symbol">(</span
405
+ ><span class="tsd-kind-parameter">configOptions</span
406
+ ><span class="tsd-signature-symbol">?:</span>
407
+ <a
408
+ href="../interfaces/client.ClientConfigOptions.html"
409
+ class="tsd-signature-type tsd-kind-interface"
410
+ >ClientConfigOptions</a
411
+ ><span class="tsd-signature-symbol">)</span
412
+ ><span class="tsd-signature-symbol">:</span>
413
+ <a href="" class="tsd-signature-type tsd-kind-class"
414
+ >Client</a
415
+ ><a
416
+ href="#constructorclient"
417
+ aria-label="Permalink"
418
+ class="tsd-anchor-icon"
419
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
420
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
421
+ ></a>
422
+ </div>
423
+ <div class="tsd-description">
424
+ <div class="tsd-parameters">
425
+ <h4 class="tsd-parameters-title">Parameters</h4>
426
+ <ul class="tsd-parameter-list">
427
+ <li>
428
+ <span
429
+ ><code class="tsd-tag">Optional</code
430
+ ><span class="tsd-kind-parameter"
431
+ >configOptions</span
432
+ >:
433
+ <a
434
+ href="../interfaces/client.ClientConfigOptions.html"
435
+ class="tsd-signature-type tsd-kind-interface"
436
+ >ClientConfigOptions</a
437
+ ></span
438
+ >
439
+ </li>
440
+ </ul>
441
+ </div>
442
+ <h4 class="tsd-returns-title">
443
+ Returns
444
+ <a href="" class="tsd-signature-type tsd-kind-class"
445
+ >Client</a
446
+ >
447
+ </h4>
448
+ <aside class="tsd-sources">
449
+ <p>Overrides AbstractClient&lt;Window&gt;.constructor</p>
450
+ <ul>
451
+ <li>
452
+ Defined in
453
+ <a
454
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L20"
455
+ >IframeClient.ts:20</a
456
+ >
457
+ </li>
458
+ </ul>
459
+ </aside>
460
+ </div>
461
+ </li>
462
+ </ul>
463
+ </section>
464
+ </section>
465
+ </details>
466
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
467
+ <summary class="tsd-accordion-summary" data-key="section-Accessors">
468
+ <svg
469
+ width="20"
470
+ height="20"
471
+ viewBox="0 0 24 24"
472
+ fill="none"
473
+ aria-hidden="true"
474
+ >
475
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
476
+ </svg>
477
+ <h2>Accessors</h2>
478
+ </summary>
479
+ <section>
480
+ <section class="tsd-panel tsd-member tsd-is-inherited">
481
+ <h3 class="tsd-anchor-link" id="environmentdata">
482
+ <span>environment<wbr />Data</span
483
+ ><a
484
+ href="#environmentdata"
485
+ aria-label="Permalink"
486
+ class="tsd-anchor-icon"
487
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
488
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
489
+ ></a>
490
+ </h3>
491
+ <ul class="tsd-signatures tsd-is-inherited">
492
+ <li>
493
+ <div
494
+ class="tsd-signature"
495
+ id="environmentdataenvironmentdata"
496
+ >
497
+ <span class="tsd-signature-keyword">get</span>
498
+ <span class="tsd-kind-get-signature">environmentData</span
499
+ ><span class="tsd-signature-symbol">()</span
500
+ ><span class="tsd-signature-symbol">:</span>
501
+ <a
502
+ href="../interfaces/messages.EnvData.html"
503
+ class="tsd-signature-type tsd-kind-interface"
504
+ >EnvData</a
505
+ >
506
+ </div>
507
+ <div class="tsd-description">
508
+ <div class="tsd-comment tsd-typography">
509
+ <p>
510
+ Gets the environmental data provided by the host
511
+ application. This includes the locale the client should
512
+ use, the base URL of the host app, and any custom data
513
+ sent by the host.
514
+ </p>
515
+ </div>
516
+ <h4 class="tsd-returns-title">
517
+ Returns
518
+ <a
519
+ href="../interfaces/messages.EnvData.html"
520
+ class="tsd-signature-type tsd-kind-interface"
521
+ >EnvData</a
522
+ >
523
+ </h4>
524
+ <aside class="tsd-sources">
525
+ <p>Inherited from AbstractClient.environmentData</p>
526
+ <ul>
527
+ <li>
528
+ Defined in
529
+ <a
530
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L169"
531
+ >AbstractClient.ts:169</a
532
+ >
533
+ </li>
534
+ </ul>
535
+ </aside>
536
+ </div>
537
+ </li>
538
+ </ul>
539
+ </section>
540
+ <section class="tsd-panel tsd-member tsd-is-inherited">
541
+ <h3 class="tsd-anchor-link" id="messaging">
542
+ <span>messaging</span
543
+ ><a
544
+ href="#messaging"
545
+ aria-label="Permalink"
546
+ class="tsd-anchor-icon"
547
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
548
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
549
+ ></a>
550
+ </h3>
551
+ <ul class="tsd-signatures tsd-is-inherited">
552
+ <li>
553
+ <div class="tsd-signature" id="messagingmessaging">
554
+ <span class="tsd-signature-keyword">get</span>
555
+ <span class="tsd-kind-get-signature">messaging</span
556
+ ><span class="tsd-signature-symbol">()</span
557
+ ><span class="tsd-signature-symbol">:</span>
558
+ <a
559
+ href="../interfaces/client.EventEmitter.html"
560
+ class="tsd-signature-type tsd-kind-interface"
561
+ >EventEmitter</a
562
+ ><span class="tsd-signature-symbol">&lt;</span
563
+ ><a
564
+ href="../interfaces/messages.Publication.html"
565
+ class="tsd-signature-type tsd-kind-interface"
566
+ >Publication</a
567
+ ><span class="tsd-signature-symbol">&gt;</span>
568
+ </div>
569
+ <div class="tsd-description">
570
+ <div class="tsd-comment tsd-typography">
571
+ <p>
572
+ Accessor for the general-purpose pub-sub bus between
573
+ client and host applications. The content of messages on
574
+ this bus are not defined by this API beyond a basic data
575
+ wrapper of topic and payload. This is for
576
+ application-specific messages agreed upon as a shared
577
+ API between host and client.
578
+ </p>
579
+ </div>
580
+ <h4 class="tsd-returns-title">
581
+ Returns
582
+ <a
583
+ href="../interfaces/client.EventEmitter.html"
584
+ class="tsd-signature-type tsd-kind-interface"
585
+ >EventEmitter</a
586
+ ><span class="tsd-signature-symbol">&lt;</span
587
+ ><a
588
+ href="../interfaces/messages.Publication.html"
589
+ class="tsd-signature-type tsd-kind-interface"
590
+ >Publication</a
591
+ ><span class="tsd-signature-symbol">&gt;</span>
592
+ </h4>
593
+ <aside class="tsd-sources">
594
+ <p>Inherited from AbstractClient.messaging</p>
595
+ <ul>
596
+ <li>
597
+ Defined in
598
+ <a
599
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L269"
600
+ >AbstractClient.ts:269</a
601
+ >
602
+ </li>
603
+ </ul>
604
+ </aside>
605
+ </div>
606
+ </li>
607
+ </ul>
608
+ </section>
609
+ </section>
610
+ </details>
611
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
612
+ <summary class="tsd-accordion-summary" data-key="section-Methods">
613
+ <svg
614
+ width="20"
615
+ height="20"
616
+ viewBox="0 0 24 24"
617
+ fill="none"
618
+ aria-hidden="true"
619
+ >
620
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
621
+ </svg>
622
+ <h2>Methods</h2>
623
+ </summary>
624
+ <section>
625
+ <section class="tsd-panel tsd-member tsd-is-inherited">
626
+ <h3 class="tsd-anchor-link" id="addlistener">
627
+ <span>add<wbr />Listener</span
628
+ ><a
629
+ href="#addlistener"
630
+ aria-label="Permalink"
631
+ class="tsd-anchor-icon"
632
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
633
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
634
+ ></a>
635
+ </h3>
636
+ <ul class="tsd-signatures tsd-is-inherited">
637
+ <li class="tsd-is-inherited">
638
+ <div class="tsd-signature tsd-anchor-link" id="addlistener-1">
639
+ <span class="tsd-kind-call-signature">addListener</span
640
+ ><span class="tsd-signature-symbol">(</span
641
+ ><span class="tsd-kind-parameter">type</span
642
+ ><span class="tsd-signature-symbol">:</span>
643
+ <span class="tsd-signature-type"
644
+ >&quot;environmentalData&quot;</span
645
+ ><span class="tsd-signature-symbol">,</span>
646
+ <span class="tsd-kind-parameter">listener</span
647
+ ><span class="tsd-signature-symbol">:</span>
648
+ <a
649
+ href="../types/client.EnvDataHandler.html"
650
+ class="tsd-signature-type tsd-kind-type-alias"
651
+ >EnvDataHandler</a
652
+ ><span class="tsd-signature-symbol">)</span
653
+ ><span class="tsd-signature-symbol">:</span>
654
+ <span class="tsd-signature-type">this</span
655
+ ><a
656
+ href="#addlistener-1"
657
+ aria-label="Permalink"
658
+ class="tsd-anchor-icon"
659
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
660
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
661
+ ></a>
662
+ </div>
663
+ <div class="tsd-description">
664
+ <div class="tsd-comment tsd-typography">
665
+ <p>
666
+ Sets up a function that will be called whenever the
667
+ specified event type is delivered to the target. This
668
+ should not be confused with the general-purpose pub-sub
669
+ listeners that can be set via the
670
+ <a href="#messaging" class="tsd-kind-accessor"
671
+ >messaging</a
672
+ >
673
+ interface. Handlers should be set before calling
674
+ <a href="#start" class="tsd-kind-method">start</a>,
675
+ otherwise there is a risk of missing messages between
676
+ when the host begins delivering data and the listener is
677
+ added.
678
+ </p>
679
+ </div>
680
+ <div class="tsd-parameters">
681
+ <h4 class="tsd-parameters-title">Parameters</h4>
682
+ <ul class="tsd-parameter-list">
683
+ <li>
684
+ <span
685
+ ><span class="tsd-kind-parameter">type</span>:
686
+ <span class="tsd-signature-type"
687
+ >&quot;environmentalData&quot;</span
688
+ ></span
689
+ >
690
+ <div class="tsd-comment tsd-typography">
691
+ <p>
692
+ A case-sensitive string representing the event
693
+ type to listen for. Currently, hosts only send
694
+ <code>environmentalData</code> events.
695
+ </p>
696
+ </div>
697
+ </li>
698
+ <li>
699
+ <span
700
+ ><span class="tsd-kind-parameter">listener</span>:
701
+ <a
702
+ href="../types/client.EnvDataHandler.html"
703
+ class="tsd-signature-type tsd-kind-type-alias"
704
+ >EnvDataHandler</a
705
+ ></span
706
+ >
707
+ <div class="tsd-comment tsd-typography">
708
+ <p>
709
+ The handler which receives a notification when an
710
+ event of the specified type occurs.
711
+ </p>
712
+ </div>
713
+ </li>
714
+ </ul>
715
+ </div>
716
+ <h4 class="tsd-returns-title">
717
+ Returns <span class="tsd-signature-type">this</span>
718
+ </h4>
719
+ <aside class="tsd-sources">
720
+ <p>Inherited from AbstractClient.addListener</p>
721
+ <ul>
722
+ <li>
723
+ Defined in
724
+ <a
725
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L67"
726
+ >AbstractClient.ts:67</a
727
+ >
728
+ </li>
729
+ </ul>
730
+ </aside>
731
+ </div>
732
+ </li>
733
+ </ul>
734
+ </section>
735
+ <section class="tsd-panel tsd-member tsd-is-inherited">
736
+ <h3 class="tsd-anchor-link" id="ashosturl">
737
+ <span class="deprecated">as<wbr />Host<wbr />Url</span
738
+ ><a
739
+ href="#ashosturl"
740
+ aria-label="Permalink"
741
+ class="tsd-anchor-icon"
742
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
743
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
744
+ ></a>
745
+ </h3>
746
+ <ul class="tsd-signatures tsd-is-inherited">
747
+ <li class="tsd-is-inherited">
748
+ <div class="tsd-signature tsd-anchor-link" id="ashosturl-1">
749
+ <span class="tsd-kind-call-signature">asHostUrl</span
750
+ ><span class="tsd-signature-symbol">(</span
751
+ ><span class="tsd-kind-parameter">clientRouteLegacy</span
752
+ ><span class="tsd-signature-symbol">:</span>
753
+ <span class="tsd-signature-type">string</span
754
+ ><span class="tsd-signature-symbol">)</span
755
+ ><span class="tsd-signature-symbol">:</span>
756
+ <span class="tsd-signature-type">string</span
757
+ ><a
758
+ href="#ashosturl-1"
759
+ aria-label="Permalink"
760
+ class="tsd-anchor-icon"
761
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
762
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
763
+ ></a>
764
+ </div>
765
+ <div class="tsd-description">
766
+ <div class="tsd-comment tsd-typography">
767
+ <p>
768
+ Translates a client route like <code>/foo/bar</code> to
769
+ the full URL used in the host app for the same page,
770
+ e.g.
771
+ <code>https://hostapp.com/#/client-app/foo/bar</code>.
772
+ </p>
773
+ </div>
774
+ <div class="tsd-parameters">
775
+ <h4 class="tsd-parameters-title">Parameters</h4>
776
+ <ul class="tsd-parameter-list">
777
+ <li>
778
+ <span
779
+ ><span class="tsd-kind-parameter"
780
+ >clientRouteLegacy</span
781
+ >:
782
+ <span class="tsd-signature-type">string</span></span
783
+ >
784
+ <div class="tsd-comment tsd-typography">
785
+ <p>
786
+ The /-separated path within the client app to link
787
+ to.
788
+ </p>
789
+ </div>
790
+ </li>
791
+ </ul>
792
+ </div>
793
+ <h4 class="tsd-returns-title">
794
+ Returns <span class="tsd-signature-type">string</span>
795
+ </h4>
796
+ <div class="tsd-comment tsd-typography">
797
+ <div class="tsd-tag-deprecated">
798
+ <h4 class="tsd-anchor-link" id="deprecated">
799
+ Deprecated<a
800
+ href="#deprecated"
801
+ aria-label="Permalink"
802
+ class="tsd-anchor-icon"
803
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
804
+ <use
805
+ href="../assets/icons.svg#icon-anchor"
806
+ ></use></svg
807
+ ></a>
808
+ </h4>
809
+ <p>
810
+ Use the new
811
+ <a href="#urlfromclientpath" class="tsd-kind-method"
812
+ >urlFromClientPath</a
813
+ >
814
+ method instead
815
+ </p>
816
+ </div>
817
+ </div>
818
+ <aside class="tsd-sources">
819
+ <p>Inherited from AbstractClient.asHostUrl</p>
820
+ <ul>
821
+ <li>
822
+ Defined in
823
+ <a
824
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L212"
825
+ >AbstractClient.ts:212</a
826
+ >
827
+ </li>
828
+ </ul>
829
+ </aside>
830
+ </div>
831
+ </li>
832
+ </ul>
833
+ </section>
834
+ <section class="tsd-panel tsd-member tsd-is-inherited">
835
+ <h3 class="tsd-anchor-link" id="clearpromptonleave">
836
+ <span>clear<wbr />Prompt<wbr />On<wbr />Leave</span
837
+ ><a
838
+ href="#clearpromptonleave"
839
+ aria-label="Permalink"
840
+ class="tsd-anchor-icon"
841
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
842
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
843
+ ></a>
844
+ </h3>
845
+ <ul class="tsd-signatures tsd-is-inherited">
846
+ <li class="tsd-is-inherited">
847
+ <div
848
+ class="tsd-signature tsd-anchor-link"
849
+ id="clearpromptonleave-1"
850
+ >
851
+ <span class="tsd-kind-call-signature"
852
+ >clearPromptOnLeave</span
853
+ ><span class="tsd-signature-symbol">()</span
854
+ ><span class="tsd-signature-symbol">:</span>
855
+ <span class="tsd-signature-type">void</span
856
+ ><a
857
+ href="#clearpromptonleave-1"
858
+ aria-label="Permalink"
859
+ class="tsd-anchor-icon"
860
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
861
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
862
+ ></a>
863
+ </div>
864
+ <div class="tsd-description">
865
+ <div class="tsd-comment tsd-typography">
866
+ <p>
867
+ Asks the host application to clear the prompt on leave
868
+ dialog.
869
+ </p>
870
+ </div>
871
+ <h4 class="tsd-returns-title">
872
+ Returns <span class="tsd-signature-type">void</span>
873
+ </h4>
874
+ <aside class="tsd-sources">
875
+ <p>Inherited from AbstractClient.clearPromptOnLeave</p>
876
+ <ul>
877
+ <li>
878
+ Defined in
879
+ <a
880
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L387"
881
+ >AbstractClient.ts:387</a
882
+ >
883
+ </li>
884
+ </ul>
885
+ </aside>
886
+ </div>
887
+ </li>
888
+ </ul>
889
+ </section>
890
+ <section class="tsd-panel tsd-member tsd-is-inherited">
891
+ <h3 class="tsd-anchor-link" id="publish">
892
+ <span>publish</span
893
+ ><a
894
+ href="#publish"
895
+ aria-label="Permalink"
896
+ class="tsd-anchor-icon"
897
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
898
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
899
+ ></a>
900
+ </h3>
901
+ <ul class="tsd-signatures tsd-is-inherited">
902
+ <li class="tsd-is-inherited">
903
+ <div class="tsd-signature tsd-anchor-link" id="publish-1">
904
+ <span class="tsd-kind-call-signature">publish</span
905
+ ><span class="tsd-signature-symbol">(</span
906
+ ><span class="tsd-kind-parameter">publication</span
907
+ ><span class="tsd-signature-symbol">:</span>
908
+ <a
909
+ href="../interfaces/messages.Publication.html"
910
+ class="tsd-signature-type tsd-kind-interface"
911
+ >Publication</a
912
+ ><span class="tsd-signature-symbol">)</span
913
+ ><span class="tsd-signature-symbol">:</span>
914
+ <span class="tsd-signature-type">void</span
915
+ ><a
916
+ href="#publish-1"
917
+ aria-label="Permalink"
918
+ class="tsd-anchor-icon"
919
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
920
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
921
+ ></a>
922
+ </div>
923
+ <div class="tsd-description">
924
+ <div class="tsd-comment tsd-typography">
925
+ <p>Publish a general message to the host application.</p>
926
+ </div>
927
+ <div class="tsd-parameters">
928
+ <h4 class="tsd-parameters-title">Parameters</h4>
929
+ <ul class="tsd-parameter-list">
930
+ <li>
931
+ <span
932
+ ><span class="tsd-kind-parameter">publication</span
933
+ >:
934
+ <a
935
+ href="../interfaces/messages.Publication.html"
936
+ class="tsd-signature-type tsd-kind-interface"
937
+ >Publication</a
938
+ ></span
939
+ >
940
+ <div class="tsd-comment tsd-typography">
941
+ <p>The data object to be published.</p>
942
+ </div>
943
+ </li>
944
+ </ul>
945
+ </div>
946
+ <h4 class="tsd-returns-title">
947
+ Returns <span class="tsd-signature-type">void</span>
948
+ </h4>
949
+ <aside class="tsd-sources">
950
+ <p>Inherited from AbstractClient.publish</p>
951
+ <ul>
952
+ <li>
953
+ Defined in
954
+ <a
955
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L291"
956
+ >AbstractClient.ts:291</a
957
+ >
958
+ </li>
959
+ </ul>
960
+ </aside>
961
+ </div>
962
+ </li>
963
+ </ul>
964
+ </section>
965
+ <section class="tsd-panel tsd-member">
966
+ <h3 class="tsd-anchor-link" id="registercustomelements">
967
+ <span>register<wbr />Custom<wbr />Elements</span
968
+ ><a
969
+ href="#registercustomelements"
970
+ aria-label="Permalink"
971
+ class="tsd-anchor-icon"
972
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
973
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
974
+ ></a>
975
+ </h3>
976
+ <ul class="tsd-signatures">
977
+ <li class="">
978
+ <div
979
+ class="tsd-signature tsd-anchor-link"
980
+ id="registercustomelements-1"
981
+ >
982
+ <span class="tsd-kind-call-signature"
983
+ >registerCustomElements</span
984
+ ><span class="tsd-signature-symbol">()</span
985
+ ><span class="tsd-signature-symbol">:</span>
986
+ <span class="tsd-signature-type">void</span
987
+ ><a
988
+ href="#registercustomelements-1"
989
+ aria-label="Permalink"
990
+ class="tsd-anchor-icon"
991
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
992
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
993
+ ></a>
994
+ </div>
995
+ <div class="tsd-description">
996
+ <div class="tsd-comment tsd-typography">
997
+ <p>
998
+ Registers custom elements used by the client application
999
+ </p>
1000
+ </div>
1001
+ <h4 class="tsd-returns-title">
1002
+ Returns <span class="tsd-signature-type">void</span>
1003
+ </h4>
1004
+ <aside class="tsd-sources">
1005
+ <ul>
1006
+ <li>
1007
+ Defined in
1008
+ <a
1009
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L46"
1010
+ >IframeClient.ts:46</a
1011
+ >
1012
+ </li>
1013
+ </ul>
1014
+ </aside>
1015
+ </div>
1016
+ </li>
1017
+ </ul>
1018
+ </section>
1019
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1020
+ <h3 class="tsd-anchor-link" id="removealllisteners">
1021
+ <span>remove<wbr />All<wbr />Listeners</span
1022
+ ><a
1023
+ href="#removealllisteners"
1024
+ aria-label="Permalink"
1025
+ class="tsd-anchor-icon"
1026
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1027
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1028
+ ></a>
1029
+ </h3>
1030
+ <ul class="tsd-signatures tsd-is-inherited">
1031
+ <li class="tsd-is-inherited">
1032
+ <div
1033
+ class="tsd-signature tsd-anchor-link"
1034
+ id="removealllisteners-1"
1035
+ >
1036
+ <span class="tsd-kind-call-signature"
1037
+ >removeAllListeners</span
1038
+ ><span class="tsd-signature-symbol">(</span
1039
+ ><span class="tsd-kind-parameter">type</span
1040
+ ><span class="tsd-signature-symbol">:</span>
1041
+ <span class="tsd-signature-type"
1042
+ >&quot;environmentalData&quot;</span
1043
+ ><span class="tsd-signature-symbol">)</span
1044
+ ><span class="tsd-signature-symbol">:</span>
1045
+ <span class="tsd-signature-type">this</span
1046
+ ><a
1047
+ href="#removealllisteners-1"
1048
+ aria-label="Permalink"
1049
+ class="tsd-anchor-icon"
1050
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1051
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1052
+ ></a>
1053
+ </div>
1054
+ <div class="tsd-description">
1055
+ <div class="tsd-comment tsd-typography">
1056
+ <p>
1057
+ Removes all event listeners previously registered with
1058
+ <a href="#addlistener" class="tsd-kind-method"
1059
+ >addListener</a
1060
+ >.
1061
+ </p>
1062
+ </div>
1063
+ <div class="tsd-parameters">
1064
+ <h4 class="tsd-parameters-title">Parameters</h4>
1065
+ <ul class="tsd-parameter-list">
1066
+ <li>
1067
+ <span
1068
+ ><span class="tsd-kind-parameter">type</span>:
1069
+ <span class="tsd-signature-type"
1070
+ >&quot;environmentalData&quot;</span
1071
+ ></span
1072
+ >
1073
+ <div class="tsd-comment tsd-typography">
1074
+ <p>
1075
+ A string which specifies the type of event for
1076
+ which to remove an event listener.
1077
+ </p>
1078
+ </div>
1079
+ </li>
1080
+ </ul>
1081
+ </div>
1082
+ <h4 class="tsd-returns-title">
1083
+ Returns <span class="tsd-signature-type">this</span>
1084
+ </h4>
1085
+ <aside class="tsd-sources">
1086
+ <p>Inherited from AbstractClient.removeAllListeners</p>
1087
+ <ul>
1088
+ <li>
1089
+ Defined in
1090
+ <a
1091
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L92"
1092
+ >AbstractClient.ts:92</a
1093
+ >
1094
+ </li>
1095
+ </ul>
1096
+ </aside>
1097
+ </div>
1098
+ </li>
1099
+ </ul>
1100
+ </section>
1101
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1102
+ <h3 class="tsd-anchor-link" id="removelistener">
1103
+ <span>remove<wbr />Listener</span
1104
+ ><a
1105
+ href="#removelistener"
1106
+ aria-label="Permalink"
1107
+ class="tsd-anchor-icon"
1108
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1109
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1110
+ ></a>
1111
+ </h3>
1112
+ <ul class="tsd-signatures tsd-is-inherited">
1113
+ <li class="tsd-is-inherited">
1114
+ <div
1115
+ class="tsd-signature tsd-anchor-link"
1116
+ id="removelistener-1"
1117
+ >
1118
+ <span class="tsd-kind-call-signature">removeListener</span
1119
+ ><span class="tsd-signature-symbol">(</span
1120
+ ><span class="tsd-kind-parameter">type</span
1121
+ ><span class="tsd-signature-symbol">:</span>
1122
+ <span class="tsd-signature-type"
1123
+ >&quot;environmentalData&quot;</span
1124
+ ><span class="tsd-signature-symbol">,</span>
1125
+ <span class="tsd-kind-parameter">listener</span
1126
+ ><span class="tsd-signature-symbol">:</span>
1127
+ <a
1128
+ href="../types/client.EnvDataHandler.html"
1129
+ class="tsd-signature-type tsd-kind-type-alias"
1130
+ >EnvDataHandler</a
1131
+ ><span class="tsd-signature-symbol">)</span
1132
+ ><span class="tsd-signature-symbol">:</span>
1133
+ <span class="tsd-signature-type">this</span
1134
+ ><a
1135
+ href="#removelistener-1"
1136
+ aria-label="Permalink"
1137
+ class="tsd-anchor-icon"
1138
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1139
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1140
+ ></a>
1141
+ </div>
1142
+ <div class="tsd-description">
1143
+ <div class="tsd-comment tsd-typography">
1144
+ <p>
1145
+ Removes an event listener previously registered with
1146
+ <a href="#addlistener" class="tsd-kind-method"
1147
+ >addListener</a
1148
+ >.
1149
+ </p>
1150
+ </div>
1151
+ <div class="tsd-parameters">
1152
+ <h4 class="tsd-parameters-title">Parameters</h4>
1153
+ <ul class="tsd-parameter-list">
1154
+ <li>
1155
+ <span
1156
+ ><span class="tsd-kind-parameter">type</span>:
1157
+ <span class="tsd-signature-type"
1158
+ >&quot;environmentalData&quot;</span
1159
+ ></span
1160
+ >
1161
+ <div class="tsd-comment tsd-typography">
1162
+ <p>
1163
+ A string which specifies the type of event for
1164
+ which to remove an event listener.
1165
+ </p>
1166
+ </div>
1167
+ </li>
1168
+ <li>
1169
+ <span
1170
+ ><span class="tsd-kind-parameter">listener</span>:
1171
+ <a
1172
+ href="../types/client.EnvDataHandler.html"
1173
+ class="tsd-signature-type tsd-kind-type-alias"
1174
+ >EnvDataHandler</a
1175
+ ></span
1176
+ >
1177
+ <div class="tsd-comment tsd-typography">
1178
+ <p>
1179
+ The event handler to remove from the event target.
1180
+ </p>
1181
+ </div>
1182
+ </li>
1183
+ </ul>
1184
+ </div>
1185
+ <h4 class="tsd-returns-title">
1186
+ Returns <span class="tsd-signature-type">this</span>
1187
+ </h4>
1188
+ <aside class="tsd-sources">
1189
+ <p>Inherited from AbstractClient.removeListener</p>
1190
+ <ul>
1191
+ <li>
1192
+ Defined in
1193
+ <a
1194
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L80"
1195
+ >AbstractClient.ts:80</a
1196
+ >
1197
+ </li>
1198
+ </ul>
1199
+ </aside>
1200
+ </div>
1201
+ </li>
1202
+ </ul>
1203
+ </section>
1204
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1205
+ <h3 class="tsd-anchor-link" id="requestmodal">
1206
+ <span>request<wbr />Modal</span
1207
+ ><a
1208
+ href="#requestmodal"
1209
+ aria-label="Permalink"
1210
+ class="tsd-anchor-icon"
1211
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1212
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1213
+ ></a>
1214
+ </h3>
1215
+ <ul class="tsd-signatures tsd-is-inherited">
1216
+ <li class="tsd-is-inherited">
1217
+ <div
1218
+ class="tsd-signature tsd-anchor-link"
1219
+ id="requestmodal-1"
1220
+ >
1221
+ <span class="tsd-kind-call-signature">requestModal</span
1222
+ ><span class="tsd-signature-symbol">(</span
1223
+ ><span class="tsd-kind-parameter">modalRequest</span
1224
+ ><span class="tsd-signature-symbol">:</span>
1225
+ <a
1226
+ href="../interfaces/messages.ModalRequest.html"
1227
+ class="tsd-signature-type tsd-kind-interface"
1228
+ >ModalRequest</a
1229
+ ><span class="tsd-signature-symbol">)</span
1230
+ ><span class="tsd-signature-symbol">:</span>
1231
+ <span class="tsd-signature-type">void</span
1232
+ ><a
1233
+ href="#requestmodal-1"
1234
+ aria-label="Permalink"
1235
+ class="tsd-anchor-icon"
1236
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1237
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1238
+ ></a>
1239
+ </div>
1240
+ <div class="tsd-description">
1241
+ <div class="tsd-comment tsd-typography">
1242
+ <p>Asks the host application to open a modal dialog.</p>
1243
+ <p>
1244
+ The modalId property names the modal that should be
1245
+ displayed Data passed via the modalData property can be
1246
+ used by the host application to set up initial state
1247
+ specific to that modal
1248
+ </p>
1249
+ </div>
1250
+ <div class="tsd-parameters">
1251
+ <h4 class="tsd-parameters-title">Parameters</h4>
1252
+ <ul class="tsd-parameter-list">
1253
+ <li>
1254
+ <span
1255
+ ><span class="tsd-kind-parameter">modalRequest</span
1256
+ >:
1257
+ <a
1258
+ href="../interfaces/messages.ModalRequest.html"
1259
+ class="tsd-signature-type tsd-kind-interface"
1260
+ >ModalRequest</a
1261
+ ></span
1262
+ >
1263
+ <div class="tsd-comment tsd-typography">
1264
+ <p>
1265
+ the ID and any data specific to the modal instance
1266
+ required
1267
+ </p>
1268
+ </div>
1269
+ </li>
1270
+ </ul>
1271
+ </div>
1272
+ <h4 class="tsd-returns-title">
1273
+ Returns <span class="tsd-signature-type">void</span>
1274
+ </h4>
1275
+ <aside class="tsd-sources">
1276
+ <p>Inherited from AbstractClient.requestModal</p>
1277
+ <ul>
1278
+ <li>
1279
+ Defined in
1280
+ <a
1281
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L307"
1282
+ >AbstractClient.ts:307</a
1283
+ >
1284
+ </li>
1285
+ </ul>
1286
+ </aside>
1287
+ </div>
1288
+ </li>
1289
+ </ul>
1290
+ </section>
1291
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1292
+ <h3 class="tsd-anchor-link" id="requestnavigation">
1293
+ <span>request<wbr />Navigation</span
1294
+ ><a
1295
+ href="#requestnavigation"
1296
+ aria-label="Permalink"
1297
+ class="tsd-anchor-icon"
1298
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1299
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1300
+ ></a>
1301
+ </h3>
1302
+ <ul class="tsd-signatures tsd-is-inherited">
1303
+ <li class="tsd-is-inherited">
1304
+ <div
1305
+ class="tsd-signature tsd-anchor-link"
1306
+ id="requestnavigation-1"
1307
+ >
1308
+ <span class="tsd-kind-call-signature"
1309
+ >requestNavigation</span
1310
+ ><span class="tsd-signature-symbol">(</span
1311
+ ><span class="tsd-kind-parameter">destination</span
1312
+ ><span class="tsd-signature-symbol">:</span>
1313
+ <a
1314
+ href="../interfaces/messages.NavRequest.html"
1315
+ class="tsd-signature-type tsd-kind-interface"
1316
+ >NavRequest</a
1317
+ ><span class="tsd-signature-symbol">)</span
1318
+ ><span class="tsd-signature-symbol">:</span>
1319
+ <span class="tsd-signature-type">void</span
1320
+ ><a
1321
+ href="#requestnavigation-1"
1322
+ aria-label="Permalink"
1323
+ class="tsd-anchor-icon"
1324
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1325
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1326
+ ></a>
1327
+ </div>
1328
+ <div class="tsd-description">
1329
+ <div class="tsd-comment tsd-typography">
1330
+ <p>
1331
+ Asks the host application to navigate to a new location.
1332
+ </p>
1333
+ <p>
1334
+ By requesting navigation from the host app instead of
1335
+ navigating directly in the client frame, a host-client
1336
+ pair can maintain a consistent browser history even if
1337
+ the client frame is removed from the page in some
1338
+ situations. It also helps avoid any corner-case
1339
+ differences in how older browsers handle iframe history
1340
+ </p>
1341
+ </div>
1342
+ <div class="tsd-parameters">
1343
+ <h4 class="tsd-parameters-title">Parameters</h4>
1344
+ <ul class="tsd-parameter-list">
1345
+ <li>
1346
+ <span
1347
+ ><span class="tsd-kind-parameter">destination</span
1348
+ >:
1349
+ <a
1350
+ href="../interfaces/messages.NavRequest.html"
1351
+ class="tsd-signature-type tsd-kind-interface"
1352
+ >NavRequest</a
1353
+ ></span
1354
+ >
1355
+ <div class="tsd-comment tsd-typography">
1356
+ <p>
1357
+ a description of where the client wants to
1358
+ navigate the app to.
1359
+ </p>
1360
+ </div>
1361
+ </li>
1362
+ </ul>
1363
+ </div>
1364
+ <h4 class="tsd-returns-title">
1365
+ Returns <span class="tsd-signature-type">void</span>
1366
+ </h4>
1367
+ <aside class="tsd-sources">
1368
+ <p>Inherited from AbstractClient.requestNavigation</p>
1369
+ <ul>
1370
+ <li>
1371
+ Defined in
1372
+ <a
1373
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L367"
1374
+ >AbstractClient.ts:367</a
1375
+ >
1376
+ </li>
1377
+ </ul>
1378
+ </aside>
1379
+ </div>
1380
+ </li>
1381
+ </ul>
1382
+ </section>
1383
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1384
+ <h3 class="tsd-anchor-link" id="requestnotification">
1385
+ <span>request<wbr />Notification</span
1386
+ ><a
1387
+ href="#requestnotification"
1388
+ aria-label="Permalink"
1389
+ class="tsd-anchor-icon"
1390
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1391
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1392
+ ></a>
1393
+ </h3>
1394
+ <ul class="tsd-signatures tsd-is-inherited">
1395
+ <li class="tsd-is-inherited">
1396
+ <div
1397
+ class="tsd-signature tsd-anchor-link"
1398
+ id="requestnotification-1"
1399
+ >
1400
+ <span class="tsd-kind-call-signature"
1401
+ >requestNotification</span
1402
+ ><span class="tsd-signature-symbol">(</span
1403
+ ><span class="tsd-kind-parameter">notification</span
1404
+ ><span class="tsd-signature-symbol">:</span>
1405
+ <a
1406
+ href="../interfaces/messages.Notification.html"
1407
+ class="tsd-signature-type tsd-kind-interface"
1408
+ >Notification</a
1409
+ ><span class="tsd-signature-symbol">)</span
1410
+ ><span class="tsd-signature-symbol">:</span>
1411
+ <span class="tsd-signature-type">void</span
1412
+ ><a
1413
+ href="#requestnotification-1"
1414
+ aria-label="Permalink"
1415
+ class="tsd-anchor-icon"
1416
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1417
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1418
+ ></a>
1419
+ </div>
1420
+ <div class="tsd-description">
1421
+ <div class="tsd-comment tsd-typography">
1422
+ <p>
1423
+ Asks the host application to display a user
1424
+ notification.
1425
+ </p>
1426
+ <p>
1427
+ The page embedding the client app is responsible for
1428
+ handling the fired custom event and presenting/styling
1429
+ the notification. Application-specific concerns such as
1430
+ level, TTLs, ids for action callbacks (notification
1431
+ click, notification action buttons), etc. can be passed
1432
+ via the <code>custom</code> property of the
1433
+ <code>notification</code> type.
1434
+ </p>
1435
+ </div>
1436
+ <div class="tsd-parameters">
1437
+ <h4 class="tsd-parameters-title">Parameters</h4>
1438
+ <ul class="tsd-parameter-list">
1439
+ <li>
1440
+ <span
1441
+ ><span class="tsd-kind-parameter">notification</span
1442
+ >:
1443
+ <a
1444
+ href="../interfaces/messages.Notification.html"
1445
+ class="tsd-signature-type tsd-kind-interface"
1446
+ >Notification</a
1447
+ ></span
1448
+ >
1449
+ <div class="tsd-comment tsd-typography">
1450
+ <p>the desired notification configuration.</p>
1451
+ </div>
1452
+ </li>
1453
+ </ul>
1454
+ </div>
1455
+ <h4 class="tsd-returns-title">
1456
+ Returns <span class="tsd-signature-type">void</span>
1457
+ </h4>
1458
+ <div class="tsd-comment tsd-typography">
1459
+ <div class="tsd-tag-example">
1460
+ <h4 class="tsd-anchor-link" id="example">
1461
+ Example<a
1462
+ href="#example"
1463
+ aria-label="Permalink"
1464
+ class="tsd-anchor-icon"
1465
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1466
+ <use
1467
+ href="../assets/icons.svg#icon-anchor"
1468
+ ></use></svg
1469
+ ></a>
1470
+ </h4>
1471
+ <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><span class="hl-4">title:</span><span class="hl-2"> </span><span class="hl-3">&#39;Hello world&#39;</span><span class="hl-2"> });</span>
67
1472
  </code><button type="button">Copy</button></pre>
68
-
69
- </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><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">&#39;Hello&#39;</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">&#39;World&#39;</span><br/><span class="hl-2">});</span>
1473
+ </div>
1474
+ <div class="tsd-tag-example">
1475
+ <h4 class="tsd-anchor-link" id="example-1">
1476
+ Example<a
1477
+ href="#example-1"
1478
+ aria-label="Permalink"
1479
+ class="tsd-anchor-icon"
1480
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1481
+ <use
1482
+ href="../assets/icons.svg#icon-anchor"
1483
+ ></use></svg
1484
+ ></a>
1485
+ </h4>
1486
+ <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">&#39;Hello&#39;</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">&#39;World&#39;</span><br/><span class="hl-2">});</span>
70
1487
  </code><button type="button">Copy</button></pre>
71
-
72
- </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">&#39;Hello&#39;</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">&#39;World&#39;</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">&#39;info&#39;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">});</span>
1488
+ </div>
1489
+ <div class="tsd-tag-example">
1490
+ <h4 class="tsd-anchor-link" id="example-2">
1491
+ Example<a
1492
+ href="#example-2"
1493
+ aria-label="Permalink"
1494
+ class="tsd-anchor-icon"
1495
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1496
+ <use
1497
+ href="../assets/icons.svg#icon-anchor"
1498
+ ></use></svg
1499
+ ></a>
1500
+ </h4>
1501
+ <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">&#39;Hello&#39;</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">&#39;World&#39;</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">&#39;info&#39;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">});</span>
73
1502
  </code><button type="button">Copy</button></pre>
74
-
75
- </div></div><aside class="tsd-sources"><p>Inherited from AbstractClient.requestNotification</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L351">AbstractClient.ts:351</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>
76
- </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 AbstractClient.requestPromptOnLeave</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L379">AbstractClient.ts:379</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> <a href="../interfaces/messages.PageMetadata.html" class="tsd-signature-type tsd-kind-interface">PageMetadata</a><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>
77
- <p>title property is for the page title in the browser
78
- breadcrumbs is an array of breadcrumb data for display in host application
79
- custom is any custom data wanting to be sent by client app</p>
80
- </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>: <a href="../interfaces/messages.PageMetadata.html" class="tsd-signature-type tsd-kind-interface">PageMetadata</a></span><div class="tsd-comment tsd-typography"><p>data that will be used for display in host application and browser page title</p>
81
- </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 AbstractClient.sendPageMetadata</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L405">AbstractClient.ts:405</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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"><li class=""><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>
82
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides AbstractClient.start</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L30">IframeClient.ts:30</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startinterceptinglinks"><span>start<wbr/>Intercepting<wbr/>Links</span><a href="#startinterceptinglinks" 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="startinterceptinglinks-1"><span class="tsd-kind-call-signature">startInterceptingLinks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#startinterceptinglinks-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>Allows the click handler on the client window to intercept clicks on anchor elements
83
- and makes a nav request to the host based on the element's href. This should be
84
- avoided for complex applications as it can interfere with things like download
85
- links that you may not want to intercept.</p>
86
- </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/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L78">IframeClient.ts:78</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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"><li class=""><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
87
- the sake of API completeness. It's unlikely to be used by most applications.</p>
88
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides AbstractClient.stop</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L36">IframeClient.ts:36</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stopinterceptinglinks"><span>stop<wbr/>Intercepting<wbr/>Links</span><a href="#stopinterceptinglinks" 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="stopinterceptinglinks-1"><span class="tsd-kind-call-signature">stopInterceptingLinks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stopinterceptinglinks-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>Turns off the behavior of intercepting link clicks in the client window click handler.</p>
89
- </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/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L85">IframeClient.ts:85</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
90
- app for the same page, e.g. <code>https://hostapp.com/#/client-app/foo/bar</code>.
91
- You should use this whenever generating an internal link within a client
92
- application so that the user gets a nice experience if they open a link in
93
- a new tab, or copy and paste a link URL into a chat message or email.</p>
94
- </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>
95
- </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 AbstractClient.urlFromClientPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L184">AbstractClient.ts:184</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
96
- app, e.g. <code>https://hostapp.com/#/app2</code>.
97
- You should use this whenever generating a host link within a client
98
- application so that the user gets a nice experience if they open a link in
99
- a new tab, or copy and paste a link URL into a chat message or email.</p>
100
- </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>
101
- </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 AbstractClient.urlFromHostPath</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L200">AbstractClient.ts:200</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="#registercustomelements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>Custom<wbr/>Elements</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"><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="#startinterceptinglinks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Intercepting<wbr/>Links</span></a><a href="#stop"><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="#stopinterceptinglinks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Intercepting<wbr/>Links</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.5.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>
1503
+ </div>
1504
+ </div>
1505
+ <aside class="tsd-sources">
1506
+ <p>Inherited from AbstractClient.requestNotification</p>
1507
+ <ul>
1508
+ <li>
1509
+ Defined in
1510
+ <a
1511
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L349"
1512
+ >AbstractClient.ts:349</a
1513
+ >
1514
+ </li>
1515
+ </ul>
1516
+ </aside>
1517
+ </div>
1518
+ </li>
1519
+ </ul>
1520
+ </section>
1521
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1522
+ <h3 class="tsd-anchor-link" id="requestpromptonleave">
1523
+ <span>request<wbr />Prompt<wbr />On<wbr />Leave</span
1524
+ ><a
1525
+ href="#requestpromptonleave"
1526
+ aria-label="Permalink"
1527
+ class="tsd-anchor-icon"
1528
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1529
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1530
+ ></a>
1531
+ </h3>
1532
+ <ul class="tsd-signatures tsd-is-inherited">
1533
+ <li class="tsd-is-inherited">
1534
+ <div
1535
+ class="tsd-signature tsd-anchor-link"
1536
+ id="requestpromptonleave-1"
1537
+ >
1538
+ <span class="tsd-kind-call-signature"
1539
+ >requestPromptOnLeave</span
1540
+ ><span class="tsd-signature-symbol">(</span
1541
+ ><span class="tsd-kind-parameter">messagePrompt</span
1542
+ ><span class="tsd-signature-symbol">?:</span>
1543
+ <span class="tsd-signature-type">string</span
1544
+ ><span class="tsd-signature-symbol">)</span
1545
+ ><span class="tsd-signature-symbol">:</span>
1546
+ <span class="tsd-signature-type">void</span
1547
+ ><a
1548
+ href="#requestpromptonleave-1"
1549
+ aria-label="Permalink"
1550
+ class="tsd-anchor-icon"
1551
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1552
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1553
+ ></a>
1554
+ </div>
1555
+ <div class="tsd-description">
1556
+ <div class="tsd-comment tsd-typography">
1557
+ <p>
1558
+ Asks the host application to display a prompt on leave
1559
+ dialog.
1560
+ </p>
1561
+ </div>
1562
+ <div class="tsd-parameters">
1563
+ <h4 class="tsd-parameters-title">Parameters</h4>
1564
+ <ul class="tsd-parameter-list">
1565
+ <li>
1566
+ <span
1567
+ ><code class="tsd-tag">Optional</code
1568
+ ><span class="tsd-kind-parameter"
1569
+ >messagePrompt</span
1570
+ >:
1571
+ <span class="tsd-signature-type">string</span></span
1572
+ >
1573
+ </li>
1574
+ </ul>
1575
+ </div>
1576
+ <h4 class="tsd-returns-title">
1577
+ Returns <span class="tsd-signature-type">void</span>
1578
+ </h4>
1579
+ <aside class="tsd-sources">
1580
+ <p>Inherited from AbstractClient.requestPromptOnLeave</p>
1581
+ <ul>
1582
+ <li>
1583
+ Defined in
1584
+ <a
1585
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L377"
1586
+ >AbstractClient.ts:377</a
1587
+ >
1588
+ </li>
1589
+ </ul>
1590
+ </aside>
1591
+ </div>
1592
+ </li>
1593
+ </ul>
1594
+ </section>
1595
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1596
+ <h3 class="tsd-anchor-link" id="sendpagemetadata">
1597
+ <span>send<wbr />Page<wbr />Metadata</span
1598
+ ><a
1599
+ href="#sendpagemetadata"
1600
+ aria-label="Permalink"
1601
+ class="tsd-anchor-icon"
1602
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1603
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1604
+ ></a>
1605
+ </h3>
1606
+ <ul class="tsd-signatures tsd-is-inherited">
1607
+ <li class="tsd-is-inherited">
1608
+ <div
1609
+ class="tsd-signature tsd-anchor-link"
1610
+ id="sendpagemetadata-1"
1611
+ >
1612
+ <span class="tsd-kind-call-signature">sendPageMetadata</span
1613
+ ><span class="tsd-signature-symbol">(</span
1614
+ ><span class="tsd-kind-parameter">metadata</span
1615
+ ><span class="tsd-signature-symbol">:</span>
1616
+ <a
1617
+ href="../interfaces/messages.PageMetadata.html"
1618
+ class="tsd-signature-type tsd-kind-interface"
1619
+ >PageMetadata</a
1620
+ ><span class="tsd-signature-symbol">)</span
1621
+ ><span class="tsd-signature-symbol">:</span>
1622
+ <span class="tsd-signature-type">void</span
1623
+ ><a
1624
+ href="#sendpagemetadata-1"
1625
+ aria-label="Permalink"
1626
+ class="tsd-anchor-icon"
1627
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1628
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1629
+ ></a>
1630
+ </div>
1631
+ <div class="tsd-description">
1632
+ <div class="tsd-comment tsd-typography">
1633
+ <p>
1634
+ Sends page metadata to host for display and browser
1635
+ settings
1636
+ </p>
1637
+ <p>
1638
+ title property is for the page title in the browser
1639
+ breadcrumbs is an array of breadcrumb data for display
1640
+ in host application custom is any custom data wanting to
1641
+ be sent by client app
1642
+ </p>
1643
+ </div>
1644
+ <div class="tsd-parameters">
1645
+ <h4 class="tsd-parameters-title">Parameters</h4>
1646
+ <ul class="tsd-parameter-list">
1647
+ <li>
1648
+ <span
1649
+ ><span class="tsd-kind-parameter">metadata</span>:
1650
+ <a
1651
+ href="../interfaces/messages.PageMetadata.html"
1652
+ class="tsd-signature-type tsd-kind-interface"
1653
+ >PageMetadata</a
1654
+ ></span
1655
+ >
1656
+ <div class="tsd-comment tsd-typography">
1657
+ <p>
1658
+ data that will be used for display in host
1659
+ application and browser page title
1660
+ </p>
1661
+ </div>
1662
+ </li>
1663
+ </ul>
1664
+ </div>
1665
+ <h4 class="tsd-returns-title">
1666
+ Returns <span class="tsd-signature-type">void</span>
1667
+ </h4>
1668
+ <aside class="tsd-sources">
1669
+ <p>Inherited from AbstractClient.sendPageMetadata</p>
1670
+ <ul>
1671
+ <li>
1672
+ Defined in
1673
+ <a
1674
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L403"
1675
+ >AbstractClient.ts:403</a
1676
+ >
1677
+ </li>
1678
+ </ul>
1679
+ </aside>
1680
+ </div>
1681
+ </li>
1682
+ </ul>
1683
+ </section>
1684
+ <section class="tsd-panel tsd-member">
1685
+ <h3 class="tsd-anchor-link" id="start">
1686
+ <span>start</span
1687
+ ><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"
1688
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1689
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1690
+ ></a>
1691
+ </h3>
1692
+ <ul class="tsd-signatures">
1693
+ <li class="">
1694
+ <div class="tsd-signature tsd-anchor-link" id="start-1">
1695
+ <span class="tsd-kind-call-signature">start</span
1696
+ ><span class="tsd-signature-symbol">()</span
1697
+ ><span class="tsd-signature-symbol">:</span>
1698
+ <span class="tsd-signature-type">void</span
1699
+ ><a
1700
+ href="#start-1"
1701
+ aria-label="Permalink"
1702
+ class="tsd-anchor-icon"
1703
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1704
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1705
+ ></a>
1706
+ </div>
1707
+ <div class="tsd-description">
1708
+ <div class="tsd-comment tsd-typography">
1709
+ <p>
1710
+ Initiates responding to events triggered by the host
1711
+ application.
1712
+ </p>
1713
+ </div>
1714
+ <h4 class="tsd-returns-title">
1715
+ Returns <span class="tsd-signature-type">void</span>
1716
+ </h4>
1717
+ <aside class="tsd-sources">
1718
+ <p>Overrides AbstractClient.start</p>
1719
+ <ul>
1720
+ <li>
1721
+ Defined in
1722
+ <a
1723
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L30"
1724
+ >IframeClient.ts:30</a
1725
+ >
1726
+ </li>
1727
+ </ul>
1728
+ </aside>
1729
+ </div>
1730
+ </li>
1731
+ </ul>
1732
+ </section>
1733
+ <section class="tsd-panel tsd-member">
1734
+ <h3 class="tsd-anchor-link" id="startinterceptinglinks">
1735
+ <span>start<wbr />Intercepting<wbr />Links</span
1736
+ ><a
1737
+ href="#startinterceptinglinks"
1738
+ aria-label="Permalink"
1739
+ class="tsd-anchor-icon"
1740
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1741
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1742
+ ></a>
1743
+ </h3>
1744
+ <ul class="tsd-signatures">
1745
+ <li class="">
1746
+ <div
1747
+ class="tsd-signature tsd-anchor-link"
1748
+ id="startinterceptinglinks-1"
1749
+ >
1750
+ <span class="tsd-kind-call-signature"
1751
+ >startInterceptingLinks</span
1752
+ ><span class="tsd-signature-symbol">()</span
1753
+ ><span class="tsd-signature-symbol">:</span>
1754
+ <span class="tsd-signature-type">void</span
1755
+ ><a
1756
+ href="#startinterceptinglinks-1"
1757
+ aria-label="Permalink"
1758
+ class="tsd-anchor-icon"
1759
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1760
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1761
+ ></a>
1762
+ </div>
1763
+ <div class="tsd-description">
1764
+ <div class="tsd-comment tsd-typography">
1765
+ <p>
1766
+ Allows the click handler on the client window to
1767
+ intercept clicks on anchor elements and makes a nav
1768
+ request to the host based on the element's href. This
1769
+ should be avoided for complex applications as it can
1770
+ interfere with things like download links that you may
1771
+ not want to intercept.
1772
+ </p>
1773
+ </div>
1774
+ <h4 class="tsd-returns-title">
1775
+ Returns <span class="tsd-signature-type">void</span>
1776
+ </h4>
1777
+ <aside class="tsd-sources">
1778
+ <ul>
1779
+ <li>
1780
+ Defined in
1781
+ <a
1782
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L78"
1783
+ >IframeClient.ts:78</a
1784
+ >
1785
+ </li>
1786
+ </ul>
1787
+ </aside>
1788
+ </div>
1789
+ </li>
1790
+ </ul>
1791
+ </section>
1792
+ <section class="tsd-panel tsd-member">
1793
+ <h3 class="tsd-anchor-link" id="stop">
1794
+ <span>stop</span
1795
+ ><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"
1796
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1797
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1798
+ ></a>
1799
+ </h3>
1800
+ <ul class="tsd-signatures">
1801
+ <li class="">
1802
+ <div class="tsd-signature tsd-anchor-link" id="stop-1">
1803
+ <span class="tsd-kind-call-signature">stop</span
1804
+ ><span class="tsd-signature-symbol">()</span
1805
+ ><span class="tsd-signature-symbol">:</span>
1806
+ <span class="tsd-signature-type">void</span
1807
+ ><a
1808
+ href="#stop-1"
1809
+ aria-label="Permalink"
1810
+ class="tsd-anchor-icon"
1811
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1812
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1813
+ ></a>
1814
+ </div>
1815
+ <div class="tsd-description">
1816
+ <div class="tsd-comment tsd-typography">
1817
+ <p>
1818
+ Disconnects this client from the host application. This
1819
+ is mostly provided for the sake of API completeness.
1820
+ It's unlikely to be used by most applications.
1821
+ </p>
1822
+ </div>
1823
+ <h4 class="tsd-returns-title">
1824
+ Returns <span class="tsd-signature-type">void</span>
1825
+ </h4>
1826
+ <aside class="tsd-sources">
1827
+ <p>Overrides AbstractClient.stop</p>
1828
+ <ul>
1829
+ <li>
1830
+ Defined in
1831
+ <a
1832
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L36"
1833
+ >IframeClient.ts:36</a
1834
+ >
1835
+ </li>
1836
+ </ul>
1837
+ </aside>
1838
+ </div>
1839
+ </li>
1840
+ </ul>
1841
+ </section>
1842
+ <section class="tsd-panel tsd-member">
1843
+ <h3 class="tsd-anchor-link" id="stopinterceptinglinks">
1844
+ <span>stop<wbr />Intercepting<wbr />Links</span
1845
+ ><a
1846
+ href="#stopinterceptinglinks"
1847
+ aria-label="Permalink"
1848
+ class="tsd-anchor-icon"
1849
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1850
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1851
+ ></a>
1852
+ </h3>
1853
+ <ul class="tsd-signatures">
1854
+ <li class="">
1855
+ <div
1856
+ class="tsd-signature tsd-anchor-link"
1857
+ id="stopinterceptinglinks-1"
1858
+ >
1859
+ <span class="tsd-kind-call-signature"
1860
+ >stopInterceptingLinks</span
1861
+ ><span class="tsd-signature-symbol">()</span
1862
+ ><span class="tsd-signature-symbol">:</span>
1863
+ <span class="tsd-signature-type">void</span
1864
+ ><a
1865
+ href="#stopinterceptinglinks-1"
1866
+ aria-label="Permalink"
1867
+ class="tsd-anchor-icon"
1868
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1869
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1870
+ ></a>
1871
+ </div>
1872
+ <div class="tsd-description">
1873
+ <div class="tsd-comment tsd-typography">
1874
+ <p>
1875
+ Turns off the behavior of intercepting link clicks in
1876
+ the client window click handler.
1877
+ </p>
1878
+ </div>
1879
+ <h4 class="tsd-returns-title">
1880
+ Returns <span class="tsd-signature-type">void</span>
1881
+ </h4>
1882
+ <aside class="tsd-sources">
1883
+ <ul>
1884
+ <li>
1885
+ Defined in
1886
+ <a
1887
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L85"
1888
+ >IframeClient.ts:85</a
1889
+ >
1890
+ </li>
1891
+ </ul>
1892
+ </aside>
1893
+ </div>
1894
+ </li>
1895
+ </ul>
1896
+ </section>
1897
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1898
+ <h3 class="tsd-anchor-link" id="urlfromclientpath">
1899
+ <span>url<wbr />From<wbr />Client<wbr />Path</span
1900
+ ><a
1901
+ href="#urlfromclientpath"
1902
+ aria-label="Permalink"
1903
+ class="tsd-anchor-icon"
1904
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1905
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1906
+ ></a>
1907
+ </h3>
1908
+ <ul class="tsd-signatures tsd-is-inherited">
1909
+ <li class="tsd-is-inherited">
1910
+ <div
1911
+ class="tsd-signature tsd-anchor-link"
1912
+ id="urlfromclientpath-1"
1913
+ >
1914
+ <span class="tsd-kind-call-signature"
1915
+ >urlFromClientPath</span
1916
+ ><span class="tsd-signature-symbol">(</span
1917
+ ><span class="tsd-kind-parameter">clientRoute</span
1918
+ ><span class="tsd-signature-symbol">:</span>
1919
+ <span class="tsd-signature-type">string</span
1920
+ ><span class="tsd-signature-symbol">)</span
1921
+ ><span class="tsd-signature-symbol">:</span>
1922
+ <span class="tsd-signature-type">string</span
1923
+ ><a
1924
+ href="#urlfromclientpath-1"
1925
+ aria-label="Permalink"
1926
+ class="tsd-anchor-icon"
1927
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1928
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1929
+ ></a>
1930
+ </div>
1931
+ <div class="tsd-description">
1932
+ <div class="tsd-comment tsd-typography">
1933
+ <p>
1934
+ Translates a client route like <code>/foo/bar</code> to
1935
+ the full URL used in the host app for the same page,
1936
+ e.g.
1937
+ <code>https://hostapp.com/#/client-app/foo/bar</code>.
1938
+ You should use this whenever generating an internal link
1939
+ within a client application so that the user gets a nice
1940
+ experience if they open a link in a new tab, or copy and
1941
+ paste a link URL into a chat message or email.
1942
+ </p>
1943
+ </div>
1944
+ <div class="tsd-parameters">
1945
+ <h4 class="tsd-parameters-title">Parameters</h4>
1946
+ <ul class="tsd-parameter-list">
1947
+ <li>
1948
+ <span
1949
+ ><span class="tsd-kind-parameter">clientRoute</span
1950
+ >:
1951
+ <span class="tsd-signature-type">string</span></span
1952
+ >
1953
+ <div class="tsd-comment tsd-typography">
1954
+ <p>
1955
+ The /-separated path within the client app to link
1956
+ to.
1957
+ </p>
1958
+ </div>
1959
+ </li>
1960
+ </ul>
1961
+ </div>
1962
+ <h4 class="tsd-returns-title">
1963
+ Returns <span class="tsd-signature-type">string</span>
1964
+ </h4>
1965
+ <aside class="tsd-sources">
1966
+ <p>Inherited from AbstractClient.urlFromClientPath</p>
1967
+ <ul>
1968
+ <li>
1969
+ Defined in
1970
+ <a
1971
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L182"
1972
+ >AbstractClient.ts:182</a
1973
+ >
1974
+ </li>
1975
+ </ul>
1976
+ </aside>
1977
+ </div>
1978
+ </li>
1979
+ </ul>
1980
+ </section>
1981
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1982
+ <h3 class="tsd-anchor-link" id="urlfromhostpath">
1983
+ <span>url<wbr />From<wbr />Host<wbr />Path</span
1984
+ ><a
1985
+ href="#urlfromhostpath"
1986
+ aria-label="Permalink"
1987
+ class="tsd-anchor-icon"
1988
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1989
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1990
+ ></a>
1991
+ </h3>
1992
+ <ul class="tsd-signatures tsd-is-inherited">
1993
+ <li class="tsd-is-inherited">
1994
+ <div
1995
+ class="tsd-signature tsd-anchor-link"
1996
+ id="urlfromhostpath-1"
1997
+ >
1998
+ <span class="tsd-kind-call-signature">urlFromHostPath</span
1999
+ ><span class="tsd-signature-symbol">(</span
2000
+ ><span class="tsd-kind-parameter">hostRoute</span
2001
+ ><span class="tsd-signature-symbol">:</span>
2002
+ <span class="tsd-signature-type">string</span
2003
+ ><span class="tsd-signature-symbol">)</span
2004
+ ><span class="tsd-signature-symbol">:</span>
2005
+ <span class="tsd-signature-type">string</span
2006
+ ><a
2007
+ href="#urlfromhostpath-1"
2008
+ aria-label="Permalink"
2009
+ class="tsd-anchor-icon"
2010
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2011
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
2012
+ ></a>
2013
+ </div>
2014
+ <div class="tsd-description">
2015
+ <div class="tsd-comment tsd-typography">
2016
+ <p>
2017
+ Translates a host route like <code>/app2</code> to the
2018
+ full URL used in the host app, e.g.
2019
+ <code>https://hostapp.com/#/app2</code>. You should use
2020
+ this whenever generating a host link within a client
2021
+ application so that the user gets a nice experience if
2022
+ they open a link in a new tab, or copy and paste a link
2023
+ URL into a chat message or email.
2024
+ </p>
2025
+ </div>
2026
+ <div class="tsd-parameters">
2027
+ <h4 class="tsd-parameters-title">Parameters</h4>
2028
+ <ul class="tsd-parameter-list">
2029
+ <li>
2030
+ <span
2031
+ ><span class="tsd-kind-parameter">hostRoute</span>:
2032
+ <span class="tsd-signature-type">string</span></span
2033
+ >
2034
+ <div class="tsd-comment tsd-typography">
2035
+ <p>
2036
+ The /-separated path within the host app to link
2037
+ to.
2038
+ </p>
2039
+ </div>
2040
+ </li>
2041
+ </ul>
2042
+ </div>
2043
+ <h4 class="tsd-returns-title">
2044
+ Returns <span class="tsd-signature-type">string</span>
2045
+ </h4>
2046
+ <aside class="tsd-sources">
2047
+ <p>Inherited from AbstractClient.urlFromHostPath</p>
2048
+ <ul>
2049
+ <li>
2050
+ Defined in
2051
+ <a
2052
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L198"
2053
+ >AbstractClient.ts:198</a
2054
+ >
2055
+ </li>
2056
+ </ul>
2057
+ </aside>
2058
+ </div>
2059
+ </li>
2060
+ </ul>
2061
+ </section>
2062
+ </section>
2063
+ </details>
2064
+ </div>
2065
+ <div class="col-sidebar">
2066
+ <div class="page-menu">
2067
+ <div class="tsd-navigation settings">
2068
+ <details class="tsd-accordion">
2069
+ <summary class="tsd-accordion-summary">
2070
+ <svg
2071
+ width="20"
2072
+ height="20"
2073
+ viewBox="0 0 24 24"
2074
+ fill="none"
2075
+ aria-hidden="true"
2076
+ >
2077
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
2078
+ </svg>
2079
+ <h3>Settings</h3>
2080
+ </summary>
2081
+ <div class="tsd-accordion-details">
2082
+ <div class="tsd-filter-visibility">
2083
+ <span class="settings-label">Member Visibility</span>
2084
+ <ul id="tsd-filter-options">
2085
+ <li class="tsd-filter-item">
2086
+ <label class="tsd-filter-input"
2087
+ ><input
2088
+ type="checkbox"
2089
+ id="tsd-filter-inherited"
2090
+ name="inherited"
2091
+ checked
2092
+ /><svg
2093
+ width="32"
2094
+ height="32"
2095
+ viewBox="0 0 32 32"
2096
+ aria-hidden="true"
2097
+ >
2098
+ <rect
2099
+ class="tsd-checkbox-background"
2100
+ width="30"
2101
+ height="30"
2102
+ x="1"
2103
+ y="1"
2104
+ rx="6"
2105
+ fill="none"
2106
+ ></rect>
2107
+ <path
2108
+ class="tsd-checkbox-checkmark"
2109
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
2110
+ stroke="none"
2111
+ stroke-width="3.5"
2112
+ stroke-linejoin="round"
2113
+ fill="none"
2114
+ ></path></svg
2115
+ ><span>Inherited</span></label
2116
+ >
2117
+ </li>
2118
+ </ul>
2119
+ </div>
2120
+ <div class="tsd-theme-toggle">
2121
+ <label class="settings-label" for="tsd-theme">Theme</label
2122
+ ><select id="tsd-theme">
2123
+ <option value="os">OS</option>
2124
+ <option value="light">Light</option>
2125
+ <option value="dark">Dark</option>
2126
+ </select>
2127
+ </div>
2128
+ </div>
2129
+ </details>
2130
+ </div>
2131
+ <details open class="tsd-accordion tsd-page-navigation">
2132
+ <summary class="tsd-accordion-summary">
2133
+ <svg
2134
+ width="20"
2135
+ height="20"
2136
+ viewBox="0 0 24 24"
2137
+ fill="none"
2138
+ aria-hidden="true"
2139
+ >
2140
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
2141
+ </svg>
2142
+ <h3>On This Page</h3>
2143
+ </summary>
2144
+ <div class="tsd-accordion-details">
2145
+ <details open class="tsd-accordion tsd-page-navigation-section">
2146
+ <summary
2147
+ class="tsd-accordion-summary"
2148
+ data-key="section-Constructors"
2149
+ >
2150
+ <svg
2151
+ width="20"
2152
+ height="20"
2153
+ viewBox="0 0 24 24"
2154
+ fill="none"
2155
+ aria-hidden="true"
2156
+ >
2157
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
2158
+ >Constructors
2159
+ </summary>
2160
+ <div>
2161
+ <a href="#constructor"
2162
+ ><svg
2163
+ class="tsd-kind-icon"
2164
+ viewBox="0 0 24 24"
2165
+ aria-label="Constructor"
2166
+ >
2167
+ <use href="../assets/icons.svg#icon-512"></use></svg
2168
+ ><span>constructor</span></a
2169
+ >
2170
+ </div>
2171
+ </details>
2172
+ <details open class="tsd-accordion tsd-page-navigation-section">
2173
+ <summary
2174
+ class="tsd-accordion-summary"
2175
+ data-key="section-Accessors"
2176
+ >
2177
+ <svg
2178
+ width="20"
2179
+ height="20"
2180
+ viewBox="0 0 24 24"
2181
+ fill="none"
2182
+ aria-hidden="true"
2183
+ >
2184
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
2185
+ >Accessors
2186
+ </summary>
2187
+ <div>
2188
+ <a href="#environmentdata" class="tsd-is-inherited"
2189
+ ><svg
2190
+ class="tsd-kind-icon"
2191
+ viewBox="0 0 24 24"
2192
+ aria-label="Accessor"
2193
+ >
2194
+ <use href="../assets/icons.svg#icon-262144"></use></svg
2195
+ ><span>environment<wbr />Data</span></a
2196
+ ><a href="#messaging" class="tsd-is-inherited"
2197
+ ><svg
2198
+ class="tsd-kind-icon"
2199
+ viewBox="0 0 24 24"
2200
+ aria-label="Accessor"
2201
+ >
2202
+ <use href="../assets/icons.svg#icon-262144"></use></svg
2203
+ ><span>messaging</span></a
2204
+ >
2205
+ </div>
2206
+ </details>
2207
+ <details open class="tsd-accordion tsd-page-navigation-section">
2208
+ <summary
2209
+ class="tsd-accordion-summary"
2210
+ data-key="section-Methods"
2211
+ >
2212
+ <svg
2213
+ width="20"
2214
+ height="20"
2215
+ viewBox="0 0 24 24"
2216
+ fill="none"
2217
+ aria-hidden="true"
2218
+ >
2219
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
2220
+ >Methods
2221
+ </summary>
2222
+ <div>
2223
+ <a href="#addlistener" class="tsd-is-inherited"
2224
+ ><svg
2225
+ class="tsd-kind-icon"
2226
+ viewBox="0 0 24 24"
2227
+ aria-label="Method"
2228
+ >
2229
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2230
+ ><span>add<wbr />Listener</span></a
2231
+ ><a href="#ashosturl" class="tsd-is-inherited"
2232
+ ><svg
2233
+ class="tsd-kind-icon"
2234
+ viewBox="0 0 24 24"
2235
+ aria-label="Method"
2236
+ >
2237
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2238
+ ><span>as<wbr />Host<wbr />Url</span></a
2239
+ ><a href="#clearpromptonleave" class="tsd-is-inherited"
2240
+ ><svg
2241
+ class="tsd-kind-icon"
2242
+ viewBox="0 0 24 24"
2243
+ aria-label="Method"
2244
+ >
2245
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2246
+ ><span>clear<wbr />Prompt<wbr />On<wbr />Leave</span></a
2247
+ ><a href="#publish" class="tsd-is-inherited"
2248
+ ><svg
2249
+ class="tsd-kind-icon"
2250
+ viewBox="0 0 24 24"
2251
+ aria-label="Method"
2252
+ >
2253
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2254
+ ><span>publish</span></a
2255
+ ><a href="#registercustomelements"
2256
+ ><svg
2257
+ class="tsd-kind-icon"
2258
+ viewBox="0 0 24 24"
2259
+ aria-label="Method"
2260
+ >
2261
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2262
+ ><span>register<wbr />Custom<wbr />Elements</span></a
2263
+ ><a href="#removealllisteners" class="tsd-is-inherited"
2264
+ ><svg
2265
+ class="tsd-kind-icon"
2266
+ viewBox="0 0 24 24"
2267
+ aria-label="Method"
2268
+ >
2269
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2270
+ ><span>remove<wbr />All<wbr />Listeners</span></a
2271
+ ><a href="#removelistener" class="tsd-is-inherited"
2272
+ ><svg
2273
+ class="tsd-kind-icon"
2274
+ viewBox="0 0 24 24"
2275
+ aria-label="Method"
2276
+ >
2277
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2278
+ ><span>remove<wbr />Listener</span></a
2279
+ ><a href="#requestmodal" class="tsd-is-inherited"
2280
+ ><svg
2281
+ class="tsd-kind-icon"
2282
+ viewBox="0 0 24 24"
2283
+ aria-label="Method"
2284
+ >
2285
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2286
+ ><span>request<wbr />Modal</span></a
2287
+ ><a href="#requestnavigation" class="tsd-is-inherited"
2288
+ ><svg
2289
+ class="tsd-kind-icon"
2290
+ viewBox="0 0 24 24"
2291
+ aria-label="Method"
2292
+ >
2293
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2294
+ ><span>request<wbr />Navigation</span></a
2295
+ ><a href="#requestnotification" class="tsd-is-inherited"
2296
+ ><svg
2297
+ class="tsd-kind-icon"
2298
+ viewBox="0 0 24 24"
2299
+ aria-label="Method"
2300
+ >
2301
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2302
+ ><span>request<wbr />Notification</span></a
2303
+ ><a href="#requestpromptonleave" class="tsd-is-inherited"
2304
+ ><svg
2305
+ class="tsd-kind-icon"
2306
+ viewBox="0 0 24 24"
2307
+ aria-label="Method"
2308
+ >
2309
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2310
+ ><span>request<wbr />Prompt<wbr />On<wbr />Leave</span></a
2311
+ ><a href="#sendpagemetadata" class="tsd-is-inherited"
2312
+ ><svg
2313
+ class="tsd-kind-icon"
2314
+ viewBox="0 0 24 24"
2315
+ aria-label="Method"
2316
+ >
2317
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2318
+ ><span>send<wbr />Page<wbr />Metadata</span></a
2319
+ ><a href="#start"
2320
+ ><svg
2321
+ class="tsd-kind-icon"
2322
+ viewBox="0 0 24 24"
2323
+ aria-label="Method"
2324
+ >
2325
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2326
+ ><span>start</span></a
2327
+ ><a href="#startinterceptinglinks"
2328
+ ><svg
2329
+ class="tsd-kind-icon"
2330
+ viewBox="0 0 24 24"
2331
+ aria-label="Method"
2332
+ >
2333
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2334
+ ><span>start<wbr />Intercepting<wbr />Links</span></a
2335
+ ><a href="#stop"
2336
+ ><svg
2337
+ class="tsd-kind-icon"
2338
+ viewBox="0 0 24 24"
2339
+ aria-label="Method"
2340
+ >
2341
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2342
+ ><span>stop</span></a
2343
+ ><a href="#stopinterceptinglinks"
2344
+ ><svg
2345
+ class="tsd-kind-icon"
2346
+ viewBox="0 0 24 24"
2347
+ aria-label="Method"
2348
+ >
2349
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2350
+ ><span>stop<wbr />Intercepting<wbr />Links</span></a
2351
+ ><a href="#urlfromclientpath" class="tsd-is-inherited"
2352
+ ><svg
2353
+ class="tsd-kind-icon"
2354
+ viewBox="0 0 24 24"
2355
+ aria-label="Method"
2356
+ >
2357
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2358
+ ><span>url<wbr />From<wbr />Client<wbr />Path</span></a
2359
+ ><a href="#urlfromhostpath" class="tsd-is-inherited"
2360
+ ><svg
2361
+ class="tsd-kind-icon"
2362
+ viewBox="0 0 24 24"
2363
+ aria-label="Method"
2364
+ >
2365
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2366
+ ><span>url<wbr />From<wbr />Host<wbr />Path</span></a
2367
+ >
2368
+ </div>
2369
+ </details>
2370
+ </div>
2371
+ </details>
2372
+ </div>
2373
+ <div class="site-menu">
2374
+ <nav class="tsd-navigation">
2375
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
2376
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
2377
+ <li>Loading...</li>
2378
+ </ul>
2379
+ </nav>
2380
+ </div>
2381
+ </div>
2382
+ </div>
2383
+ <footer>
2384
+ <p class="tsd-generator">
2385
+ Generated using
2386
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
2387
+ </p>
2388
+ </footer>
2389
+ <div class="overlay"></div>
2390
+ </body>
2391
+ </html>