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,4 +1,211 @@
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>RoutingMap | 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/host.html">host</a></li><li><a href="" aria-current="page">RoutingMap</a></li></ul><h1>Interface RoutingMap</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A map from client identifiers to configuration describing
2
- where the client app is hosted, and what routes should be
3
- directed to it.</p>
4
- </div></section><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><ul class="tsd-signatures"><li class="tsd-index-signature"><div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="host.ClientRegistration.html" class="tsd-signature-type tsd-kind-interface">ClientRegistration</a></div></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/HostRouter.ts#L78">HostRouter.ts:78</a></li></ul></aside></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></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>RoutingMap | iframe-coordinator - v6.5.1</title>
7
+ <meta name="description" content="Documentation for iframe-coordinator" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ window.app
24
+ ? app.showPage()
25
+ : document.body.style.removeProperty("display"),
26
+ 500,
27
+ );
28
+ </script>
29
+ <header class="tsd-page-toolbar">
30
+ <div class="tsd-toolbar-contents container">
31
+ <a href="../index.html" class="title">iframe-coordinator - v6.5.1</a>
32
+ <div id="tsd-toolbar-links"></div>
33
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
34
+ <svg
35
+ width="16"
36
+ height="16"
37
+ viewBox="0 0 16 16"
38
+ fill="none"
39
+ aria-hidden="true"
40
+ >
41
+ <use href="../assets/icons.svg#icon-search"></use>
42
+ </svg>
43
+ </button>
44
+ <dialog id="tsd-search" aria-label="Search">
45
+ <input
46
+ role="combobox"
47
+ id="tsd-search-input"
48
+ aria-controls="tsd-search-results"
49
+ aria-autocomplete="list"
50
+ aria-expanded="true"
51
+ autocapitalize="off"
52
+ autocomplete="off"
53
+ placeholder="Search the docs"
54
+ maxlength="100"
55
+ />
56
+ <ul role="listbox" id="tsd-search-results"></ul>
57
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
58
+ <div>Preparing search index...</div>
59
+ </div>
60
+ </dialog>
61
+ <a
62
+ href="#"
63
+ class="tsd-widget menu"
64
+ id="tsd-toolbar-menu-trigger"
65
+ data-toggle="menu"
66
+ aria-label="Menu"
67
+ ><svg
68
+ width="16"
69
+ height="16"
70
+ viewBox="0 0 16 16"
71
+ fill="none"
72
+ aria-hidden="true"
73
+ >
74
+ <use href="../assets/icons.svg#icon-menu"></use></svg
75
+ ></a>
76
+ </div>
77
+ </header>
78
+ <div class="container container-main">
79
+ <div class="col-content">
80
+ <div class="tsd-page-title">
81
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
82
+ <li><a href="../modules/host.html">host</a></li>
83
+ <li><a href="" aria-current="page">RoutingMap</a></li>
84
+ </ul>
85
+ <h1>Interface RoutingMap</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ A map from client identifiers to configuration describing where
91
+ the client app is hosted, and what routes should be directed to
92
+ it.
93
+ </p>
94
+ </div>
95
+ </section>
96
+ <section class="tsd-panel">
97
+ <h4 class="tsd-before-signature">Indexable</h4>
98
+ <ul class="tsd-signatures">
99
+ <li class="tsd-index-signature">
100
+ <div class="tsd-signature">
101
+ <span class="tsd-signature-symbol">[</span
102
+ ><span class="tsd-kind-parameter">key</span>:
103
+ <span class="tsd-signature-type">string</span
104
+ ><span class="tsd-signature-symbol">]:</span>
105
+ <a
106
+ href="host.ClientRegistration.html"
107
+ class="tsd-signature-type tsd-kind-interface"
108
+ >ClientRegistration</a
109
+ >
110
+ </div>
111
+ </li>
112
+ </ul>
113
+ </section>
114
+ <aside class="tsd-sources">
115
+ <ul>
116
+ <li>
117
+ Defined in
118
+ <a
119
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L78"
120
+ >HostRouter.ts:78</a
121
+ >
122
+ </li>
123
+ </ul>
124
+ </aside>
125
+ </div>
126
+ <div class="col-sidebar">
127
+ <div class="page-menu">
128
+ <div class="tsd-navigation settings">
129
+ <details class="tsd-accordion">
130
+ <summary class="tsd-accordion-summary">
131
+ <svg
132
+ width="20"
133
+ height="20"
134
+ viewBox="0 0 24 24"
135
+ fill="none"
136
+ aria-hidden="true"
137
+ >
138
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
139
+ </svg>
140
+ <h3>Settings</h3>
141
+ </summary>
142
+ <div class="tsd-accordion-details">
143
+ <div class="tsd-filter-visibility">
144
+ <span class="settings-label">Member Visibility</span>
145
+ <ul id="tsd-filter-options">
146
+ <li class="tsd-filter-item">
147
+ <label class="tsd-filter-input"
148
+ ><input
149
+ type="checkbox"
150
+ id="tsd-filter-inherited"
151
+ name="inherited"
152
+ checked
153
+ /><svg
154
+ width="32"
155
+ height="32"
156
+ viewBox="0 0 32 32"
157
+ aria-hidden="true"
158
+ >
159
+ <rect
160
+ class="tsd-checkbox-background"
161
+ width="30"
162
+ height="30"
163
+ x="1"
164
+ y="1"
165
+ rx="6"
166
+ fill="none"
167
+ ></rect>
168
+ <path
169
+ class="tsd-checkbox-checkmark"
170
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
171
+ stroke="none"
172
+ stroke-width="3.5"
173
+ stroke-linejoin="round"
174
+ fill="none"
175
+ ></path></svg
176
+ ><span>Inherited</span></label
177
+ >
178
+ </li>
179
+ </ul>
180
+ </div>
181
+ <div class="tsd-theme-toggle">
182
+ <label class="settings-label" for="tsd-theme">Theme</label
183
+ ><select id="tsd-theme">
184
+ <option value="os">OS</option>
185
+ <option value="light">Light</option>
186
+ <option value="dark">Dark</option>
187
+ </select>
188
+ </div>
189
+ </div>
190
+ </details>
191
+ </div>
192
+ </div>
193
+ <div class="site-menu">
194
+ <nav class="tsd-navigation">
195
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
196
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
197
+ <li>Loading...</li>
198
+ </ul>
199
+ </nav>
200
+ </div>
201
+ </div>
202
+ </div>
203
+ <footer>
204
+ <p class="tsd-generator">
205
+ Generated using
206
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
207
+ </p>
208
+ </footer>
209
+ <div class="overlay"></div>
210
+ </body>
211
+ </html>
@@ -1,6 +1,388 @@
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>WorkerAppData | 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/host.html">host</a></li><li><a href="" aria-current="page">WorkerAppData</a></li></ul><h1>Interface WorkerAppData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Worker-associated application data</p>
2
- </div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">WorkerAppData</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#assignedroute">assignedRoute</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="#url">url</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/WorkerPool.ts#L37">WorkerPool.ts:37</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="#assignedroute" 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>assigned<wbr/>Route</span></a>
3
- <a href="#url" 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>url</span></a>
4
- </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="assignedroute"><span>assigned<wbr/>Route</span><a href="#assignedroute" 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">assignedRoute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The route the application is assigned to in the <a href="../classes/host.FrameRouterElement.html" class="tsd-kind-class">FrameRouterElement</a>'s <a href="host.ClientConfig.html" class="tsd-kind-interface">ClientConfig</a></p>
5
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L41">WorkerPool.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="url"><span>url</span><a href="#url" 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">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The URL of the associated app</p>
6
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L39">WorkerPool.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="#assignedroute"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>assigned<wbr/>Route</span></a><a href="#url"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</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>WorkerAppData | iframe-coordinator - v6.5.1</title>
7
+ <meta name="description" content="Documentation for iframe-coordinator" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ window.app
24
+ ? app.showPage()
25
+ : document.body.style.removeProperty("display"),
26
+ 500,
27
+ );
28
+ </script>
29
+ <header class="tsd-page-toolbar">
30
+ <div class="tsd-toolbar-contents container">
31
+ <a href="../index.html" class="title">iframe-coordinator - v6.5.1</a>
32
+ <div id="tsd-toolbar-links"></div>
33
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
34
+ <svg
35
+ width="16"
36
+ height="16"
37
+ viewBox="0 0 16 16"
38
+ fill="none"
39
+ aria-hidden="true"
40
+ >
41
+ <use href="../assets/icons.svg#icon-search"></use>
42
+ </svg>
43
+ </button>
44
+ <dialog id="tsd-search" aria-label="Search">
45
+ <input
46
+ role="combobox"
47
+ id="tsd-search-input"
48
+ aria-controls="tsd-search-results"
49
+ aria-autocomplete="list"
50
+ aria-expanded="true"
51
+ autocapitalize="off"
52
+ autocomplete="off"
53
+ placeholder="Search the docs"
54
+ maxlength="100"
55
+ />
56
+ <ul role="listbox" id="tsd-search-results"></ul>
57
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
58
+ <div>Preparing search index...</div>
59
+ </div>
60
+ </dialog>
61
+ <a
62
+ href="#"
63
+ class="tsd-widget menu"
64
+ id="tsd-toolbar-menu-trigger"
65
+ data-toggle="menu"
66
+ aria-label="Menu"
67
+ ><svg
68
+ width="16"
69
+ height="16"
70
+ viewBox="0 0 16 16"
71
+ fill="none"
72
+ aria-hidden="true"
73
+ >
74
+ <use href="../assets/icons.svg#icon-menu"></use></svg
75
+ ></a>
76
+ </div>
77
+ </header>
78
+ <div class="container container-main">
79
+ <div class="col-content">
80
+ <div class="tsd-page-title">
81
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
82
+ <li><a href="../modules/host.html">host</a></li>
83
+ <li><a href="" aria-current="page">WorkerAppData</a></li>
84
+ </ul>
85
+ <h1>Interface WorkerAppData</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>Worker-associated application data</p>
90
+ </div>
91
+ </section>
92
+ <div class="tsd-signature">
93
+ <span class="tsd-signature-keyword">interface</span>
94
+ <span class="tsd-kind-interface">WorkerAppData</span>
95
+ <span class="tsd-signature-symbol">{</span><br />    <a
96
+ class="tsd-kind-property"
97
+ href="#assignedroute"
98
+ >assignedRoute</a
99
+ ><span class="tsd-signature-symbol">:</span>
100
+ <span class="tsd-signature-type">string</span
101
+ ><span class="tsd-signature-symbol">;</span><br />    <a
102
+ class="tsd-kind-property"
103
+ href="#url"
104
+ >url</a
105
+ ><span class="tsd-signature-symbol">:</span>
106
+ <span class="tsd-signature-type">string</span
107
+ ><span class="tsd-signature-symbol">;</span><br /><span
108
+ class="tsd-signature-symbol"
109
+ >}</span
110
+ >
111
+ </div>
112
+ <aside class="tsd-sources">
113
+ <ul>
114
+ <li>
115
+ Defined in
116
+ <a
117
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L37"
118
+ >WorkerPool.ts:37</a
119
+ >
120
+ </li>
121
+ </ul>
122
+ </aside>
123
+ <section class="tsd-panel-group tsd-index-group">
124
+ <section class="tsd-panel tsd-index-panel">
125
+ <details class="tsd-index-content tsd-accordion" open>
126
+ <summary class="tsd-accordion-summary tsd-index-summary">
127
+ <svg
128
+ width="20"
129
+ height="20"
130
+ viewBox="0 0 24 24"
131
+ fill="none"
132
+ aria-hidden="true"
133
+ >
134
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
135
+ </svg>
136
+ <h5 class="tsd-index-heading uppercase">Index</h5>
137
+ </summary>
138
+ <div class="tsd-accordion-details">
139
+ <section class="tsd-index-section">
140
+ <h3 class="tsd-index-heading">Properties</h3>
141
+ <div class="tsd-index-list">
142
+ <a href="#assignedroute" class="tsd-index-link"
143
+ ><svg
144
+ class="tsd-kind-icon"
145
+ viewBox="0 0 24 24"
146
+ aria-label="Property"
147
+ >
148
+ <use href="../assets/icons.svg#icon-1024"></use></svg
149
+ ><span>assigned<wbr />Route</span></a
150
+ >
151
+ <a href="#url" class="tsd-index-link"
152
+ ><svg
153
+ class="tsd-kind-icon"
154
+ viewBox="0 0 24 24"
155
+ aria-label="Property"
156
+ >
157
+ <use href="../assets/icons.svg#icon-1024"></use></svg
158
+ ><span>url</span></a
159
+ >
160
+ </div>
161
+ </section>
162
+ </div>
163
+ </details>
164
+ </section>
165
+ </section>
166
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
167
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
168
+ <svg
169
+ width="20"
170
+ height="20"
171
+ viewBox="0 0 24 24"
172
+ fill="none"
173
+ aria-hidden="true"
174
+ >
175
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
176
+ </svg>
177
+ <h2>Properties</h2>
178
+ </summary>
179
+ <section>
180
+ <section class="tsd-panel tsd-member">
181
+ <h3 class="tsd-anchor-link" id="assignedroute">
182
+ <span>assigned<wbr />Route</span
183
+ ><a
184
+ href="#assignedroute"
185
+ aria-label="Permalink"
186
+ class="tsd-anchor-icon"
187
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
188
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
189
+ ></a>
190
+ </h3>
191
+ <div class="tsd-signature">
192
+ <span class="tsd-kind-property">assignedRoute</span
193
+ ><span class="tsd-signature-symbol">:</span>
194
+ <span class="tsd-signature-type">string</span>
195
+ </div>
196
+ <div class="tsd-comment tsd-typography">
197
+ <p>
198
+ The route the application is assigned to in the
199
+ <a
200
+ href="../classes/host.FrameRouterElement.html"
201
+ class="tsd-kind-class"
202
+ >FrameRouterElement</a
203
+ >'s
204
+ <a href="host.ClientConfig.html" class="tsd-kind-interface"
205
+ >ClientConfig</a
206
+ >
207
+ </p>
208
+ </div>
209
+ <aside class="tsd-sources">
210
+ <ul>
211
+ <li>
212
+ Defined in
213
+ <a
214
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L41"
215
+ >WorkerPool.ts:41</a
216
+ >
217
+ </li>
218
+ </ul>
219
+ </aside>
220
+ </section>
221
+ <section class="tsd-panel tsd-member">
222
+ <h3 class="tsd-anchor-link" id="url">
223
+ <span>url</span
224
+ ><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"
225
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
226
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
227
+ ></a>
228
+ </h3>
229
+ <div class="tsd-signature">
230
+ <span class="tsd-kind-property">url</span
231
+ ><span class="tsd-signature-symbol">:</span>
232
+ <span class="tsd-signature-type">string</span>
233
+ </div>
234
+ <div class="tsd-comment tsd-typography">
235
+ <p>The URL of the associated app</p>
236
+ </div>
237
+ <aside class="tsd-sources">
238
+ <ul>
239
+ <li>
240
+ Defined in
241
+ <a
242
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L39"
243
+ >WorkerPool.ts:39</a
244
+ >
245
+ </li>
246
+ </ul>
247
+ </aside>
248
+ </section>
249
+ </section>
250
+ </details>
251
+ </div>
252
+ <div class="col-sidebar">
253
+ <div class="page-menu">
254
+ <div class="tsd-navigation settings">
255
+ <details class="tsd-accordion">
256
+ <summary class="tsd-accordion-summary">
257
+ <svg
258
+ width="20"
259
+ height="20"
260
+ viewBox="0 0 24 24"
261
+ fill="none"
262
+ aria-hidden="true"
263
+ >
264
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
265
+ </svg>
266
+ <h3>Settings</h3>
267
+ </summary>
268
+ <div class="tsd-accordion-details">
269
+ <div class="tsd-filter-visibility">
270
+ <span class="settings-label">Member Visibility</span>
271
+ <ul id="tsd-filter-options">
272
+ <li class="tsd-filter-item">
273
+ <label class="tsd-filter-input"
274
+ ><input
275
+ type="checkbox"
276
+ id="tsd-filter-inherited"
277
+ name="inherited"
278
+ checked
279
+ /><svg
280
+ width="32"
281
+ height="32"
282
+ viewBox="0 0 32 32"
283
+ aria-hidden="true"
284
+ >
285
+ <rect
286
+ class="tsd-checkbox-background"
287
+ width="30"
288
+ height="30"
289
+ x="1"
290
+ y="1"
291
+ rx="6"
292
+ fill="none"
293
+ ></rect>
294
+ <path
295
+ class="tsd-checkbox-checkmark"
296
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
297
+ stroke="none"
298
+ stroke-width="3.5"
299
+ stroke-linejoin="round"
300
+ fill="none"
301
+ ></path></svg
302
+ ><span>Inherited</span></label
303
+ >
304
+ </li>
305
+ </ul>
306
+ </div>
307
+ <div class="tsd-theme-toggle">
308
+ <label class="settings-label" for="tsd-theme">Theme</label
309
+ ><select id="tsd-theme">
310
+ <option value="os">OS</option>
311
+ <option value="light">Light</option>
312
+ <option value="dark">Dark</option>
313
+ </select>
314
+ </div>
315
+ </div>
316
+ </details>
317
+ </div>
318
+ <details open class="tsd-accordion tsd-page-navigation">
319
+ <summary class="tsd-accordion-summary">
320
+ <svg
321
+ width="20"
322
+ height="20"
323
+ viewBox="0 0 24 24"
324
+ fill="none"
325
+ aria-hidden="true"
326
+ >
327
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
328
+ </svg>
329
+ <h3>On This Page</h3>
330
+ </summary>
331
+ <div class="tsd-accordion-details">
332
+ <details open class="tsd-accordion tsd-page-navigation-section">
333
+ <summary
334
+ class="tsd-accordion-summary"
335
+ data-key="section-Properties"
336
+ >
337
+ <svg
338
+ width="20"
339
+ height="20"
340
+ viewBox="0 0 24 24"
341
+ fill="none"
342
+ aria-hidden="true"
343
+ >
344
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
345
+ >Properties
346
+ </summary>
347
+ <div>
348
+ <a href="#assignedroute"
349
+ ><svg
350
+ class="tsd-kind-icon"
351
+ viewBox="0 0 24 24"
352
+ aria-label="Property"
353
+ >
354
+ <use href="../assets/icons.svg#icon-1024"></use></svg
355
+ ><span>assigned<wbr />Route</span></a
356
+ ><a href="#url"
357
+ ><svg
358
+ class="tsd-kind-icon"
359
+ viewBox="0 0 24 24"
360
+ aria-label="Property"
361
+ >
362
+ <use href="../assets/icons.svg#icon-1024"></use></svg
363
+ ><span>url</span></a
364
+ >
365
+ </div>
366
+ </details>
367
+ </div>
368
+ </details>
369
+ </div>
370
+ <div class="site-menu">
371
+ <nav class="tsd-navigation">
372
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
373
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
374
+ <li>Loading...</li>
375
+ </ul>
376
+ </nav>
377
+ </div>
378
+ </div>
379
+ </div>
380
+ <footer>
381
+ <p class="tsd-generator">
382
+ Generated using
383
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
384
+ </p>
385
+ </footer>
386
+ <div class="overlay"></div>
387
+ </body>
388
+ </html>