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,24 +1,580 @@
|
|
|
1
|
-
<!
|
|
2
|
-
<
|
|
3
|
-
|
|
4
|
-
<
|
|
5
|
-
|
|
6
|
-
<
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
<
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
<
|
|
13
|
-
<
|
|
14
|
-
<
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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>ClientRegistration | 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">ClientRegistration</a></li>
|
|
84
|
+
</ul>
|
|
85
|
+
<h1>Interface ClientRegistration</h1>
|
|
86
|
+
</div>
|
|
87
|
+
<section class="tsd-panel tsd-comment">
|
|
88
|
+
<div class="tsd-comment tsd-typography">
|
|
89
|
+
<p>Configuration for a single <code>frame-router</code> client.</p>
|
|
90
|
+
<p>
|
|
91
|
+
The 'url' property is the location where the client application is
|
|
92
|
+
hosted. If the client uses fragment-based routing, the URL should
|
|
93
|
+
include a hash fragment, e.g.
|
|
94
|
+
<code>http://example.com/client/#/</code> if the client uses
|
|
95
|
+
pushState routing, leave the fragment out, e.g.
|
|
96
|
+
<code>http://example.com/client</code>.
|
|
97
|
+
</p>
|
|
98
|
+
<p>
|
|
99
|
+
The <code>assignedRoute</code> property is the prefix for all
|
|
100
|
+
routes that will be mapped to this client. This prefix will be
|
|
101
|
+
stripped when setting the route on the client. As an example, if
|
|
102
|
+
<code>assignedRoute</code> is <code>/foo/bar/</code>,
|
|
103
|
+
<code>url</code> is <code>https://example.com/client/#/</code> and
|
|
104
|
+
the <code>frame-router</code> element is passed the route
|
|
105
|
+
<code>/foo/bar/baz/qux</code>, the embedded iframe URL will be
|
|
106
|
+
<code>http://example.com/client/#/baz/qux</code>
|
|
107
|
+
</p>
|
|
108
|
+
</div>
|
|
109
|
+
</section>
|
|
110
|
+
<div class="tsd-signature">
|
|
111
|
+
<span class="tsd-signature-keyword">interface</span>
|
|
112
|
+
<span class="tsd-kind-interface">ClientRegistration</span>
|
|
113
|
+
<span class="tsd-signature-symbol">{</span><br /> <a
|
|
114
|
+
class="tsd-kind-property"
|
|
115
|
+
href="#allow"
|
|
116
|
+
>allow</a
|
|
117
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
118
|
+
<span class="tsd-signature-type">string</span
|
|
119
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
120
|
+
class="tsd-kind-property"
|
|
121
|
+
href="#assignedroute"
|
|
122
|
+
>assignedRoute</a
|
|
123
|
+
><span class="tsd-signature-symbol">:</span>
|
|
124
|
+
<span class="tsd-signature-type">string</span
|
|
125
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
126
|
+
class="tsd-kind-property"
|
|
127
|
+
href="#defaulttitle"
|
|
128
|
+
>defaultTitle</a
|
|
129
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
130
|
+
<span class="tsd-signature-type">string</span
|
|
131
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
132
|
+
class="tsd-kind-property"
|
|
133
|
+
href="#sandbox"
|
|
134
|
+
>sandbox</a
|
|
135
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
136
|
+
<span class="tsd-signature-type">string</span
|
|
137
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
138
|
+
class="tsd-kind-property"
|
|
139
|
+
href="#url"
|
|
140
|
+
>url</a
|
|
141
|
+
><span class="tsd-signature-symbol">:</span>
|
|
142
|
+
<span class="tsd-signature-type">string</span
|
|
143
|
+
><span class="tsd-signature-symbol">;</span><br /><span
|
|
144
|
+
class="tsd-signature-symbol"
|
|
145
|
+
>}</span
|
|
146
|
+
>
|
|
147
|
+
</div>
|
|
148
|
+
<aside class="tsd-sources">
|
|
149
|
+
<ul>
|
|
150
|
+
<li>
|
|
151
|
+
Defined in
|
|
152
|
+
<a
|
|
153
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L96"
|
|
154
|
+
>HostRouter.ts:96</a
|
|
155
|
+
>
|
|
156
|
+
</li>
|
|
157
|
+
</ul>
|
|
158
|
+
</aside>
|
|
159
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
160
|
+
<section class="tsd-panel tsd-index-panel">
|
|
161
|
+
<details class="tsd-index-content tsd-accordion" open>
|
|
162
|
+
<summary class="tsd-accordion-summary tsd-index-summary">
|
|
163
|
+
<svg
|
|
164
|
+
width="20"
|
|
165
|
+
height="20"
|
|
166
|
+
viewBox="0 0 24 24"
|
|
167
|
+
fill="none"
|
|
168
|
+
aria-hidden="true"
|
|
169
|
+
>
|
|
170
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
171
|
+
</svg>
|
|
172
|
+
<h5 class="tsd-index-heading uppercase">Index</h5>
|
|
173
|
+
</summary>
|
|
174
|
+
<div class="tsd-accordion-details">
|
|
175
|
+
<section class="tsd-index-section">
|
|
176
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
|
177
|
+
<div class="tsd-index-list">
|
|
178
|
+
<a href="#allow" class="tsd-index-link"
|
|
179
|
+
><svg
|
|
180
|
+
class="tsd-kind-icon"
|
|
181
|
+
viewBox="0 0 24 24"
|
|
182
|
+
aria-label="Property"
|
|
183
|
+
>
|
|
184
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
185
|
+
><span>allow?</span></a
|
|
186
|
+
>
|
|
187
|
+
<a href="#assignedroute" class="tsd-index-link"
|
|
188
|
+
><svg
|
|
189
|
+
class="tsd-kind-icon"
|
|
190
|
+
viewBox="0 0 24 24"
|
|
191
|
+
aria-label="Property"
|
|
192
|
+
>
|
|
193
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
194
|
+
><span>assigned<wbr />Route</span></a
|
|
195
|
+
>
|
|
196
|
+
<a href="#defaulttitle" class="tsd-index-link"
|
|
197
|
+
><svg
|
|
198
|
+
class="tsd-kind-icon"
|
|
199
|
+
viewBox="0 0 24 24"
|
|
200
|
+
aria-label="Property"
|
|
201
|
+
>
|
|
202
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
203
|
+
><span>default<wbr />Title?</span></a
|
|
204
|
+
>
|
|
205
|
+
<a href="#sandbox" class="tsd-index-link"
|
|
206
|
+
><svg
|
|
207
|
+
class="tsd-kind-icon"
|
|
208
|
+
viewBox="0 0 24 24"
|
|
209
|
+
aria-label="Property"
|
|
210
|
+
>
|
|
211
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
212
|
+
><span>sandbox?</span></a
|
|
213
|
+
>
|
|
214
|
+
<a href="#url" class="tsd-index-link"
|
|
215
|
+
><svg
|
|
216
|
+
class="tsd-kind-icon"
|
|
217
|
+
viewBox="0 0 24 24"
|
|
218
|
+
aria-label="Property"
|
|
219
|
+
>
|
|
220
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
221
|
+
><span>url</span></a
|
|
222
|
+
>
|
|
223
|
+
</div>
|
|
224
|
+
</section>
|
|
225
|
+
</div>
|
|
226
|
+
</details>
|
|
227
|
+
</section>
|
|
228
|
+
</section>
|
|
229
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open>
|
|
230
|
+
<summary class="tsd-accordion-summary" data-key="section-Properties">
|
|
231
|
+
<svg
|
|
232
|
+
width="20"
|
|
233
|
+
height="20"
|
|
234
|
+
viewBox="0 0 24 24"
|
|
235
|
+
fill="none"
|
|
236
|
+
aria-hidden="true"
|
|
237
|
+
>
|
|
238
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
239
|
+
</svg>
|
|
240
|
+
<h2>Properties</h2>
|
|
241
|
+
</summary>
|
|
242
|
+
<section>
|
|
243
|
+
<section class="tsd-panel tsd-member">
|
|
244
|
+
<h3 class="tsd-anchor-link" id="allow">
|
|
245
|
+
<code class="tsd-tag">Optional</code><span>allow</span
|
|
246
|
+
><a href="#allow" aria-label="Permalink" class="tsd-anchor-icon"
|
|
247
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
248
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
249
|
+
></a>
|
|
250
|
+
</h3>
|
|
251
|
+
<div class="tsd-signature">
|
|
252
|
+
<span class="tsd-kind-property">allow</span
|
|
253
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
254
|
+
<span class="tsd-signature-type">string</span>
|
|
255
|
+
</div>
|
|
256
|
+
<div class="tsd-comment tsd-typography">
|
|
257
|
+
<p>
|
|
258
|
+
Sets the iframe's
|
|
259
|
+
<a
|
|
260
|
+
href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-allow"
|
|
261
|
+
>allow attribute</a
|
|
262
|
+
>
|
|
263
|
+
for this client.
|
|
264
|
+
</p>
|
|
265
|
+
</div>
|
|
266
|
+
<aside class="tsd-sources">
|
|
267
|
+
<ul>
|
|
268
|
+
<li>
|
|
269
|
+
Defined in
|
|
270
|
+
<a
|
|
271
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L105"
|
|
272
|
+
>HostRouter.ts:105</a
|
|
273
|
+
>
|
|
274
|
+
</li>
|
|
275
|
+
</ul>
|
|
276
|
+
</aside>
|
|
277
|
+
</section>
|
|
278
|
+
<section class="tsd-panel tsd-member">
|
|
279
|
+
<h3 class="tsd-anchor-link" id="assignedroute">
|
|
280
|
+
<span>assigned<wbr />Route</span
|
|
281
|
+
><a
|
|
282
|
+
href="#assignedroute"
|
|
283
|
+
aria-label="Permalink"
|
|
284
|
+
class="tsd-anchor-icon"
|
|
285
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
286
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
287
|
+
></a>
|
|
288
|
+
</h3>
|
|
289
|
+
<div class="tsd-signature">
|
|
290
|
+
<span class="tsd-kind-property">assignedRoute</span
|
|
291
|
+
><span class="tsd-signature-symbol">:</span>
|
|
292
|
+
<span class="tsd-signature-type">string</span>
|
|
293
|
+
</div>
|
|
294
|
+
<div class="tsd-comment tsd-typography">
|
|
295
|
+
<p>
|
|
296
|
+
The <code>frame-router</code> route attribute prefix that maps
|
|
297
|
+
to this client app
|
|
298
|
+
</p>
|
|
299
|
+
</div>
|
|
300
|
+
<aside class="tsd-sources">
|
|
301
|
+
<ul>
|
|
302
|
+
<li>
|
|
303
|
+
Defined in
|
|
304
|
+
<a
|
|
305
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L100"
|
|
306
|
+
>HostRouter.ts:100</a
|
|
307
|
+
>
|
|
308
|
+
</li>
|
|
309
|
+
</ul>
|
|
310
|
+
</aside>
|
|
311
|
+
</section>
|
|
312
|
+
<section class="tsd-panel tsd-member">
|
|
313
|
+
<h3 class="tsd-anchor-link" id="defaulttitle">
|
|
314
|
+
<code class="tsd-tag">Optional</code
|
|
315
|
+
><span>default<wbr />Title</span
|
|
316
|
+
><a
|
|
317
|
+
href="#defaulttitle"
|
|
318
|
+
aria-label="Permalink"
|
|
319
|
+
class="tsd-anchor-icon"
|
|
320
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
321
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
322
|
+
></a>
|
|
323
|
+
</h3>
|
|
324
|
+
<div class="tsd-signature">
|
|
325
|
+
<span class="tsd-kind-property">defaultTitle</span
|
|
326
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
327
|
+
<span class="tsd-signature-type">string</span>
|
|
328
|
+
</div>
|
|
329
|
+
<div class="tsd-comment tsd-typography">
|
|
330
|
+
<p>
|
|
331
|
+
Sets the iframe's default
|
|
332
|
+
<a
|
|
333
|
+
href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#accessibility_concerns"
|
|
334
|
+
>title</a
|
|
335
|
+
>
|
|
336
|
+
attribute. This is required for accessibility.
|
|
337
|
+
</p>
|
|
338
|
+
</div>
|
|
339
|
+
<aside class="tsd-sources">
|
|
340
|
+
<ul>
|
|
341
|
+
<li>
|
|
342
|
+
Defined in
|
|
343
|
+
<a
|
|
344
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L115"
|
|
345
|
+
>HostRouter.ts:115</a
|
|
346
|
+
>
|
|
347
|
+
</li>
|
|
348
|
+
</ul>
|
|
349
|
+
</aside>
|
|
350
|
+
</section>
|
|
351
|
+
<section class="tsd-panel tsd-member">
|
|
352
|
+
<h3 class="tsd-anchor-link" id="sandbox">
|
|
353
|
+
<code class="tsd-tag">Optional</code><span>sandbox</span
|
|
354
|
+
><a
|
|
355
|
+
href="#sandbox"
|
|
356
|
+
aria-label="Permalink"
|
|
357
|
+
class="tsd-anchor-icon"
|
|
358
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
359
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
360
|
+
></a>
|
|
361
|
+
</h3>
|
|
362
|
+
<div class="tsd-signature">
|
|
363
|
+
<span class="tsd-kind-property">sandbox</span
|
|
364
|
+
><span class="tsd-signature-symbol">?:</span>
|
|
365
|
+
<span class="tsd-signature-type">string</span>
|
|
366
|
+
</div>
|
|
367
|
+
<div class="tsd-comment tsd-typography">
|
|
368
|
+
<p>
|
|
369
|
+
Sets the iframe's
|
|
370
|
+
<a
|
|
371
|
+
href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox"
|
|
372
|
+
>sandbox attribute</a
|
|
373
|
+
>
|
|
374
|
+
for this client. Values wll be merged with built-in defaults.
|
|
375
|
+
</p>
|
|
376
|
+
</div>
|
|
377
|
+
<aside class="tsd-sources">
|
|
378
|
+
<ul>
|
|
379
|
+
<li>
|
|
380
|
+
Defined in
|
|
381
|
+
<a
|
|
382
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L110"
|
|
383
|
+
>HostRouter.ts:110</a
|
|
384
|
+
>
|
|
385
|
+
</li>
|
|
386
|
+
</ul>
|
|
387
|
+
</aside>
|
|
388
|
+
</section>
|
|
389
|
+
<section class="tsd-panel tsd-member">
|
|
390
|
+
<h3 class="tsd-anchor-link" id="url">
|
|
391
|
+
<span>url</span
|
|
392
|
+
><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"
|
|
393
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
394
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
395
|
+
></a>
|
|
396
|
+
</h3>
|
|
397
|
+
<div class="tsd-signature">
|
|
398
|
+
<span class="tsd-kind-property">url</span
|
|
399
|
+
><span class="tsd-signature-symbol">:</span>
|
|
400
|
+
<span class="tsd-signature-type">string</span>
|
|
401
|
+
</div>
|
|
402
|
+
<div class="tsd-comment tsd-typography">
|
|
403
|
+
<p>The URL where the client application is hosted</p>
|
|
404
|
+
</div>
|
|
405
|
+
<aside class="tsd-sources">
|
|
406
|
+
<ul>
|
|
407
|
+
<li>
|
|
408
|
+
Defined in
|
|
409
|
+
<a
|
|
410
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/HostRouter.ts#L98"
|
|
411
|
+
>HostRouter.ts:98</a
|
|
412
|
+
>
|
|
413
|
+
</li>
|
|
414
|
+
</ul>
|
|
415
|
+
</aside>
|
|
416
|
+
</section>
|
|
417
|
+
</section>
|
|
418
|
+
</details>
|
|
419
|
+
</div>
|
|
420
|
+
<div class="col-sidebar">
|
|
421
|
+
<div class="page-menu">
|
|
422
|
+
<div class="tsd-navigation settings">
|
|
423
|
+
<details class="tsd-accordion">
|
|
424
|
+
<summary class="tsd-accordion-summary">
|
|
425
|
+
<svg
|
|
426
|
+
width="20"
|
|
427
|
+
height="20"
|
|
428
|
+
viewBox="0 0 24 24"
|
|
429
|
+
fill="none"
|
|
430
|
+
aria-hidden="true"
|
|
431
|
+
>
|
|
432
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
433
|
+
</svg>
|
|
434
|
+
<h3>Settings</h3>
|
|
435
|
+
</summary>
|
|
436
|
+
<div class="tsd-accordion-details">
|
|
437
|
+
<div class="tsd-filter-visibility">
|
|
438
|
+
<span class="settings-label">Member Visibility</span>
|
|
439
|
+
<ul id="tsd-filter-options">
|
|
440
|
+
<li class="tsd-filter-item">
|
|
441
|
+
<label class="tsd-filter-input"
|
|
442
|
+
><input
|
|
443
|
+
type="checkbox"
|
|
444
|
+
id="tsd-filter-inherited"
|
|
445
|
+
name="inherited"
|
|
446
|
+
checked
|
|
447
|
+
/><svg
|
|
448
|
+
width="32"
|
|
449
|
+
height="32"
|
|
450
|
+
viewBox="0 0 32 32"
|
|
451
|
+
aria-hidden="true"
|
|
452
|
+
>
|
|
453
|
+
<rect
|
|
454
|
+
class="tsd-checkbox-background"
|
|
455
|
+
width="30"
|
|
456
|
+
height="30"
|
|
457
|
+
x="1"
|
|
458
|
+
y="1"
|
|
459
|
+
rx="6"
|
|
460
|
+
fill="none"
|
|
461
|
+
></rect>
|
|
462
|
+
<path
|
|
463
|
+
class="tsd-checkbox-checkmark"
|
|
464
|
+
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
|
|
465
|
+
stroke="none"
|
|
466
|
+
stroke-width="3.5"
|
|
467
|
+
stroke-linejoin="round"
|
|
468
|
+
fill="none"
|
|
469
|
+
></path></svg
|
|
470
|
+
><span>Inherited</span></label
|
|
471
|
+
>
|
|
472
|
+
</li>
|
|
473
|
+
</ul>
|
|
474
|
+
</div>
|
|
475
|
+
<div class="tsd-theme-toggle">
|
|
476
|
+
<label class="settings-label" for="tsd-theme">Theme</label
|
|
477
|
+
><select id="tsd-theme">
|
|
478
|
+
<option value="os">OS</option>
|
|
479
|
+
<option value="light">Light</option>
|
|
480
|
+
<option value="dark">Dark</option>
|
|
481
|
+
</select>
|
|
482
|
+
</div>
|
|
483
|
+
</div>
|
|
484
|
+
</details>
|
|
485
|
+
</div>
|
|
486
|
+
<details open class="tsd-accordion tsd-page-navigation">
|
|
487
|
+
<summary class="tsd-accordion-summary">
|
|
488
|
+
<svg
|
|
489
|
+
width="20"
|
|
490
|
+
height="20"
|
|
491
|
+
viewBox="0 0 24 24"
|
|
492
|
+
fill="none"
|
|
493
|
+
aria-hidden="true"
|
|
494
|
+
>
|
|
495
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
496
|
+
</svg>
|
|
497
|
+
<h3>On This Page</h3>
|
|
498
|
+
</summary>
|
|
499
|
+
<div class="tsd-accordion-details">
|
|
500
|
+
<details open class="tsd-accordion tsd-page-navigation-section">
|
|
501
|
+
<summary
|
|
502
|
+
class="tsd-accordion-summary"
|
|
503
|
+
data-key="section-Properties"
|
|
504
|
+
>
|
|
505
|
+
<svg
|
|
506
|
+
width="20"
|
|
507
|
+
height="20"
|
|
508
|
+
viewBox="0 0 24 24"
|
|
509
|
+
fill="none"
|
|
510
|
+
aria-hidden="true"
|
|
511
|
+
>
|
|
512
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use></svg
|
|
513
|
+
>Properties
|
|
514
|
+
</summary>
|
|
515
|
+
<div>
|
|
516
|
+
<a href="#allow"
|
|
517
|
+
><svg
|
|
518
|
+
class="tsd-kind-icon"
|
|
519
|
+
viewBox="0 0 24 24"
|
|
520
|
+
aria-label="Property"
|
|
521
|
+
>
|
|
522
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
523
|
+
><span>allow</span></a
|
|
524
|
+
><a href="#assignedroute"
|
|
525
|
+
><svg
|
|
526
|
+
class="tsd-kind-icon"
|
|
527
|
+
viewBox="0 0 24 24"
|
|
528
|
+
aria-label="Property"
|
|
529
|
+
>
|
|
530
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
531
|
+
><span>assigned<wbr />Route</span></a
|
|
532
|
+
><a href="#defaulttitle"
|
|
533
|
+
><svg
|
|
534
|
+
class="tsd-kind-icon"
|
|
535
|
+
viewBox="0 0 24 24"
|
|
536
|
+
aria-label="Property"
|
|
537
|
+
>
|
|
538
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
539
|
+
><span>default<wbr />Title</span></a
|
|
540
|
+
><a href="#sandbox"
|
|
541
|
+
><svg
|
|
542
|
+
class="tsd-kind-icon"
|
|
543
|
+
viewBox="0 0 24 24"
|
|
544
|
+
aria-label="Property"
|
|
545
|
+
>
|
|
546
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
547
|
+
><span>sandbox</span></a
|
|
548
|
+
><a href="#url"
|
|
549
|
+
><svg
|
|
550
|
+
class="tsd-kind-icon"
|
|
551
|
+
viewBox="0 0 24 24"
|
|
552
|
+
aria-label="Property"
|
|
553
|
+
>
|
|
554
|
+
<use href="../assets/icons.svg#icon-1024"></use></svg
|
|
555
|
+
><span>url</span></a
|
|
556
|
+
>
|
|
557
|
+
</div>
|
|
558
|
+
</details>
|
|
559
|
+
</div>
|
|
560
|
+
</details>
|
|
561
|
+
</div>
|
|
562
|
+
<div class="site-menu">
|
|
563
|
+
<nav class="tsd-navigation">
|
|
564
|
+
<a href="../modules.html">iframe-coordinator - v6.5.1</a>
|
|
565
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
566
|
+
<li>Loading...</li>
|
|
567
|
+
</ul>
|
|
568
|
+
</nav>
|
|
569
|
+
</div>
|
|
570
|
+
</div>
|
|
571
|
+
</div>
|
|
572
|
+
<footer>
|
|
573
|
+
<p class="tsd-generator">
|
|
574
|
+
Generated using
|
|
575
|
+
<a href="https://typedoc.org/" target="_blank">TypeDoc</a>
|
|
576
|
+
</p>
|
|
577
|
+
</footer>
|
|
578
|
+
<div class="overlay"></div>
|
|
579
|
+
</body>
|
|
580
|
+
</html>
|