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
@@ -1,11 +1,510 @@
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>EnvData | 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/messages.html">messages</a></li><li><a href="" aria-current="page">EnvData</a></li></ul><h1>Interface EnvData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Environmental data provided to all clients
2
- in order to match behavior of the host application.</p>
3
- </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">EnvData</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#hostrooturl">hostRootUrl</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#locale">locale</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#registeredkeys">registeredKeys</a><span class="tsd-signature-symbol">?:</span> <a href="messages.KeyData.html" class="tsd-signature-type tsd-kind-interface">KeyData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/messages/Lifecycle.ts#L33">messages/Lifecycle.ts:33</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">Properties</h3><div class="tsd-index-list"><a href="#custom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom?</span></a>
4
- <a href="#hostrooturl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<wbr/>Root<wbr/>Url</span></a>
5
- <a href="#locale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale</span></a>
6
- <a href="#registeredkeys" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>registered<wbr/>Keys?</span></a>
7
- </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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="custom"><code class="tsd-tag">Optional</code><span>custom</span><a href="#custom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Extra application-specific details for your use case</p>
8
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/messages/Lifecycle.ts#L41">messages/Lifecycle.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hostrooturl"><span>host<wbr/>Root<wbr/>Url</span><a href="#hostrooturl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hostRootUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The location of the host app. Useful for building URLs that reference host pages</p>
9
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/messages/Lifecycle.ts#L37">messages/Lifecycle.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="locale"><span>locale</span><a href="#locale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The locale in use by the host app, which the client application should also use.</p>
10
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/messages/Lifecycle.ts#L35">messages/Lifecycle.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="registeredkeys"><code class="tsd-tag">Optional</code><span>registered<wbr/>Keys</span><a href="#registeredkeys" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">registeredKeys</span><span class="tsd-signature-symbol">?:</span> <a href="messages.KeyData.html" class="tsd-signature-type tsd-kind-interface">KeyData</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Keys to notify keypress events to the host on. This can be used to create global keyboard shortcuts.</p>
11
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/messages/Lifecycle.ts#L39">messages/Lifecycle.ts:39</a></li></ul></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#custom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom</span></a><a href="#hostrooturl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<wbr/>Root<wbr/>Url</span></a><a href="#locale"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale</span></a><a href="#registeredkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>registered<wbr/>Keys</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>
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>EnvData | 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/messages.html">messages</a></li>
83
+ <li><a href="" aria-current="page">EnvData</a></li>
84
+ </ul>
85
+ <h1>Interface EnvData</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ Environmental data provided to all clients in order to match
91
+ behavior of the host application.
92
+ </p>
93
+ </div>
94
+ </section>
95
+ <div class="tsd-signature">
96
+ <span class="tsd-signature-keyword">interface</span>
97
+ <span class="tsd-kind-interface">EnvData</span>
98
+ <span class="tsd-signature-symbol">{</span><br />    <a
99
+ class="tsd-kind-property"
100
+ href="#custom"
101
+ >custom</a
102
+ ><span class="tsd-signature-symbol">?:</span>
103
+ <span class="tsd-signature-type">any</span
104
+ ><span class="tsd-signature-symbol">;</span><br />    <a
105
+ class="tsd-kind-property"
106
+ href="#hostrooturl"
107
+ >hostRootUrl</a
108
+ ><span class="tsd-signature-symbol">:</span>
109
+ <span class="tsd-signature-type">string</span
110
+ ><span class="tsd-signature-symbol">;</span><br />    <a
111
+ class="tsd-kind-property"
112
+ href="#locale"
113
+ >locale</a
114
+ ><span class="tsd-signature-symbol">:</span>
115
+ <span class="tsd-signature-type">string</span
116
+ ><span class="tsd-signature-symbol">;</span><br />    <a
117
+ class="tsd-kind-property"
118
+ href="#registeredkeys"
119
+ >registeredKeys</a
120
+ ><span class="tsd-signature-symbol">?:</span>
121
+ <a
122
+ href="messages.KeyData.html"
123
+ class="tsd-signature-type tsd-kind-interface"
124
+ >KeyData</a
125
+ ><span class="tsd-signature-symbol">[]</span
126
+ ><span class="tsd-signature-symbol">;</span><br /><span
127
+ class="tsd-signature-symbol"
128
+ >}</span
129
+ >
130
+ </div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>
134
+ Defined in
135
+ <a
136
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Lifecycle.ts#L33"
137
+ >messages/Lifecycle.ts:33</a
138
+ >
139
+ </li>
140
+ </ul>
141
+ </aside>
142
+ <section class="tsd-panel-group tsd-index-group">
143
+ <section class="tsd-panel tsd-index-panel">
144
+ <details class="tsd-index-content tsd-accordion" open>
145
+ <summary class="tsd-accordion-summary tsd-index-summary">
146
+ <svg
147
+ width="20"
148
+ height="20"
149
+ viewBox="0 0 24 24"
150
+ fill="none"
151
+ aria-hidden="true"
152
+ >
153
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
154
+ </svg>
155
+ <h5 class="tsd-index-heading uppercase">Index</h5>
156
+ </summary>
157
+ <div class="tsd-accordion-details">
158
+ <section class="tsd-index-section">
159
+ <h3 class="tsd-index-heading">Properties</h3>
160
+ <div class="tsd-index-list">
161
+ <a href="#custom" class="tsd-index-link"
162
+ ><svg
163
+ class="tsd-kind-icon"
164
+ viewBox="0 0 24 24"
165
+ aria-label="Property"
166
+ >
167
+ <use href="../assets/icons.svg#icon-1024"></use></svg
168
+ ><span>custom?</span></a
169
+ >
170
+ <a href="#hostrooturl" class="tsd-index-link"
171
+ ><svg
172
+ class="tsd-kind-icon"
173
+ viewBox="0 0 24 24"
174
+ aria-label="Property"
175
+ >
176
+ <use href="../assets/icons.svg#icon-1024"></use></svg
177
+ ><span>host<wbr />Root<wbr />Url</span></a
178
+ >
179
+ <a href="#locale" class="tsd-index-link"
180
+ ><svg
181
+ class="tsd-kind-icon"
182
+ viewBox="0 0 24 24"
183
+ aria-label="Property"
184
+ >
185
+ <use href="../assets/icons.svg#icon-1024"></use></svg
186
+ ><span>locale</span></a
187
+ >
188
+ <a href="#registeredkeys" class="tsd-index-link"
189
+ ><svg
190
+ class="tsd-kind-icon"
191
+ viewBox="0 0 24 24"
192
+ aria-label="Property"
193
+ >
194
+ <use href="../assets/icons.svg#icon-1024"></use></svg
195
+ ><span>registered<wbr />Keys?</span></a
196
+ >
197
+ </div>
198
+ </section>
199
+ </div>
200
+ </details>
201
+ </section>
202
+ </section>
203
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
204
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
205
+ <svg
206
+ width="20"
207
+ height="20"
208
+ viewBox="0 0 24 24"
209
+ fill="none"
210
+ aria-hidden="true"
211
+ >
212
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
213
+ </svg>
214
+ <h2>Properties</h2>
215
+ </summary>
216
+ <section>
217
+ <section class="tsd-panel tsd-member">
218
+ <h3 class="tsd-anchor-link" id="custom">
219
+ <code class="tsd-tag">Optional</code><span>custom</span
220
+ ><a
221
+ href="#custom"
222
+ aria-label="Permalink"
223
+ class="tsd-anchor-icon"
224
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
225
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
226
+ ></a>
227
+ </h3>
228
+ <div class="tsd-signature">
229
+ <span class="tsd-kind-property">custom</span
230
+ ><span class="tsd-signature-symbol">?:</span>
231
+ <span class="tsd-signature-type">any</span>
232
+ </div>
233
+ <div class="tsd-comment tsd-typography">
234
+ <p>Extra application-specific details for your use case</p>
235
+ </div>
236
+ <aside class="tsd-sources">
237
+ <ul>
238
+ <li>
239
+ Defined in
240
+ <a
241
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Lifecycle.ts#L41"
242
+ >messages/Lifecycle.ts:41</a
243
+ >
244
+ </li>
245
+ </ul>
246
+ </aside>
247
+ </section>
248
+ <section class="tsd-panel tsd-member">
249
+ <h3 class="tsd-anchor-link" id="hostrooturl">
250
+ <span>host<wbr />Root<wbr />Url</span
251
+ ><a
252
+ href="#hostrooturl"
253
+ aria-label="Permalink"
254
+ class="tsd-anchor-icon"
255
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
256
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
257
+ ></a>
258
+ </h3>
259
+ <div class="tsd-signature">
260
+ <span class="tsd-kind-property">hostRootUrl</span
261
+ ><span class="tsd-signature-symbol">:</span>
262
+ <span class="tsd-signature-type">string</span>
263
+ </div>
264
+ <div class="tsd-comment tsd-typography">
265
+ <p>
266
+ The location of the host app. Useful for building URLs that
267
+ reference host pages
268
+ </p>
269
+ </div>
270
+ <aside class="tsd-sources">
271
+ <ul>
272
+ <li>
273
+ Defined in
274
+ <a
275
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Lifecycle.ts#L37"
276
+ >messages/Lifecycle.ts:37</a
277
+ >
278
+ </li>
279
+ </ul>
280
+ </aside>
281
+ </section>
282
+ <section class="tsd-panel tsd-member">
283
+ <h3 class="tsd-anchor-link" id="locale">
284
+ <span>locale</span
285
+ ><a
286
+ href="#locale"
287
+ aria-label="Permalink"
288
+ class="tsd-anchor-icon"
289
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
290
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
291
+ ></a>
292
+ </h3>
293
+ <div class="tsd-signature">
294
+ <span class="tsd-kind-property">locale</span
295
+ ><span class="tsd-signature-symbol">:</span>
296
+ <span class="tsd-signature-type">string</span>
297
+ </div>
298
+ <div class="tsd-comment tsd-typography">
299
+ <p>
300
+ The locale in use by the host app, which the client
301
+ application should also use.
302
+ </p>
303
+ </div>
304
+ <aside class="tsd-sources">
305
+ <ul>
306
+ <li>
307
+ Defined in
308
+ <a
309
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Lifecycle.ts#L35"
310
+ >messages/Lifecycle.ts:35</a
311
+ >
312
+ </li>
313
+ </ul>
314
+ </aside>
315
+ </section>
316
+ <section class="tsd-panel tsd-member">
317
+ <h3 class="tsd-anchor-link" id="registeredkeys">
318
+ <code class="tsd-tag">Optional</code
319
+ ><span>registered<wbr />Keys</span
320
+ ><a
321
+ href="#registeredkeys"
322
+ aria-label="Permalink"
323
+ class="tsd-anchor-icon"
324
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
325
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
326
+ ></a>
327
+ </h3>
328
+ <div class="tsd-signature">
329
+ <span class="tsd-kind-property">registeredKeys</span
330
+ ><span class="tsd-signature-symbol">?:</span>
331
+ <a
332
+ href="messages.KeyData.html"
333
+ class="tsd-signature-type tsd-kind-interface"
334
+ >KeyData</a
335
+ ><span class="tsd-signature-symbol">[]</span>
336
+ </div>
337
+ <div class="tsd-comment tsd-typography">
338
+ <p>
339
+ Keys to notify keypress events to the host on. This can be
340
+ used to create global keyboard shortcuts.
341
+ </p>
342
+ </div>
343
+ <aside class="tsd-sources">
344
+ <ul>
345
+ <li>
346
+ Defined in
347
+ <a
348
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Lifecycle.ts#L39"
349
+ >messages/Lifecycle.ts:39</a
350
+ >
351
+ </li>
352
+ </ul>
353
+ </aside>
354
+ </section>
355
+ </section>
356
+ </details>
357
+ </div>
358
+ <div class="col-sidebar">
359
+ <div class="page-menu">
360
+ <div class="tsd-navigation settings">
361
+ <details class="tsd-accordion">
362
+ <summary class="tsd-accordion-summary">
363
+ <svg
364
+ width="20"
365
+ height="20"
366
+ viewBox="0 0 24 24"
367
+ fill="none"
368
+ aria-hidden="true"
369
+ >
370
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
371
+ </svg>
372
+ <h3>Settings</h3>
373
+ </summary>
374
+ <div class="tsd-accordion-details">
375
+ <div class="tsd-filter-visibility">
376
+ <span class="settings-label">Member Visibility</span>
377
+ <ul id="tsd-filter-options">
378
+ <li class="tsd-filter-item">
379
+ <label class="tsd-filter-input"
380
+ ><input
381
+ type="checkbox"
382
+ id="tsd-filter-inherited"
383
+ name="inherited"
384
+ checked
385
+ /><svg
386
+ width="32"
387
+ height="32"
388
+ viewBox="0 0 32 32"
389
+ aria-hidden="true"
390
+ >
391
+ <rect
392
+ class="tsd-checkbox-background"
393
+ width="30"
394
+ height="30"
395
+ x="1"
396
+ y="1"
397
+ rx="6"
398
+ fill="none"
399
+ ></rect>
400
+ <path
401
+ class="tsd-checkbox-checkmark"
402
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
403
+ stroke="none"
404
+ stroke-width="3.5"
405
+ stroke-linejoin="round"
406
+ fill="none"
407
+ ></path></svg
408
+ ><span>Inherited</span></label
409
+ >
410
+ </li>
411
+ </ul>
412
+ </div>
413
+ <div class="tsd-theme-toggle">
414
+ <label class="settings-label" for="tsd-theme">Theme</label
415
+ ><select id="tsd-theme">
416
+ <option value="os">OS</option>
417
+ <option value="light">Light</option>
418
+ <option value="dark">Dark</option>
419
+ </select>
420
+ </div>
421
+ </div>
422
+ </details>
423
+ </div>
424
+ <details open class="tsd-accordion tsd-page-navigation">
425
+ <summary class="tsd-accordion-summary">
426
+ <svg
427
+ width="20"
428
+ height="20"
429
+ viewBox="0 0 24 24"
430
+ fill="none"
431
+ aria-hidden="true"
432
+ >
433
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
434
+ </svg>
435
+ <h3>On This Page</h3>
436
+ </summary>
437
+ <div class="tsd-accordion-details">
438
+ <details open class="tsd-accordion tsd-page-navigation-section">
439
+ <summary
440
+ class="tsd-accordion-summary"
441
+ data-key="section-Properties"
442
+ >
443
+ <svg
444
+ width="20"
445
+ height="20"
446
+ viewBox="0 0 24 24"
447
+ fill="none"
448
+ aria-hidden="true"
449
+ >
450
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
451
+ >Properties
452
+ </summary>
453
+ <div>
454
+ <a href="#custom"
455
+ ><svg
456
+ class="tsd-kind-icon"
457
+ viewBox="0 0 24 24"
458
+ aria-label="Property"
459
+ >
460
+ <use href="../assets/icons.svg#icon-1024"></use></svg
461
+ ><span>custom</span></a
462
+ ><a href="#hostrooturl"
463
+ ><svg
464
+ class="tsd-kind-icon"
465
+ viewBox="0 0 24 24"
466
+ aria-label="Property"
467
+ >
468
+ <use href="../assets/icons.svg#icon-1024"></use></svg
469
+ ><span>host<wbr />Root<wbr />Url</span></a
470
+ ><a href="#locale"
471
+ ><svg
472
+ class="tsd-kind-icon"
473
+ viewBox="0 0 24 24"
474
+ aria-label="Property"
475
+ >
476
+ <use href="../assets/icons.svg#icon-1024"></use></svg
477
+ ><span>locale</span></a
478
+ ><a href="#registeredkeys"
479
+ ><svg
480
+ class="tsd-kind-icon"
481
+ viewBox="0 0 24 24"
482
+ aria-label="Property"
483
+ >
484
+ <use href="../assets/icons.svg#icon-1024"></use></svg
485
+ ><span>registered<wbr />Keys</span></a
486
+ >
487
+ </div>
488
+ </details>
489
+ </div>
490
+ </details>
491
+ </div>
492
+ <div class="site-menu">
493
+ <nav class="tsd-navigation">
494
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
495
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
496
+ <li>Loading...</li>
497
+ </ul>
498
+ </nav>
499
+ </div>
500
+ </div>
501
+ </div>
502
+ <footer>
503
+ <p class="tsd-generator">
504
+ Generated using
505
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
506
+ </p>
507
+ </footer>
508
+ <div class="overlay"></div>
509
+ </body>
510
+ </html>