You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Defined in: [IframeClient.ts:16](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L16)
9
+
Defined in: [IframeClient.ts:16](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L16)
10
10
11
11
## Extends
12
12
@@ -18,7 +18,7 @@ Defined in: [IframeClient.ts:16](https://github.com/purecloudlabs/iframe-coordin
Defined in: [IframeClient.ts:20](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L20)
21
+
Defined in: [IframeClient.ts:20](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L20)
22
22
23
23
#### Parameters
24
24
@@ -42,7 +42,7 @@ Defined in: [IframeClient.ts:20](https://github.com/purecloudlabs/iframe-coordin
Defined in: [AbstractClient.ts:171](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L171)
45
+
Defined in: [AbstractClient.ts:169](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L169)
46
46
47
47
Gets the environmental data provided by the host application. This includes
48
48
the locale the client should use, the base URL of the host app, and any
Defined in: [AbstractClient.ts:271](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L271)
67
+
Defined in: [AbstractClient.ts:269](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L269)
68
68
69
69
Accessor for the general-purpose pub-sub bus between client and host applications.
70
70
The content of messages on this bus are not defined by this API beyond a basic
@@ -85,7 +85,7 @@ agreed upon as a shared API between host and client.
85
85
86
86
> **addListener**(`type`, `listener`): `this`
87
87
88
-
Defined in: [AbstractClient.ts:69](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L69)
88
+
Defined in: [AbstractClient.ts:67](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L67)
89
89
90
90
Sets up a function that will be called whenever the specified event type is delivered to the target.
91
91
This should not be confused with the general-purpose pub-sub listeners that can be set via the
@@ -122,7 +122,7 @@ The handler which receives a notification when an event of the specified type oc
122
122
123
123
> **asHostUrl**(`clientRouteLegacy`): `string`
124
124
125
-
Defined in: [AbstractClient.ts:214](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L214)
125
+
Defined in: [AbstractClient.ts:212](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L212)
126
126
127
127
Translates a client route like `/foo/bar` to the full URL used in the host
128
128
app for the same page, e.g. `https://hostapp.com/#/client-app/foo/bar`.
@@ -153,7 +153,7 @@ Use the new [urlFromClientPath](#urlfromclientpath) method instead
153
153
154
154
> **clearPromptOnLeave**(): `void`
155
155
156
-
Defined in: [AbstractClient.ts:389](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L389)
156
+
Defined in: [AbstractClient.ts:387](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L387)
157
157
158
158
Asks the host application to clear the prompt on leave dialog.
159
159
@@ -171,7 +171,7 @@ Asks the host application to clear the prompt on leave dialog.
171
171
172
172
> **publish**(`publication`): `void`
173
173
174
-
Defined in: [AbstractClient.ts:293](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L293)
174
+
Defined in: [AbstractClient.ts:291](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L291)
175
175
176
176
Publish a general message to the host application.
177
177
@@ -197,7 +197,7 @@ The data object to be published.
197
197
198
198
> **registerCustomElements**(): `void`
199
199
200
-
Defined in: [IframeClient.ts:46](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L46)
200
+
Defined in: [IframeClient.ts:46](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L46)
201
201
202
202
Registers custom elements used by the client application
203
203
@@ -211,7 +211,7 @@ Registers custom elements used by the client application
211
211
212
212
> **removeAllListeners**(`type`): `this`
213
213
214
-
Defined in: [AbstractClient.ts:94](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L94)
214
+
Defined in: [AbstractClient.ts:92](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L92)
215
215
216
216
Removes all event listeners previously registered with [addListener](#addlistener).
217
217
@@ -237,7 +237,7 @@ A string which specifies the type of event for which to remove an event listener
237
237
238
238
> **removeListener**(`type`, `listener`): `this`
239
239
240
-
Defined in: [AbstractClient.ts:82](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L82)
240
+
Defined in: [AbstractClient.ts:80](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L80)
241
241
242
242
Removes an event listener previously registered with [addListener](#addlistener).
243
243
@@ -269,7 +269,7 @@ The event handler to remove from the event target.
269
269
270
270
> **requestModal**(`modalRequest`): `void`
271
271
272
-
Defined in: [AbstractClient.ts:309](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L309)
272
+
Defined in: [AbstractClient.ts:307](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L307)
273
273
274
274
Asks the host application to open a modal dialog.
275
275
@@ -298,7 +298,7 @@ the ID and any data specific to the modal instance required
298
298
299
299
> **requestNavigation**(`destination`): `void`
300
300
301
-
Defined in: [AbstractClient.ts:369](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L369)
301
+
Defined in: [AbstractClient.ts:367](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L367)
302
302
303
303
Asks the host application to navigate to a new location.
304
304
@@ -329,7 +329,7 @@ a description of where the client wants to navigate the app to.
329
329
330
330
> **requestNotification**(`notification`): `void`
331
331
332
-
Defined in: [AbstractClient.ts:351](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L351)
332
+
Defined in: [AbstractClient.ts:349](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L349)
333
333
334
334
Asks the host application to display a user notification.
Defined in: [AbstractClient.ts:379](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L379)
387
+
Defined in: [AbstractClient.ts:377](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L377)
388
388
389
389
Asks the host application to display a prompt on leave dialog.
390
390
@@ -408,7 +408,7 @@ Asks the host application to display a prompt on leave dialog.
408
408
409
409
> **sendPageMetadata**(`metadata`): `void`
410
410
411
-
Defined in: [AbstractClient.ts:405](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L405)
411
+
Defined in: [AbstractClient.ts:403](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L403)
412
412
413
413
Sends page metadata to host for display and browser settings
414
414
@@ -438,7 +438,7 @@ data that will be used for display in host application and browser page title
438
438
439
439
> **start**(): `void`
440
440
441
-
Defined in: [IframeClient.ts:30](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L30)
441
+
Defined in: [IframeClient.ts:30](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L30)
442
442
443
443
Initiates responding to events triggered by the host application.
444
444
@@ -456,7 +456,7 @@ Initiates responding to events triggered by the host application.
456
456
457
457
> **startInterceptingLinks**(): `void`
458
458
459
-
Defined in: [IframeClient.ts:78](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L78)
459
+
Defined in: [IframeClient.ts:78](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L78)
460
460
461
461
Allows the click handler on the client window to intercept clicks on anchor elements
462
462
and makes a nav request to the host based on the element's href. This should be
@@ -473,7 +473,7 @@ links that you may not want to intercept.
473
473
474
474
> **stop**(): `void`
475
475
476
-
Defined in: [IframeClient.ts:36](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L36)
476
+
Defined in: [IframeClient.ts:36](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L36)
477
477
478
478
Disconnects this client from the host application. This is mostly provided for
479
479
the sake of API completeness. It's unlikely to be used by most applications.
@@ -492,7 +492,7 @@ the sake of API completeness. It's unlikely to be used by most applications.
492
492
493
493
> **stopInterceptingLinks**(): `void`
494
494
495
-
Defined in: [IframeClient.ts:85](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/IframeClient.ts#L85)
495
+
Defined in: [IframeClient.ts:85](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/IframeClient.ts#L85)
496
496
497
497
Turns off the behavior of intercepting link clicks in the client window click handler.
498
498
@@ -506,7 +506,7 @@ Turns off the behavior of intercepting link clicks in the client window click ha
506
506
507
507
> **urlFromClientPath**(`clientRoute`): `string`
508
508
509
-
Defined in: [AbstractClient.ts:184](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L184)
509
+
Defined in: [AbstractClient.ts:182](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L182)
510
510
511
511
Translates a client route like `/foo/bar` to the full URL used in the host
512
512
app for the same page, e.g. `https://hostapp.com/#/client-app/foo/bar`.
@@ -536,7 +536,7 @@ The /-separated path within the client app to link to.
536
536
537
537
> **urlFromHostPath**(`hostRoute`): `string`
538
538
539
-
Defined in: [AbstractClient.ts:200](https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/AbstractClient.ts#L200)
539
+
Defined in: [AbstractClient.ts:198](https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/AbstractClient.ts#L198)
540
540
541
541
Translates a host route like `/app2` to the full URL used in the host
0 commit comments