Class InteropBroker

Provides access to the OpenFin representation of the current code context (usually a document such as a View or Window), as well as to the current Interop context.

Useful for debugging in the devtools console, where this will intelligently type itself based on the context in which the devtools panel was opened.

Helper function for InteropBroker.joinContextGroup. Does the work of actually adding the client to the Context Group. Used by Platform Windows.

Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async clientDisconnected(clientIdentity) {
                const { uuid, name } = clientIdentity;
                console.log(`Client with identity ${uuid}/${name} has been disconnected`);
            }
        }
        return new Override();
    }
});
Copy

Responsible for resolving the fdc3.findInstances call. Must be overridden

Responsible for resolving the fdc3.getAppMetadata call. Must be overridden

Responsible for resolving fdc3.getInfo for FDC3 2.0 Would need to return the optionalFeatures and appMetadata for the ImplementationMetadata. Must be overridden.

Responsible for resolving an fdc3.open call. Must be overridden.

Returns an array of info for each Interop Client connected to the Interop Broker.

FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating an AppIdentifier.

Remarks

FDC3 2.0 Note: When needing an instanceId to generate an AppIdentifier use this call to get the endpointId and use it as the instanceId. In the Example below we override handleFiredIntent and then call super.getAllClientInfo to generate the AppIdentifier for the IntentResolution.

Example

// FDC3 2.0 Example:
fin.Platform.init({
    interopOverride: async (InteropBroker, ...args) => {
        class Override extends InteropBroker {
            async handleFiredIntent(intent) {
                super.setIntentTarget(intent, { uuid: 'platform-uuid', name: 'intent-view' });
                const platform = fin.Platform.getCurrentSync();
                const win = fin.Window.wrapSync({ name: 'foo', uuid: 'platform-uuid' });
                const createdView = await platform.createView({ url: 'http://openfin.co', name: 'intent-view' }, win.identity);

                const allClientInfo = await super.getAllClientInfo();

                const infoForTarget = allClientInfo.find((clientInfo) => {
                    return clientInfo.uuid === 'platform-uuid' && clientInfo.name === 'intent-view';
                });

                const source = {
                    appId: 'intent-view',
                    instanceId: infoForTarget.endpointId
                }

                return {
                    source,
                    intent: intent.name
                }

            }
        }
        return new Override(...args);
    }
});
Copy

Gets all clients for a context group.

Remarks

This is primarily used for platform windows. Views within a platform should not have to use this API. Returns the Interop-Broker-defined context groups available for an entity to join.

Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead. Used by Platform Windows.

Get current context for a client subscribed to a Context Group.

Remarks

It takes an optional Context Type argument and returns the last context of that type.

Gets display info for a context group

Remarks

Used by Platform Windows.

Responsible for launching of applications that can handle a given intent, and delegation of intents to those applications. Must be overridden.

Remarks

To make this call FDC3-Compliant it would need to return an IntentResolution.

interface IntentResolution {
  source: TargetApp;
  // deprecated, not assignable from intent listeners
  data?: object;
  version: string;
}
Copy

More information on the IntentResolution type can be found in the FDC3 documentation.

Example

// override call so we set intent target and create view that will handle it
fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async handleFiredIntent(intent) {
                super.setIntentTarget(intent, { uuid: 'platform-uuid', name: 'intent-view' });
                const platform = fin.Platform.getCurrentSync();
                const win = fin.Window.wrapSync({ name: 'foo', uuid: 'platform-uuid' });
                const createdView = await platform.createView({ url: 'http://openfin.co', name: 'intent-view' }, win.identity);
            }
        }
        return new Override();
    }
});
Copy

Responsible for resolving an Intent based on a specific Context. Must be overridden.

Remarks

Whenever InteropClient.fireIntentForContext is called this function will fire. The contextForIntent argument gives you access to the context that will be resolved to an intent. It also can optionally contain any metadata relevant to resolving it, like a specific app the client wants the context to be handled by. The clientIdentity is the identity of the client that made the call.

To make this call FDC3-Compliant it would need to return an IntentResolution:

// {
//     intent: { name: "StartChat", displayName: "Chat" },
//     apps: [{ name: "Skype" }, { name: "Symphony" }, { name: "Slack" }]
// }
Copy

More information on the IntentResolution type can be found in the FDC3 documentation.

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async handleFiredIntentForContext(contextForIntent, clientIdentity) {
                // Your code goes here.
            }
        }
        return new Override();
    }
});
Copy

