@openfin/cloud-interop

@openfin/cloud-interop

This package contains an override that enables Cloud Interop for OpenFin InteropBroker's unlocking Interop across applications and devices.

Overrides are passed to fin.Platform.init when initializing a platform or to fin.Interop.init when creating an InteropBroker directly.

Once overriden the InteropBroker will connect to Cloud Interop. Context will be sent to the Cloud Interop server and the broker will receive Context updates from other any other connected brokers in the shared session.

Auth

Using the service currently requires user credentials provided by OpenFin, please contact [e-mail].

Usage

In a Platform:

import { cloudInteropOverride } from "@openfin/cloud-interop";
import { ExampleOverride } from "./example";

const cloudConfig = {
  userId: "andy", // Credentials provided by OpenFin
  password: "asdf1234", // Credentials provided by OpenFin
  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // Shared identifier for apps that should communicate
  url: "<CLOUD_INTEROP_SERVER_URL>",
  sourceId: fin.me.identity.uuid,
  source: "Desktop",
};

const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);

// Ordering is important, ensure Cloud Interop Override is at the end of the list to send overriden Context to the cloud
await fin.Platform.init({
  interopOverride: [ExampleOverride, InitializedCloudInteropOverride],
});

When creating an InteropBroker directly:

import { cloudInteropOverride } from "@openfin/cloud-interop";

const cloudConfig = {
  userId: "andy", // Credentials provided by OpenFin
  password: "asdf1234", // Credentials provided by OpenFin
  platformId: "8cef8205-d5a8-41c4-b368-47475b32c019", // Shared identifier for apps that should communicate
  url: "<CLOUD_INTEROP_SERVER_URL>",
  sourceId: fin.me.identity.uuid,
  source: "Desktop",
};

const InitializedCloudInteropOverride = await cloudInteropOverride(cloudConfig);

await fin.Interop.init(fin.me.uuid, InitializedCloudInteropOverride);