iframe-coordinator-cli 6.4.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-DEUCFuke.css +1 -0
- package/dist/assets/index-DejhDHus.js +57 -0
- package/dist/favicon.svg +1 -0
- 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 -99
- package/dist/ifc-docs/classes/client.WorkerClient.html +2164 -0
- package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
- package/dist/ifc-docs/classes/host.WorkerPool.html +879 -0
- 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 -0
- 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 -0
- package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -0
- package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -0
- package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -0
- package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -0
- package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -0
- package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -0
- package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -0
- package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -0
- package/dist/ifc-docs/interfaces/messages.Notification.html +435 -0
- package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -0
- package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -0
- package/dist/ifc-docs/interfaces/messages.Publication.html +443 -0
- 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 -0
- package/dist/ifc-docs/modules.html +359 -1
- package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -5
- package/dist/ifc-docs/types/client.EventHandler.html +247 -2
- package/dist/index.html +3 -3
- package/package.json +3 -4
- package/dist/assets/index-BLdxgMq2.css +0 -1
- package/dist/assets/index-IcxzuslN.js +0 -49
- package/dist/ifc-docs/classes/client.EventEmitter.html +0 -14
- package/dist/ifc-docs/interfaces/client.Breadcrumb.html +0 -6
- package/dist/ifc-docs/interfaces/client.EnvData.html +0 -11
- package/dist/ifc-docs/interfaces/client.KeyData.html +0 -12
- package/dist/ifc-docs/interfaces/client.ModalRequest.html +0 -6
- package/dist/ifc-docs/interfaces/client.NavRequest.html +0 -9
- package/dist/ifc-docs/interfaces/client.Notification.html +0 -9
- package/dist/ifc-docs/interfaces/client.PageMetadata.html +0 -8
- package/dist/ifc-docs/interfaces/client.PromptOnLeave.html +0 -9
- package/dist/ifc-docs/interfaces/client.Publication.html +0 -11
|
@@ -0,0 +1,752 @@
|
|
|
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>EventEmitter | 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">EventEmitter</a></li>
|
|
84
|
+
</ul>
|
|
85
|
+
<h1>Interface EventEmitter<T></h1>
|
|
86
|
+
</div>
|
|
87
|
+
<section class="tsd-panel tsd-comment">
|
|
88
|
+
<div class="tsd-comment tsd-typography">
|
|
89
|
+
<p>
|
|
90
|
+
API for registering and unregistering event handlers. Mirrors the
|
|
91
|
+
browser's EventTarget API.
|
|
92
|
+
</p>
|
|
93
|
+
</div>
|
|
94
|
+
</section>
|
|
95
|
+
<div class="tsd-signature">
|
|
96
|
+
<span class="tsd-signature-keyword">interface</span>
|
|
97
|
+
<span class="tsd-kind-interface">EventEmitter</span
|
|
98
|
+
><span class="tsd-signature-symbol"><</span
|
|
99
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
100
|
+
><span class="tsd-signature-symbol">></span>
|
|
101
|
+
<span class="tsd-signature-symbol">{</span><br /> <a
|
|
102
|
+
class="tsd-kind-call-signature"
|
|
103
|
+
href="#addlistener-1"
|
|
104
|
+
>addListener</a
|
|
105
|
+
><span class="tsd-signature-symbol">(</span
|
|
106
|
+
><span class="tsd-kind-parameter">type</span
|
|
107
|
+
><span class="tsd-signature-symbol">:</span>
|
|
108
|
+
<span class="tsd-signature-type">string</span
|
|
109
|
+
><span class="tsd-signature-symbol">,</span>
|
|
110
|
+
<span class="tsd-kind-parameter">listener</span
|
|
111
|
+
><span class="tsd-signature-symbol">:</span>
|
|
112
|
+
<a
|
|
113
|
+
href="../types/client.EventHandler.html"
|
|
114
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
115
|
+
>EventHandler</a
|
|
116
|
+
><span class="tsd-signature-symbol"><</span
|
|
117
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
118
|
+
><span class="tsd-signature-symbol">></span
|
|
119
|
+
><span class="tsd-signature-symbol">)</span
|
|
120
|
+
><span class="tsd-signature-symbol">:</span>
|
|
121
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
122
|
+
>EventEmitter</a
|
|
123
|
+
><span class="tsd-signature-symbol"><</span
|
|
124
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
125
|
+
><span class="tsd-signature-symbol">></span
|
|
126
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
127
|
+
class="tsd-kind-call-signature"
|
|
128
|
+
href="#removealllisteners-1"
|
|
129
|
+
>removeAllListeners</a
|
|
130
|
+
><span class="tsd-signature-symbol">(</span
|
|
131
|
+
><span class="tsd-kind-parameter">type</span
|
|
132
|
+
><span class="tsd-signature-symbol">:</span>
|
|
133
|
+
<span class="tsd-signature-type">string</span
|
|
134
|
+
><span class="tsd-signature-symbol">)</span
|
|
135
|
+
><span class="tsd-signature-symbol">:</span>
|
|
136
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
137
|
+
>EventEmitter</a
|
|
138
|
+
><span class="tsd-signature-symbol"><</span
|
|
139
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
140
|
+
><span class="tsd-signature-symbol">></span
|
|
141
|
+
><span class="tsd-signature-symbol">;</span><br /> <a
|
|
142
|
+
class="tsd-kind-call-signature"
|
|
143
|
+
href="#removelistener-1"
|
|
144
|
+
>removeListener</a
|
|
145
|
+
><span class="tsd-signature-symbol">(</span
|
|
146
|
+
><span class="tsd-kind-parameter">type</span
|
|
147
|
+
><span class="tsd-signature-symbol">:</span>
|
|
148
|
+
<span class="tsd-signature-type">string</span
|
|
149
|
+
><span class="tsd-signature-symbol">,</span>
|
|
150
|
+
<span class="tsd-kind-parameter">listener</span
|
|
151
|
+
><span class="tsd-signature-symbol">:</span>
|
|
152
|
+
<a
|
|
153
|
+
href="../types/client.EventHandler.html"
|
|
154
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
155
|
+
>EventHandler</a
|
|
156
|
+
><span class="tsd-signature-symbol"><</span
|
|
157
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
158
|
+
><span class="tsd-signature-symbol">></span
|
|
159
|
+
><span class="tsd-signature-symbol">)</span
|
|
160
|
+
><span class="tsd-signature-symbol">:</span>
|
|
161
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
162
|
+
>EventEmitter</a
|
|
163
|
+
><span class="tsd-signature-symbol"><</span
|
|
164
|
+
><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a
|
|
165
|
+
><span class="tsd-signature-symbol">></span
|
|
166
|
+
><span class="tsd-signature-symbol">;</span><br /><span
|
|
167
|
+
class="tsd-signature-symbol"
|
|
168
|
+
>}</span
|
|
169
|
+
>
|
|
170
|
+
</div>
|
|
171
|
+
<section class="tsd-panel">
|
|
172
|
+
<h4>Type Parameters</h4>
|
|
173
|
+
<ul class="tsd-type-parameter-list">
|
|
174
|
+
<li>
|
|
175
|
+
<span id="t"><span class="tsd-kind-type-parameter">T</span></span>
|
|
176
|
+
<div class="tsd-comment tsd-typography">
|
|
177
|
+
<p>The type of event produced by the emitter.</p>
|
|
178
|
+
</div>
|
|
179
|
+
</li>
|
|
180
|
+
</ul>
|
|
181
|
+
</section>
|
|
182
|
+
<aside class="tsd-sources">
|
|
183
|
+
<ul>
|
|
184
|
+
<li>
|
|
185
|
+
Defined in
|
|
186
|
+
<a
|
|
187
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/EventEmitter.ts#L58"
|
|
188
|
+
>EventEmitter.ts:58</a
|
|
189
|
+
>
|
|
190
|
+
</li>
|
|
191
|
+
</ul>
|
|
192
|
+
</aside>
|
|
193
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
194
|
+
<section class="tsd-panel tsd-index-panel">
|
|
195
|
+
<details class="tsd-index-content tsd-accordion" open>
|
|
196
|
+
<summary class="tsd-accordion-summary tsd-index-summary">
|
|
197
|
+
<svg
|
|
198
|
+
width="20"
|
|
199
|
+
height="20"
|
|
200
|
+
viewBox="0 0 24 24"
|
|
201
|
+
fill="none"
|
|
202
|
+
aria-hidden="true"
|
|
203
|
+
>
|
|
204
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
205
|
+
</svg>
|
|
206
|
+
<h5 class="tsd-index-heading uppercase">Index</h5>
|
|
207
|
+
</summary>
|
|
208
|
+
<div class="tsd-accordion-details">
|
|
209
|
+
<section class="tsd-index-section">
|
|
210
|
+
<h3 class="tsd-index-heading">Methods</h3>
|
|
211
|
+
<div class="tsd-index-list">
|
|
212
|
+
<a href="#addlistener" class="tsd-index-link"
|
|
213
|
+
><svg
|
|
214
|
+
class="tsd-kind-icon"
|
|
215
|
+
viewBox="0 0 24 24"
|
|
216
|
+
aria-label="Method"
|
|
217
|
+
>
|
|
218
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
219
|
+
><span>add<wbr />Listener</span></a
|
|
220
|
+
>
|
|
221
|
+
<a href="#removealllisteners" class="tsd-index-link"
|
|
222
|
+
><svg
|
|
223
|
+
class="tsd-kind-icon"
|
|
224
|
+
viewBox="0 0 24 24"
|
|
225
|
+
aria-label="Method"
|
|
226
|
+
>
|
|
227
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
228
|
+
><span>remove<wbr />All<wbr />Listeners</span></a
|
|
229
|
+
>
|
|
230
|
+
<a href="#removelistener" class="tsd-index-link"
|
|
231
|
+
><svg
|
|
232
|
+
class="tsd-kind-icon"
|
|
233
|
+
viewBox="0 0 24 24"
|
|
234
|
+
aria-label="Method"
|
|
235
|
+
>
|
|
236
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
237
|
+
><span>remove<wbr />Listener</span></a
|
|
238
|
+
>
|
|
239
|
+
</div>
|
|
240
|
+
</section>
|
|
241
|
+
</div>
|
|
242
|
+
</details>
|
|
243
|
+
</section>
|
|
244
|
+
</section>
|
|
245
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open>
|
|
246
|
+
<summary class="tsd-accordion-summary" data-key="section-Methods">
|
|
247
|
+
<svg
|
|
248
|
+
width="20"
|
|
249
|
+
height="20"
|
|
250
|
+
viewBox="0 0 24 24"
|
|
251
|
+
fill="none"
|
|
252
|
+
aria-hidden="true"
|
|
253
|
+
>
|
|
254
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
255
|
+
</svg>
|
|
256
|
+
<h2>Methods</h2>
|
|
257
|
+
</summary>
|
|
258
|
+
<section>
|
|
259
|
+
<section class="tsd-panel tsd-member">
|
|
260
|
+
<h3 class="tsd-anchor-link" id="addlistener">
|
|
261
|
+
<span>add<wbr />Listener</span
|
|
262
|
+
><a
|
|
263
|
+
href="#addlistener"
|
|
264
|
+
aria-label="Permalink"
|
|
265
|
+
class="tsd-anchor-icon"
|
|
266
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
267
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
268
|
+
></a>
|
|
269
|
+
</h3>
|
|
270
|
+
<ul class="tsd-signatures">
|
|
271
|
+
<li class="">
|
|
272
|
+
<div class="tsd-signature tsd-anchor-link" id="addlistener-1">
|
|
273
|
+
<span class="tsd-kind-call-signature">addListener</span
|
|
274
|
+
><span class="tsd-signature-symbol">(</span
|
|
275
|
+
><span class="tsd-kind-parameter">type</span
|
|
276
|
+
><span class="tsd-signature-symbol">:</span>
|
|
277
|
+
<span class="tsd-signature-type">string</span
|
|
278
|
+
><span class="tsd-signature-symbol">,</span>
|
|
279
|
+
<span class="tsd-kind-parameter">listener</span
|
|
280
|
+
><span class="tsd-signature-symbol">:</span>
|
|
281
|
+
<a
|
|
282
|
+
href="../types/client.EventHandler.html"
|
|
283
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
284
|
+
>EventHandler</a
|
|
285
|
+
><span class="tsd-signature-symbol"><</span
|
|
286
|
+
><a
|
|
287
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
288
|
+
href="#t"
|
|
289
|
+
>T</a
|
|
290
|
+
><span class="tsd-signature-symbol">></span
|
|
291
|
+
><span class="tsd-signature-symbol">)</span
|
|
292
|
+
><span class="tsd-signature-symbol">:</span>
|
|
293
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
294
|
+
>EventEmitter</a
|
|
295
|
+
><span class="tsd-signature-symbol"><</span
|
|
296
|
+
><a
|
|
297
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
298
|
+
href="#t"
|
|
299
|
+
>T</a
|
|
300
|
+
><span class="tsd-signature-symbol">></span
|
|
301
|
+
><a
|
|
302
|
+
href="#addlistener-1"
|
|
303
|
+
aria-label="Permalink"
|
|
304
|
+
class="tsd-anchor-icon"
|
|
305
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
306
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
307
|
+
></a>
|
|
308
|
+
</div>
|
|
309
|
+
<div class="tsd-description">
|
|
310
|
+
<div class="tsd-comment tsd-typography">
|
|
311
|
+
<p>
|
|
312
|
+
Sets up a function that will be called whenever the
|
|
313
|
+
specified event type is delivered to the target.
|
|
314
|
+
</p>
|
|
315
|
+
</div>
|
|
316
|
+
<div class="tsd-parameters">
|
|
317
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
318
|
+
<ul class="tsd-parameter-list">
|
|
319
|
+
<li>
|
|
320
|
+
<span
|
|
321
|
+
><span class="tsd-kind-parameter">type</span>:
|
|
322
|
+
<span class="tsd-signature-type">string</span></span
|
|
323
|
+
>
|
|
324
|
+
<div class="tsd-comment tsd-typography">
|
|
325
|
+
<p>
|
|
326
|
+
A case-sensitive string representing the event
|
|
327
|
+
type to listen for.
|
|
328
|
+
</p>
|
|
329
|
+
</div>
|
|
330
|
+
</li>
|
|
331
|
+
<li>
|
|
332
|
+
<span
|
|
333
|
+
><span class="tsd-kind-parameter">listener</span>:
|
|
334
|
+
<a
|
|
335
|
+
href="../types/client.EventHandler.html"
|
|
336
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
337
|
+
>EventHandler</a
|
|
338
|
+
><span class="tsd-signature-symbol"><</span
|
|
339
|
+
><a
|
|
340
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
341
|
+
href="#t"
|
|
342
|
+
>T</a
|
|
343
|
+
><span class="tsd-signature-symbol"
|
|
344
|
+
>></span
|
|
345
|
+
></span
|
|
346
|
+
>
|
|
347
|
+
<div class="tsd-comment tsd-typography">
|
|
348
|
+
<p>
|
|
349
|
+
The handler which receives a notification when an
|
|
350
|
+
event of the specified type occurs.
|
|
351
|
+
</p>
|
|
352
|
+
</div>
|
|
353
|
+
</li>
|
|
354
|
+
</ul>
|
|
355
|
+
</div>
|
|
356
|
+
<h4 class="tsd-returns-title">
|
|
357
|
+
Returns
|
|
358
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
359
|
+
>EventEmitter</a
|
|
360
|
+
><span class="tsd-signature-symbol"><</span
|
|
361
|
+
><a
|
|
362
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
363
|
+
href="#t"
|
|
364
|
+
>T</a
|
|
365
|
+
><span class="tsd-signature-symbol">></span>
|
|
366
|
+
</h4>
|
|
367
|
+
<aside class="tsd-sources">
|
|
368
|
+
<ul>
|
|
369
|
+
<li>
|
|
370
|
+
Defined in
|
|
371
|
+
<a
|
|
372
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/EventEmitter.ts#L75"
|
|
373
|
+
>EventEmitter.ts:75</a
|
|
374
|
+
>
|
|
375
|
+
</li>
|
|
376
|
+
</ul>
|
|
377
|
+
</aside>
|
|
378
|
+
</div>
|
|
379
|
+
</li>
|
|
380
|
+
</ul>
|
|
381
|
+
</section>
|
|
382
|
+
<section class="tsd-panel tsd-member">
|
|
383
|
+
<h3 class="tsd-anchor-link" id="removealllisteners">
|
|
384
|
+
<span>remove<wbr />All<wbr />Listeners</span
|
|
385
|
+
><a
|
|
386
|
+
href="#removealllisteners"
|
|
387
|
+
aria-label="Permalink"
|
|
388
|
+
class="tsd-anchor-icon"
|
|
389
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
390
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
391
|
+
></a>
|
|
392
|
+
</h3>
|
|
393
|
+
<ul class="tsd-signatures">
|
|
394
|
+
<li class="">
|
|
395
|
+
<div
|
|
396
|
+
class="tsd-signature tsd-anchor-link"
|
|
397
|
+
id="removealllisteners-1"
|
|
398
|
+
>
|
|
399
|
+
<span class="tsd-kind-call-signature"
|
|
400
|
+
>removeAllListeners</span
|
|
401
|
+
><span class="tsd-signature-symbol">(</span
|
|
402
|
+
><span class="tsd-kind-parameter">type</span
|
|
403
|
+
><span class="tsd-signature-symbol">:</span>
|
|
404
|
+
<span class="tsd-signature-type">string</span
|
|
405
|
+
><span class="tsd-signature-symbol">)</span
|
|
406
|
+
><span class="tsd-signature-symbol">:</span>
|
|
407
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
408
|
+
>EventEmitter</a
|
|
409
|
+
><span class="tsd-signature-symbol"><</span
|
|
410
|
+
><a
|
|
411
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
412
|
+
href="#t"
|
|
413
|
+
>T</a
|
|
414
|
+
><span class="tsd-signature-symbol">></span
|
|
415
|
+
><a
|
|
416
|
+
href="#removealllisteners-1"
|
|
417
|
+
aria-label="Permalink"
|
|
418
|
+
class="tsd-anchor-icon"
|
|
419
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
420
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
421
|
+
></a>
|
|
422
|
+
</div>
|
|
423
|
+
<div class="tsd-description">
|
|
424
|
+
<div class="tsd-comment tsd-typography">
|
|
425
|
+
<p>
|
|
426
|
+
Removes all event listeners previously registered with
|
|
427
|
+
<a
|
|
428
|
+
href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener"
|
|
429
|
+
>addEventListener</a
|
|
430
|
+
>.
|
|
431
|
+
</p>
|
|
432
|
+
</div>
|
|
433
|
+
<div class="tsd-parameters">
|
|
434
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
435
|
+
<ul class="tsd-parameter-list">
|
|
436
|
+
<li>
|
|
437
|
+
<span
|
|
438
|
+
><span class="tsd-kind-parameter">type</span>:
|
|
439
|
+
<span class="tsd-signature-type">string</span></span
|
|
440
|
+
>
|
|
441
|
+
<div class="tsd-comment tsd-typography">
|
|
442
|
+
<p>
|
|
443
|
+
A string which specifies the type of event for
|
|
444
|
+
which to remove an event listener.
|
|
445
|
+
</p>
|
|
446
|
+
</div>
|
|
447
|
+
</li>
|
|
448
|
+
</ul>
|
|
449
|
+
</div>
|
|
450
|
+
<h4 class="tsd-returns-title">
|
|
451
|
+
Returns
|
|
452
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
453
|
+
>EventEmitter</a
|
|
454
|
+
><span class="tsd-signature-symbol"><</span
|
|
455
|
+
><a
|
|
456
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
457
|
+
href="#t"
|
|
458
|
+
>T</a
|
|
459
|
+
><span class="tsd-signature-symbol">></span>
|
|
460
|
+
</h4>
|
|
461
|
+
<aside class="tsd-sources">
|
|
462
|
+
<ul>
|
|
463
|
+
<li>
|
|
464
|
+
Defined in
|
|
465
|
+
<a
|
|
466
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/EventEmitter.ts#L97"
|
|
467
|
+
>EventEmitter.ts:97</a
|
|
468
|
+
>
|
|
469
|
+
</li>
|
|
470
|
+
</ul>
|
|
471
|
+
</aside>
|
|
472
|
+
</div>
|
|
473
|
+
</li>
|
|
474
|
+
</ul>
|
|
475
|
+
</section>
|
|
476
|
+
<section class="tsd-panel tsd-member">
|
|
477
|
+
<h3 class="tsd-anchor-link" id="removelistener">
|
|
478
|
+
<span>remove<wbr />Listener</span
|
|
479
|
+
><a
|
|
480
|
+
href="#removelistener"
|
|
481
|
+
aria-label="Permalink"
|
|
482
|
+
class="tsd-anchor-icon"
|
|
483
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
484
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
485
|
+
></a>
|
|
486
|
+
</h3>
|
|
487
|
+
<ul class="tsd-signatures">
|
|
488
|
+
<li class="">
|
|
489
|
+
<div
|
|
490
|
+
class="tsd-signature tsd-anchor-link"
|
|
491
|
+
id="removelistener-1"
|
|
492
|
+
>
|
|
493
|
+
<span class="tsd-kind-call-signature">removeListener</span
|
|
494
|
+
><span class="tsd-signature-symbol">(</span
|
|
495
|
+
><span class="tsd-kind-parameter">type</span
|
|
496
|
+
><span class="tsd-signature-symbol">:</span>
|
|
497
|
+
<span class="tsd-signature-type">string</span
|
|
498
|
+
><span class="tsd-signature-symbol">,</span>
|
|
499
|
+
<span class="tsd-kind-parameter">listener</span
|
|
500
|
+
><span class="tsd-signature-symbol">:</span>
|
|
501
|
+
<a
|
|
502
|
+
href="../types/client.EventHandler.html"
|
|
503
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
504
|
+
>EventHandler</a
|
|
505
|
+
><span class="tsd-signature-symbol"><</span
|
|
506
|
+
><a
|
|
507
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
508
|
+
href="#t"
|
|
509
|
+
>T</a
|
|
510
|
+
><span class="tsd-signature-symbol">></span
|
|
511
|
+
><span class="tsd-signature-symbol">)</span
|
|
512
|
+
><span class="tsd-signature-symbol">:</span>
|
|
513
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
514
|
+
>EventEmitter</a
|
|
515
|
+
><span class="tsd-signature-symbol"><</span
|
|
516
|
+
><a
|
|
517
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
518
|
+
href="#t"
|
|
519
|
+
>T</a
|
|
520
|
+
><span class="tsd-signature-symbol">></span
|
|
521
|
+
><a
|
|
522
|
+
href="#removelistener-1"
|
|
523
|
+
aria-label="Permalink"
|
|
524
|
+
class="tsd-anchor-icon"
|
|
525
|
+
><svg viewBox="0 0 24 24" aria-hidden="true">
|
|
526
|
+
<use href="../assets/icons.svg#icon-anchor"></use></svg
|
|
527
|
+
></a>
|
|
528
|
+
</div>
|
|
529
|
+
<div class="tsd-description">
|
|
530
|
+
<div class="tsd-comment tsd-typography">
|
|
531
|
+
<p>
|
|
532
|
+
Removes from the event listener previously registered
|
|
533
|
+
with
|
|
534
|
+
<a
|
|
535
|
+
href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener"
|
|
536
|
+
>addEventListener</a
|
|
537
|
+
>.
|
|
538
|
+
</p>
|
|
539
|
+
</div>
|
|
540
|
+
<div class="tsd-parameters">
|
|
541
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
542
|
+
<ul class="tsd-parameter-list">
|
|
543
|
+
<li>
|
|
544
|
+
<span
|
|
545
|
+
><span class="tsd-kind-parameter">type</span>:
|
|
546
|
+
<span class="tsd-signature-type">string</span></span
|
|
547
|
+
>
|
|
548
|
+
<div class="tsd-comment tsd-typography">
|
|
549
|
+
<p>
|
|
550
|
+
A string which specifies the type of event for
|
|
551
|
+
which to remove an event listener.
|
|
552
|
+
</p>
|
|
553
|
+
</div>
|
|
554
|
+
</li>
|
|
555
|
+
<li>
|
|
556
|
+
<span
|
|
557
|
+
><span class="tsd-kind-parameter">listener</span>:
|
|
558
|
+
<a
|
|
559
|
+
href="../types/client.EventHandler.html"
|
|
560
|
+
class="tsd-signature-type tsd-kind-type-alias"
|
|
561
|
+
>EventHandler</a
|
|
562
|
+
><span class="tsd-signature-symbol"><</span
|
|
563
|
+
><a
|
|
564
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
565
|
+
href="#t"
|
|
566
|
+
>T</a
|
|
567
|
+
><span class="tsd-signature-symbol"
|
|
568
|
+
>></span
|
|
569
|
+
></span
|
|
570
|
+
>
|
|
571
|
+
<div class="tsd-comment tsd-typography">
|
|
572
|
+
<p>
|
|
573
|
+
The event handler to remove from the event target.
|
|
574
|
+
</p>
|
|
575
|
+
</div>
|
|
576
|
+
</li>
|
|
577
|
+
</ul>
|
|
578
|
+
</div>
|
|
579
|
+
<h4 class="tsd-returns-title">
|
|
580
|
+
Returns
|
|
581
|
+
<a href="" class="tsd-signature-type tsd-kind-interface"
|
|
582
|
+
>EventEmitter</a
|
|
583
|
+
><span class="tsd-signature-symbol"><</span
|
|
584
|
+
><a
|
|
585
|
+
class="tsd-signature-type tsd-kind-type-parameter"
|
|
586
|
+
href="#t"
|
|
587
|
+
>T</a
|
|
588
|
+
><span class="tsd-signature-symbol">></span>
|
|
589
|
+
</h4>
|
|
590
|
+
<aside class="tsd-sources">
|
|
591
|
+
<ul>
|
|
592
|
+
<li>
|
|
593
|
+
Defined in
|
|
594
|
+
<a
|
|
595
|
+
href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/EventEmitter.ts#L85"
|
|
596
|
+
>EventEmitter.ts:85</a
|
|
597
|
+
>
|
|
598
|
+
</li>
|
|
599
|
+
</ul>
|
|
600
|
+
</aside>
|
|
601
|
+
</div>
|
|
602
|
+
</li>
|
|
603
|
+
</ul>
|
|
604
|
+
</section>
|
|
605
|
+
</section>
|
|
606
|
+
</details>
|
|
607
|
+
</div>
|
|
608
|
+
<div class="col-sidebar">
|
|
609
|
+
<div class="page-menu">
|
|
610
|
+
<div class="tsd-navigation settings">
|
|
611
|
+
<details class="tsd-accordion">
|
|
612
|
+
<summary class="tsd-accordion-summary">
|
|
613
|
+
<svg
|
|
614
|
+
width="20"
|
|
615
|
+
height="20"
|
|
616
|
+
viewBox="0 0 24 24"
|
|
617
|
+
fill="none"
|
|
618
|
+
aria-hidden="true"
|
|
619
|
+
>
|
|
620
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
621
|
+
</svg>
|
|
622
|
+
<h3>Settings</h3>
|
|
623
|
+
</summary>
|
|
624
|
+
<div class="tsd-accordion-details">
|
|
625
|
+
<div class="tsd-filter-visibility">
|
|
626
|
+
<span class="settings-label">Member Visibility</span>
|
|
627
|
+
<ul id="tsd-filter-options">
|
|
628
|
+
<li class="tsd-filter-item">
|
|
629
|
+
<label class="tsd-filter-input"
|
|
630
|
+
><input
|
|
631
|
+
type="checkbox"
|
|
632
|
+
id="tsd-filter-inherited"
|
|
633
|
+
name="inherited"
|
|
634
|
+
checked
|
|
635
|
+
/><svg
|
|
636
|
+
width="32"
|
|
637
|
+
height="32"
|
|
638
|
+
viewBox="0 0 32 32"
|
|
639
|
+
aria-hidden="true"
|
|
640
|
+
>
|
|
641
|
+
<rect
|
|
642
|
+
class="tsd-checkbox-background"
|
|
643
|
+
width="30"
|
|
644
|
+
height="30"
|
|
645
|
+
x="1"
|
|
646
|
+
y="1"
|
|
647
|
+
rx="6"
|
|
648
|
+
fill="none"
|
|
649
|
+
></rect>
|
|
650
|
+
<path
|
|
651
|
+
class="tsd-checkbox-checkmark"
|
|
652
|
+
d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
|
|
653
|
+
stroke="none"
|
|
654
|
+
stroke-width="3.5"
|
|
655
|
+
stroke-linejoin="round"
|
|
656
|
+
fill="none"
|
|
657
|
+
></path></svg
|
|
658
|
+
><span>Inherited</span></label
|
|
659
|
+
>
|
|
660
|
+
</li>
|
|
661
|
+
</ul>
|
|
662
|
+
</div>
|
|
663
|
+
<div class="tsd-theme-toggle">
|
|
664
|
+
<label class="settings-label" for="tsd-theme">Theme</label
|
|
665
|
+
><select id="tsd-theme">
|
|
666
|
+
<option value="os">OS</option>
|
|
667
|
+
<option value="light">Light</option>
|
|
668
|
+
<option value="dark">Dark</option>
|
|
669
|
+
</select>
|
|
670
|
+
</div>
|
|
671
|
+
</div>
|
|
672
|
+
</details>
|
|
673
|
+
</div>
|
|
674
|
+
<details open class="tsd-accordion tsd-page-navigation">
|
|
675
|
+
<summary class="tsd-accordion-summary">
|
|
676
|
+
<svg
|
|
677
|
+
width="20"
|
|
678
|
+
height="20"
|
|
679
|
+
viewBox="0 0 24 24"
|
|
680
|
+
fill="none"
|
|
681
|
+
aria-hidden="true"
|
|
682
|
+
>
|
|
683
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use>
|
|
684
|
+
</svg>
|
|
685
|
+
<h3>On This Page</h3>
|
|
686
|
+
</summary>
|
|
687
|
+
<div class="tsd-accordion-details">
|
|
688
|
+
<details open class="tsd-accordion tsd-page-navigation-section">
|
|
689
|
+
<summary
|
|
690
|
+
class="tsd-accordion-summary"
|
|
691
|
+
data-key="section-Methods"
|
|
692
|
+
>
|
|
693
|
+
<svg
|
|
694
|
+
width="20"
|
|
695
|
+
height="20"
|
|
696
|
+
viewBox="0 0 24 24"
|
|
697
|
+
fill="none"
|
|
698
|
+
aria-hidden="true"
|
|
699
|
+
>
|
|
700
|
+
<use href="../assets/icons.svg#icon-chevronDown"></use></svg
|
|
701
|
+
>Methods
|
|
702
|
+
</summary>
|
|
703
|
+
<div>
|
|
704
|
+
<a href="#addlistener"
|
|
705
|
+
><svg
|
|
706
|
+
class="tsd-kind-icon"
|
|
707
|
+
viewBox="0 0 24 24"
|
|
708
|
+
aria-label="Method"
|
|
709
|
+
>
|
|
710
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
711
|
+
><span>add<wbr />Listener</span></a
|
|
712
|
+
><a href="#removealllisteners"
|
|
713
|
+
><svg
|
|
714
|
+
class="tsd-kind-icon"
|
|
715
|
+
viewBox="0 0 24 24"
|
|
716
|
+
aria-label="Method"
|
|
717
|
+
>
|
|
718
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
719
|
+
><span>remove<wbr />All<wbr />Listeners</span></a
|
|
720
|
+
><a href="#removelistener"
|
|
721
|
+
><svg
|
|
722
|
+
class="tsd-kind-icon"
|
|
723
|
+
viewBox="0 0 24 24"
|
|
724
|
+
aria-label="Method"
|
|
725
|
+
>
|
|
726
|
+
<use href="../assets/icons.svg#icon-2048"></use></svg
|
|
727
|
+
><span>remove<wbr />Listener</span></a
|
|
728
|
+
>
|
|
729
|
+
</div>
|
|
730
|
+
</details>
|
|
731
|
+
</div>
|
|
732
|
+
</details>
|
|
733
|
+
</div>
|
|
734
|
+
<div class="site-menu">
|
|
735
|
+
<nav class="tsd-navigation">
|
|
736
|
+
<a href="../modules.html">iframe-coordinator - v6.5.1</a>
|
|
737
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
738
|
+
<li>Loading...</li>
|
|
739
|
+
</ul>
|
|
740
|
+
</nav>
|
|
741
|
+
</div>
|
|
742
|
+
</div>
|
|
743
|
+
</div>
|
|
744
|
+
<footer>
|
|
745
|
+
<p class="tsd-generator">
|
|
746
|
+
Generated using
|
|
747
|
+
<a href="https://typedoc.org/" target="_blank">TypeDoc</a>
|
|
748
|
+
</p>
|
|
749
|
+
</footer>
|
|
750
|
+
<div class="overlay"></div>
|
|
751
|
+
</body>
|
|
752
|
+
</html>
|