Responsible for returning information on a particular Intent.

Remarks

Whenever InteropClient.getInfoForIntent is called this function will fire. The options argument gives you access to the intent name and any optional context that was passed and clientIdentity is the identity of the client that made the call. Ideally here you would fetch the info for the intent and return it with the shape that the InteropClient.getInfoForIntent call is expecting.

To make this call FDC3-Compliant it would need to return an App Intent:

// {
//     intent: { name: "StartChat", displayName: "Chat" },
//     apps: [{ name: "Skype" }, { name: "Symphony" }, { name: "Slack" }]
// }
Copy

More information on the AppIntent type can be found in the FDC3 documentation.

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async handleInfoForIntent(options, clientIdentity) {
                // Your code goes here.
            }
        }
        return new Override();
    }
});
Copy

Responsible for returning information on which Intents are meant to handle a specific Context. Must be overridden.

Remarks

Responsible for returning information on which Intents are meant to handle a specific Context. Must be overridden.

Whenever InteropClient.getInfoForIntentsByContext is called this function will fire. The context argument gives you access to the context that the client wants information on and clientIdentity is the identity of the client that made the call. Ideally here you would fetch the info for any intent that can handle and return it with the shape that the InteropClient.getInfoForIntentsByContext call is expecting.

To make this call FDC3-Compliant it would need to return an array of AppIntents:

// [{
//     intent: { name: "StartCall", displayName: "Call" },
//     apps: [{ name: "Skype" }]
// },
// {
//     intent: { name: "StartChat", displayName: "Chat" },
//     apps: [{ name: "Skype" }, { name: "Symphony" }, { name: "Slack" }]
// }];
Copy

More information on the AppIntent type can be found in the FDC3 documentation.

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async handleInfoForIntentsByContext(context, clientIdentity) {
                // Your code goes here.
            }
        }
        return new Override();
    }
});
Copy

This function is called by the Interop Broker whenever a Context handler would fire. For FDC3 2.0 you would need to override this function and add the contextMetadata as part of the Context object. Then would you need to call super.invokeContextHandler passing it this new Context object along with the clientIdentity and handlerId

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async invokeContextHandler(clientIdentity, handlerId, context) {
                return super.invokeContextHandler(clientIdentity, handlerId, {
                    ...context,
                    contextMetadata: {
                        source: {
                            appId: 'openfin-app',
                            instanceId: '3D54D456D9HT0'
                        }
                    }
                });
            }
        }
        return new Override();
    }
});
Copy

This function is called by the Interop Broker whenever an Intent handler would fire. For FDC3 2.0 you would need to override this function and add the contextMetadata as part of the Context object inside the Intent object. Then would you need to call super.invokeIntentHandler passing it this new Intent object along with the clientIdentity and handlerId

Example

fin.Platform.init({
    interopOverride: async (InteropBroker) => {
        class Override extends InteropBroker {
            async invokeIntentHandler(clientIdentity, handlerId, context) {
                const { context } = intent;
                return super.invokeIntentHandler(clientIdentity, handlerId, {
                    ...intent,
                    context: {
                        ...context,
                        contextMetadata: {
                            source: {
                                appId: 'openfin-app',
                                instanceId: '3D54D456D9HT0'
                            }
                        }
                    }
                });
            }
        }
        return new Override();
    }
});
Copy

Called before every action to check if this entity should be allowed to take the action. Return false to prevent the action

Can be used to completely prevent a connection. Return false to prevent connections. Allows all connections by default.

Join all connections at the given identity (or just one if endpointId provided) to context group contextGroupId. If no target is specified, it adds the sender to the context group. joinContextGroup is responsible for checking connections at the incoming identity. It calls InteropBroker.addClientToContextGroup to actually group the client. Used by Platform Windows.

Helper function for InteropBroker.removeFromContextGroup. Does the work of actually removing the client from the Context Group. Used by Platform Windows.

Removes the specified target from a context group. If no target is specified, it removes the sender from their context group. removeFromContextGroup is responsible for checking connections at the incoming identity.

Remarks

It calls InteropBroker.removeClientFromContextGroup to actually ungroup the client. Used by Platform Windows.

Sets a context for the context group of the incoming current entity.

Should be called in InteropBroker.handleFiredIntent. While handleFiredIntent is responsible for launching applications, setIntentTarget is used to tell the InteropBroker which application should receive the intent when it is ready.