Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions apps/ifc-example-client/client-worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@ try {
const api = request.api;
console.log("worker: Got exercise API request from host", request);

if(client[api] && typeof client[api] == 'function') {
client[api](request.data);
if (client[api] && typeof client[api] == "function") {
client[api](request.data);
} else {
console.log(`Unrecognized API: ${api}`)
console.log(`Unrecognized API: ${api}`);
}

})

});

console.log("Sending client start");
client.start();
Expand Down
1 change: 0 additions & 1 deletion apps/ifc-example-client/ifc-cli.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ module.exports = function (frameRouter, workerPool) {
},
};


return {
// These are the topics that the host app should display payloads for when
// the client publishes on them.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**iframe-coordinator v6.5.0**

***
---

# iframe-coordinator

Expand Down
18 changes: 9 additions & 9 deletions docs/client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[**iframe-coordinator v6.5.0**](../README.md)

***
---

[iframe-coordinator](../modules.md) / client

Expand Down Expand Up @@ -29,49 +29,49 @@

Re-exports [Breadcrumb](../messages/interfaces/Breadcrumb.md)

***
---

### EnvData

Re-exports [EnvData](../messages/interfaces/EnvData.md)

***
---

### KeyData

Re-exports [KeyData](../messages/interfaces/KeyData.md)

***
---

### ModalRequest

Re-exports [ModalRequest](../messages/interfaces/ModalRequest.md)

***
---

### NavRequest

Re-exports [NavRequest](../messages/interfaces/NavRequest.md)

***
---

### Notification

Re-exports [Notification](../messages/interfaces/Notification.md)

***
---

### PageMetadata

Re-exports [PageMetadata](../messages/interfaces/PageMetadata.md)

***
---

### PromptOnLeave

Re-exports [PromptOnLeave](../messages/interfaces/PromptOnLeave.md)

***
---

### Publication

Expand Down
54 changes: 27 additions & 27 deletions docs/client/classes/Client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[**iframe-coordinator v6.5.0**](../../README.md)

***
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All this noise should go away now that we will run prettier after doc generation


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

Expand Down Expand Up @@ -56,7 +56,7 @@ custom data sent by the host.

`AbstractClient.environmentData`

***
---

### messaging

Expand Down Expand Up @@ -116,7 +116,7 @@ The handler which receives a notification when an event of the specified type oc

`AbstractClient.addListener`

***
---

### ~~asHostUrl()~~

Expand Down Expand Up @@ -147,7 +147,7 @@ Use the new [urlFromClientPath](#urlfromclientpath) method instead

`AbstractClient.asHostUrl`

***
---

### clearPromptOnLeave()

Expand All @@ -165,7 +165,7 @@ Asks the host application to clear the prompt on leave dialog.

`AbstractClient.clearPromptOnLeave`

***
---

### publish()

Expand All @@ -191,7 +191,7 @@ The data object to be published.

`AbstractClient.publish`

***
---

### registerCustomElements()

Expand All @@ -205,7 +205,7 @@ Registers custom elements used by the client application

`void`

***
---

### removeAllListeners()

Expand All @@ -231,7 +231,7 @@ A string which specifies the type of event for which to remove an event listener

`AbstractClient.removeAllListeners`

***
---

### removeListener()

Expand Down Expand Up @@ -263,7 +263,7 @@ The event handler to remove from the event target.

`AbstractClient.removeListener`

***
---

### requestModal()

Expand Down Expand Up @@ -292,7 +292,7 @@ the ID and any data specific to the modal instance required

`AbstractClient.requestModal`

***
---

### requestNavigation()

Expand Down Expand Up @@ -323,7 +323,7 @@ a description of where the client wants to navigate the app to.

`AbstractClient.requestNavigation`

***
---

### requestNotification()

Expand All @@ -334,7 +334,7 @@ Defined in: [AbstractClient.ts:351](https://github.com/purecloudlabs/iframe-coor
Asks the host application to display a user notification.

The page embedding the client app is responsible for handling the fired custom event and
presenting/styling the notification. Application-specific concerns such as level, TTLs,
presenting/styling the notification. Application-specific concerns such as level, TTLs,
ids for action callbacks (notification click, notification action buttons), etc. can be passed via
the `custom` property of the `notification` type.

Expand All @@ -353,32 +353,32 @@ the desired notification configuration.
#### Examples

```typescript
client.requestNotification({ title: 'Hello world' });
client.requestNotification({ title: "Hello world" });
```

```typescript
client.requestNotification({
title: 'Hello',
message: 'World'
title: "Hello",
message: "World",
});
```

```typescript
client.requestNotification({
title: 'Hello',
message: 'World',
title: "Hello",
message: "World",
custom: {
displaySeconds: 5,
level: 'info'
}
level: "info",
},
});
```

#### Inherited from

`AbstractClient.requestNotification`

***
---

### requestPromptOnLeave()

Expand All @@ -402,7 +402,7 @@ Asks the host application to display a prompt on leave dialog.

`AbstractClient.requestPromptOnLeave`

***
---

### sendPageMetadata()

Expand Down Expand Up @@ -432,7 +432,7 @@ data that will be used for display in host application and browser page title

`AbstractClient.sendPageMetadata`

***
---

### start()

Expand All @@ -450,7 +450,7 @@ Initiates responding to events triggered by the host application.

`AbstractClient.start`

***
---

### startInterceptingLinks()

Expand All @@ -467,7 +467,7 @@ links that you may not want to intercept.

`void`

***
---

### stop()

Expand All @@ -486,7 +486,7 @@ the sake of API completeness. It's unlikely to be used by most applications.

`AbstractClient.stop`

***
---

### stopInterceptingLinks()

Expand All @@ -500,7 +500,7 @@ Turns off the behavior of intercepting link clicks in the client window click ha

`void`

***
---

### urlFromClientPath()

Expand Down Expand Up @@ -530,7 +530,7 @@ The /-separated path within the client app to link to.

`AbstractClient.urlFromClientPath`

***
---

### urlFromHostPath()

Expand Down
Loading