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