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.
- package/dist/assets/{index-DkVijnku.js → index-DejhDHus.js} +3 -3
- package/dist/ifc-docs/assets/hierarchy.js +1 -1
- package/dist/ifc-docs/assets/highlight.css +130 -91
- package/dist/ifc-docs/assets/icons.js +20 -17
- package/dist/ifc-docs/assets/icons.svg +1 -1
- package/dist/ifc-docs/assets/main.js +2535 -5
- package/dist/ifc-docs/assets/navigation.js +2 -1
- package/dist/ifc-docs/assets/search.js +2 -1
- package/dist/ifc-docs/assets/style.css +1571 -1581
- package/dist/ifc-docs/classes/client.Client.html +2388 -98
- package/dist/ifc-docs/classes/client.WorkerClient.html +2161 -92
- package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
- package/dist/ifc-docs/classes/host.WorkerPool.html +879 -29
- package/dist/ifc-docs/documents/client-setup.html +579 -75
- package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
- package/dist/ifc-docs/hierarchy.html +168 -1
- package/dist/ifc-docs/index.html +432 -31
- package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
- package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -14
- package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
- package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
- package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
- package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -6
- package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -7
- package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -6
- package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -2
- package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -6
- package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -11
- package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -12
- package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -6
- package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -9
- package/dist/ifc-docs/interfaces/messages.Notification.html +435 -9
- package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -8
- package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -9
- package/dist/ifc-docs/interfaces/messages.Publication.html +443 -11
- package/dist/ifc-docs/modules/client.html +742 -2
- package/dist/ifc-docs/modules/host.html +647 -1
- package/dist/ifc-docs/modules/messages.html +462 -1
- package/dist/ifc-docs/modules.html +359 -1
- package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -1
- package/dist/ifc-docs/types/client.EventHandler.html +247 -2
- package/dist/index.html +1 -1
- package/package.json +3 -3
|
@@ -1,9 +1,390 @@
|
|
|
1
|
-
<!
|
|
2
|
-
|
|
3
|
-
<
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
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>NavRequest | 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">NavRequest</a></li>
|
|
84
|
+
</ul>
|
|
85
|
+
<h1>Interface NavRequest</h1>
|
|
86
|
+
</div>
|
|
87
|
+
<section class="tsd-panel tsd-comment">
|
|
88
|
+
<div class="tsd-comment tsd-typography">
|
|
89
|
+
<p>The navigation request 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">NavRequest</span>
|
|
95
|
+
<span class="tsd-signature-symbol">{</span><br /> <a
|
|
96
|
+
class="tsd-kind-property"
|
|
97
|
+
href="#history"
|
|
98
|
+
>history</a
|
|
99
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
100
|
+
<span class="tsd-signature-type">"push"</span>
|
|
101
|
+
<span class="tsd-signature-symbol">|</span>
|
|
102
|
+
<span class="tsd-signature-type">"replace"</span
|
|
103
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
104
|
+
class="tsd-kind-property"
|
|
105
|
+
href="#url"
|
|
106
|
+
>url</a
|
|
107
|
+
><span class="tsd-signature-symbol">:</span>
|
|
108
|
+
<span class="tsd-signature-type">string</span
|
|
109
|
+
><span class="tsd-signature-symbol">;</span><br /><span
|
|
110
|
+
class="tsd-signature-symbol"
|
|
111
|
+
>}</span
|
|
112
|
+
>
|
|
113
|
+
</div>
|
|
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/messages/NavRequest.ts#L7"
|
|
120
|
+
>messages/NavRequest.ts:7</a
|
|
121
|
+
>
|
|
122
|
+
</li>
|
|
123
|
+
</ul>
|
|
124
|
+
</aside>
|
|
125
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
126
|
+
<section class="tsd-panel tsd-index-panel">
|
|
127
|
+
<details class="tsd-index-content tsd-accordion" open>
|
|
128
|
+
<summary class="tsd-accordion-summary tsd-index-summary">
|
|
129
|
+
<svg
|
|
130
|
+
width="20"
|
|
131
|
+
height="20"
|
|
132
|
+
viewBox="0 0 24 24"
|
|
133
|
+
fill="none"
|
|
134
|
+
aria-hidden="true"
|
|
135
|
+
>
|
|
136
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
137
|
+
</svg>
|
|
138
|
+
<h5 class="tsd-index-heading uppercase">Index</h5>
|
|
139
|
+
</summary>
|
|
140
|
+
<div class="tsd-accordion-details">
|
|
141
|
+
<section class="tsd-index-section">
|
|
142
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
|
143
|
+
<div class="tsd-index-list">
|
|
144
|
+
<a href="#history" class="tsd-index-link"
|
|
145
|
+
><svg
|
|
146
|
+
class="tsd-kind-icon"
|
|
147
|
+
viewBox="0 0 24 24"
|
|
148
|
+
aria-label="Property"
|
|
149
|
+
>
|
|
150
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
151
|
+
><span>history?</span></a
|
|
152
|
+
>
|
|
153
|
+
<a href="#url" class="tsd-index-link"
|
|
154
|
+
><svg
|
|
155
|
+
class="tsd-kind-icon"
|
|
156
|
+
viewBox="0 0 24 24"
|
|
157
|
+
aria-label="Property"
|
|
158
|
+
>
|
|
159
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
160
|
+
><span>url</span></a
|
|
161
|
+
>
|
|
162
|
+
</div>
|
|
163
|
+
</section>
|
|
164
|
+
</div>
|
|
165
|
+
</details>
|
|
166
|
+
</section>
|
|
167
|
+
</section>
|
|
168
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open>
|
|
169
|
+
<summary class="tsd-accordion-summary" data-key="section-Properties">
|
|
170
|
+
<svg
|
|
171
|
+
width="20"
|
|
172
|
+
height="20"
|
|
173
|
+
viewBox="0 0 24 24"
|
|
174
|
+
fill="none"
|
|
175
|
+
aria-hidden="true"
|
|
176
|
+
>
|
|
177
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
178
|
+
</svg>
|
|
179
|
+
<h2>Properties</h2>
|
|
180
|
+
</summary>
|
|
181
|
+
<section>
|
|
182
|
+
<section class="tsd-panel tsd-member">
|
|
183
|
+
<h3 class="tsd-anchor-link" id="history">
|
|
184
|
+
<code class="tsd-tag">Optional</code><span>history</span
|
|
185
|
+
><a
|
|
186
|
+
href="#history"
|
|
187
|
+
aria-label="Permalink"
|
|
188
|
+
class="tsd-anchor-icon"
|
|
189
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
190
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
191
|
+
></a>
|
|
192
|
+
</h3>
|
|
193
|
+
<div class="tsd-signature">
|
|
194
|
+
<span class="tsd-kind-property">history</span
|
|
195
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
196
|
+
<span class="tsd-signature-type">"push"</span>
|
|
197
|
+
<span class="tsd-signature-symbol">|</span>
|
|
198
|
+
<span class="tsd-signature-type">"replace"</span>
|
|
199
|
+
</div>
|
|
200
|
+
<div class="tsd-comment tsd-typography">
|
|
201
|
+
<p>
|
|
202
|
+
How the client wants the host to update the browser's session
|
|
203
|
+
history. Push is the default behavior (adds a new session
|
|
204
|
+
history entry). Replace alters the current entry so that using
|
|
205
|
+
the back button after navigation will skip the location you
|
|
206
|
+
are navigating from.
|
|
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/messages/NavRequest.ts#L15"
|
|
215
|
+
>messages/NavRequest.ts:15</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>
|
|
236
|
+
The URL the client wants the host application to navigate to
|
|
237
|
+
</p>
|
|
238
|
+
</div>
|
|
239
|
+
<aside class="tsd-sources">
|
|
240
|
+
<ul>
|
|
241
|
+
<li>
|
|
242
|
+
Defined in
|
|
243
|
+
<a
|
|
244
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/NavRequest.ts#L9"
|
|
245
|
+
>messages/NavRequest.ts:9</a
|
|
246
|
+
>
|
|
247
|
+
</li>
|
|
248
|
+
</ul>
|
|
249
|
+
</aside>
|
|
250
|
+
</section>
|
|
251
|
+
</section>
|
|
252
|
+
</details>
|
|
253
|
+
</div>
|
|
254
|
+
<div class="col-sidebar">
|
|
255
|
+
<div class="page-menu">
|
|
256
|
+
<div class="tsd-navigation settings">
|
|
257
|
+
<details class="tsd-accordion">
|
|
258
|
+
<summary class="tsd-accordion-summary">
|
|
259
|
+
<svg
|
|
260
|
+
width="20"
|
|
261
|
+
height="20"
|
|
262
|
+
viewBox="0 0 24 24"
|
|
263
|
+
fill="none"
|
|
264
|
+
aria-hidden="true"
|
|
265
|
+
>
|
|
266
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
267
|
+
</svg>
|
|
268
|
+
<h3>Settings</h3>
|
|
269
|
+
</summary>
|
|
270
|
+
<div class="tsd-accordion-details">
|
|
271
|
+
<div class="tsd-filter-visibility">
|
|
272
|
+
<span class="settings-label">Member Visibility</span>
|
|
273
|
+
<ul id="tsd-filter-options">
|
|
274
|
+
<li class="tsd-filter-item">
|
|
275
|
+
<label class="tsd-filter-input"
|
|
276
|
+
><input
|
|
277
|
+
type="checkbox"
|
|
278
|
+
id="tsd-filter-inherited"
|
|
279
|
+
name="inherited"
|
|
280
|
+
checked
|
|
281
|
+
/><svg
|
|
282
|
+
width="32"
|
|
283
|
+
height="32"
|
|
284
|
+
viewBox="0 0 32 32"
|
|
285
|
+
aria-hidden="true"
|
|
286
|
+
>
|
|
287
|
+
<rect
|
|
288
|
+
class="tsd-checkbox-background"
|
|
289
|
+
width="30"
|
|
290
|
+
height="30"
|
|
291
|
+
x="1"
|
|
292
|
+
y="1"
|
|
293
|
+
rx="6"
|
|
294
|
+
fill="none"
|
|
295
|
+
></rect>
|
|
296
|
+
<path
|
|
297
|
+
class="tsd-checkbox-checkmark"
|
|
298
|
+
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
|
|
299
|
+
stroke="none"
|
|
300
|
+
stroke-width="3.5"
|
|
301
|
+
stroke-linejoin="round"
|
|
302
|
+
fill="none"
|
|
303
|
+
></path></svg
|
|
304
|
+
><span>Inherited</span></label
|
|
305
|
+
>
|
|
306
|
+
</li>
|
|
307
|
+
</ul>
|
|
308
|
+
</div>
|
|
309
|
+
<div class="tsd-theme-toggle">
|
|
310
|
+
<label class="settings-label" for="tsd-theme">Theme</label
|
|
311
|
+
><select id="tsd-theme">
|
|
312
|
+
<option value="os">OS</option>
|
|
313
|
+
<option value="light">Light</option>
|
|
314
|
+
<option value="dark">Dark</option>
|
|
315
|
+
</select>
|
|
316
|
+
</div>
|
|
317
|
+
</div>
|
|
318
|
+
</details>
|
|
319
|
+
</div>
|
|
320
|
+
<details open class="tsd-accordion tsd-page-navigation">
|
|
321
|
+
<summary class="tsd-accordion-summary">
|
|
322
|
+
<svg
|
|
323
|
+
width="20"
|
|
324
|
+
height="20"
|
|
325
|
+
viewBox="0 0 24 24"
|
|
326
|
+
fill="none"
|
|
327
|
+
aria-hidden="true"
|
|
328
|
+
>
|
|
329
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
330
|
+
</svg>
|
|
331
|
+
<h3>On This Page</h3>
|
|
332
|
+
</summary>
|
|
333
|
+
<div class="tsd-accordion-details">
|
|
334
|
+
<details open class="tsd-accordion tsd-page-navigation-section">
|
|
335
|
+
<summary
|
|
336
|
+
class="tsd-accordion-summary"
|
|
337
|
+
data-key="section-Properties"
|
|
338
|
+
>
|
|
339
|
+
<svg
|
|
340
|
+
width="20"
|
|
341
|
+
height="20"
|
|
342
|
+
viewBox="0 0 24 24"
|
|
343
|
+
fill="none"
|
|
344
|
+
aria-hidden="true"
|
|
345
|
+
>
|
|
346
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use></svg
|
|
347
|
+
>Properties
|
|
348
|
+
</summary>
|
|
349
|
+
<div>
|
|
350
|
+
<a href="#history"
|
|
351
|
+
><svg
|
|
352
|
+
class="tsd-kind-icon"
|
|
353
|
+
viewBox="0 0 24 24"
|
|
354
|
+
aria-label="Property"
|
|
355
|
+
>
|
|
356
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
357
|
+
><span>history</span></a
|
|
358
|
+
><a href="#url"
|
|
359
|
+
><svg
|
|
360
|
+
class="tsd-kind-icon"
|
|
361
|
+
viewBox="0 0 24 24"
|
|
362
|
+
aria-label="Property"
|
|
363
|
+
>
|
|
364
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
365
|
+
><span>url</span></a
|
|
366
|
+
>
|
|
367
|
+
</div>
|
|
368
|
+
</details>
|
|
369
|
+
</div>
|
|
370
|
+
</details>
|
|
371
|
+
</div>
|
|
372
|
+
<div class="site-menu">
|
|
373
|
+
<nav class="tsd-navigation">
|
|
374
|
+
<a href="../modules.html">iframe-coordinator - v6.5.1</a>
|
|
375
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
376
|
+
<li>Loading...</li>
|
|
377
|
+
</ul>
|
|
378
|
+
</nav>
|
|
379
|
+
</div>
|
|
380
|
+
</div>
|
|
381
|
+
</div>
|
|
382
|
+
<footer>
|
|
383
|
+
<p class="tsd-generator">
|
|
384
|
+
Generated using
|
|
385
|
+
<a href="https://typedoc.org/" target="_blank">TypeDoc</a>
|
|
386
|
+
</p>
|
|
387
|
+
</footer>
|
|
388
|
+
<div class="overlay"></div>
|
|
389
|
+
</body>
|
|
390
|
+
</html>
|