Skip to content

Commit 794d384

Browse files
author
PureCloud Jenkins
committed
chore(release): 6.5.1
1 parent 3793b75 commit 794d384

35 files changed

Lines changed: 158 additions & 158 deletions

apps/ifc-example-client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ifc-example-client",
3-
"version": "6.5.0",
3+
"version": "6.5.1",
44
"description": "Demo app for iframe-coordinator project",
55
"repository": {
66
"type": "git",

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**iframe-coordinator v6.5.0**
1+
**iframe-coordinator v6.5.1**
22

33
---
44

docs/client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**iframe-coordinator v6.5.0**](../README.md)
1+
[**iframe-coordinator v6.5.1**](../README.md)
22

33
---
44

docs/client/classes/Client.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
[**iframe-coordinator v6.5.0**](../../README.md)
1+
[**iframe-coordinator v6.5.1**](../../README.md)
22

33
---
44

55
[iframe-coordinator](../../modules.md) / [client](../README.md) / Client
66

77
# Class: Client
88

9-
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)
1010

1111
## Extends
1212

@@ -18,7 +18,7 @@ Defined in: [IframeClient.ts:16](https://github.com/purecloudlabs/iframe-coordin
1818

1919
> **new Client**(`configOptions?`): `IframeClient`
2020
21-
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)
2222

2323
#### Parameters
2424

@@ -42,7 +42,7 @@ Defined in: [IframeClient.ts:20](https://github.com/purecloudlabs/iframe-coordin
4242

4343
> **get** **environmentData**(): [`EnvData`](../../messages/interfaces/EnvData.md)
4444
45-
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)
4646

4747
Gets the environmental data provided by the host application. This includes
4848
the locale the client should use, the base URL of the host app, and any
@@ -64,7 +64,7 @@ custom data sent by the host.
6464

6565
> **get** **messaging**(): [`EventEmitter`](../interfaces/EventEmitter.md)\<[`Publication`](../../messages/interfaces/Publication.md)\>
6666
67-
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)
6868

6969
Accessor for the general-purpose pub-sub bus between client and host applications.
7070
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.
8585

8686
> **addListener**(`type`, `listener`): `this`
8787
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)
8989

9090
Sets up a function that will be called whenever the specified event type is delivered to the target.
9191
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
122122

123123
> **asHostUrl**(`clientRouteLegacy`): `string`
124124
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)
126126

127127
Translates a client route like `/foo/bar` to the full URL used in the host
128128
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
153153

154154
> **clearPromptOnLeave**(): `void`
155155
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)
157157

158158
Asks the host application to clear the prompt on leave dialog.
159159

@@ -171,7 +171,7 @@ Asks the host application to clear the prompt on leave dialog.
171171

172172
> **publish**(`publication`): `void`
173173
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)
175175

176176
Publish a general message to the host application.
177177

@@ -197,7 +197,7 @@ The data object to be published.
197197

198198
> **registerCustomElements**(): `void`
199199
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)
201201

202202
Registers custom elements used by the client application
203203

@@ -211,7 +211,7 @@ Registers custom elements used by the client application
211211

212212
> **removeAllListeners**(`type`): `this`
213213
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)
215215

216216
Removes all event listeners previously registered with [addListener](#addlistener).
217217

@@ -237,7 +237,7 @@ A string which specifies the type of event for which to remove an event listener
237237

238238
> **removeListener**(`type`, `listener`): `this`
239239
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)
241241

242242
Removes an event listener previously registered with [addListener](#addlistener).
243243

@@ -269,7 +269,7 @@ The event handler to remove from the event target.
269269

270270
> **requestModal**(`modalRequest`): `void`
271271
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)
273273

274274
Asks the host application to open a modal dialog.
275275

@@ -298,7 +298,7 @@ the ID and any data specific to the modal instance required
298298

299299
> **requestNavigation**(`destination`): `void`
300300
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)
302302

303303
Asks the host application to navigate to a new location.
304304

@@ -329,7 +329,7 @@ a description of where the client wants to navigate the app to.
329329

330330
> **requestNotification**(`notification`): `void`
331331
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)
333333

334334
Asks the host application to display a user notification.
335335

@@ -384,7 +384,7 @@ client.requestNotification({
384384

385385
> **requestPromptOnLeave**(`messagePrompt?`): `void`
386386
387-
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)
388388

389389
Asks the host application to display a prompt on leave dialog.
390390

@@ -408,7 +408,7 @@ Asks the host application to display a prompt on leave dialog.
408408

409409
> **sendPageMetadata**(`metadata`): `void`
410410
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)
412412

413413
Sends page metadata to host for display and browser settings
414414

@@ -438,7 +438,7 @@ data that will be used for display in host application and browser page title
438438

439439
> **start**(): `void`
440440
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)
442442

443443
Initiates responding to events triggered by the host application.
444444

@@ -456,7 +456,7 @@ Initiates responding to events triggered by the host application.
456456

457457
> **startInterceptingLinks**(): `void`
458458
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)
460460

461461
Allows the click handler on the client window to intercept clicks on anchor elements
462462
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.
473473

474474
> **stop**(): `void`
475475
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)
477477

478478
Disconnects this client from the host application. This is mostly provided for
479479
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.
492492

493493
> **stopInterceptingLinks**(): `void`
494494
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)
496496

497497
Turns off the behavior of intercepting link clicks in the client window click handler.
498498

@@ -506,7 +506,7 @@ Turns off the behavior of intercepting link clicks in the client window click ha
506506

507507
> **urlFromClientPath**(`clientRoute`): `string`
508508
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)
510510

511511
Translates a client route like `/foo/bar` to the full URL used in the host
512512
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.
536536

537537
> **urlFromHostPath**(`hostRoute`): `string`
538538
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)
540540

541541
Translates a host route like `/app2` to the full URL used in the host
542542
app, e.g. `https://hostapp.com/#/app2`.

0 commit comments

Comments
 (0)