Class InteropClient

Provides access to the OpenFin representation of the current code context (usually a document such as a OpenFin.View or OpenFin.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.

Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts.

Example

function handleIncomingContext(contextInfo) {
    const { type, id } = contextInfo;
    switch (type) {
        case 'instrument':
            handleInstrumentContext(contextInfo);
            break;
        case 'country':
            handleCountryContext(contextInfo);
            break;

        default:
            break;
    }
}


function handleInstrumentContext(contextInfo) {
    const { type, id } = contextInfo;
    console.log('contextInfo for instrument', contextInfo)
}

function handleCountryContext(contextInfo) {
    const { type, id } = contextInfo;
    console.log('contextInfo for country', contextInfo)
}

fin.me.interop.addContextHandler(handleIncomingContext);
Copy

Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.

function handleInstrumentContext(contextInfo) {
    const { type, id } = contextInfo;
    console.log('contextInfo for instrument', contextInfo)
}

function handleCountryContext(contextInfo) {
    const { type, id } = contextInfo;
    console.log('contextInfo for country', contextInfo)
}


fin.me.interop.addContextHandler(handleInstrumentContext, 'instrument')
fin.me.interop.addContextHandler(handleCountryContext, 'country')
Copy

Sends an intent to the Interop Broker to resolve.

Example

// View wants to fire an Intent after a user clicks on a ticker
tickerElement.on('click', (element) => {
    const ticker = element.innerText;
    const intent = {
        name: 'ViewChart',
        context: {type: 'fdc3.instrument', id: { ticker }}
    }

    fin.me.interop.fireIntent(intent);
})
Copy

Sends a Context that will be resolved to an Intent by the Interop Broker. This context accepts a metadata property.

Remarks

To resolve this info, the function handleFiredIntentByContext is meant to be overridden in the Interop Broker. The format for the response will be determined by the App Provider overriding the function.

Example

tickerElement.on('click', (element) => {
    const ticker = element.innerText;

    const context = {
        type: 'fdc3.instrument',
        id: {
            ticker
        }
    }

    const intentResolution = await fin.me.interop.fireIntentForContext(context);
})
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.

Example

fin.me.interop.getAllClientsInContextGroup('red')
    .then(clientsInContextGroup => {
        console.log(clientsInContextGroup)
    })
Copy

Returns the Interop-Broker-defined context groups available for an entity to join. Used by Platform Windows.

Example

fin.me.interop.getContextGroups()
        .then(contextGroups => {
            contextGroups.forEach(contextGroup => {
                console.log(contextGroup.displayMetadata.name)
                console.log(contextGroup.displayMetadata.color)
            })
        })
Copy

Gets the last context of the Context Group currently subscribed to. It takes an optional Context Type and returns the last context of that type.

Example

await fin.me.interop.joinContextGroup('yellow');
await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
const currentContext = await fin.me.interop.getCurrentContext();

// with a specific context
await fin.me.interop.joinContextGroup('yellow');
await fin.me.interop.setContext({ type: 'country', id: { ISOALPHA3: 'US' }});
await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
const currentContext = await fin.me.interop.getCurrentContext('country');
Copy

Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version. Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent. This also does not raise the FDC3Ready event.

Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version. Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent. This also does not raise the FDC3Ready event.

Gets display info for a context group

Remarks

Used by Platform Windows.

Example

fin.me.interop.getInfoForContextGroup('red')
    .then(contextGroupInfo => {
        console.log(contextGroupInfo.displayMetadata.name)
        console.log(contextGroupInfo.displayMetadata.color)
    })
Copy

Get information for a particular Intent from the Interop Broker.

Remarks

To resolve this info, the function handleInfoForIntent is meant to be overridden in the Interop Broker. The format for the response will be determined by the App Provider overriding the function.

Example

const intentInfo = await fin.me.interop.getInfoForIntent('ViewChart');
Copy

Get information from the Interop Broker on all Intents that are meant to handle a particular context.

Remarks

To resolve this info, the function handleInfoForIntentsByContext is meant to be overridden in the Interop Broker. The format for the response will be determined by the App Provider overriding the function.

Example

tickerElement.on('click', (element) => {
    const ticker = element.innerText;

    const context = {
        type: 'fdc3.instrument',
        id: {
            ticker
        }
    }

    const intentsInfo = await fin.me.interop.getInfoForIntentByContext(context);
})
Copy

Join all Interop Clients at the given identity to context group contextGroupId. If no target is specified, it adds the sender to the context group.

Remarks

Because multiple Channel connections/Interop Clients can potentially exist at a uuid/name combo, we currently join all Channel connections/Interop Clients at the given identity to the context group. If an endpointId is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group. For all intents and purposes, there will only be 1 connection present in Platform and Browser implmentations, so this point is more-or-less moot. Used by Platform Windows.

Example

joinViewToContextGroup = async (contextGroupId, view) => {
    await fin.me.interop.joinContextGroup(contextGroupId, view);
}

getLastFocusedView()
    .then(lastFocusedViewIdentity => {
        joinViewToContextGroup('red', lastFocusedViewIdentity)
    })
Copy

Join the current entity to session context group sessionContextGroupId and return a sessionContextGroup instance. If the sessionContextGroup doesn't exist, one will get created.

Remarks

Session Context Groups do not persist between runs and aren't present on snapshots.

Example

Say we want to have a Session Context Group that holds UI theme information for all apps to consume:

My color-picker View:

    const themeSessionContextGroup = await fin.me.interop.joinSessionContextGroup('theme');

    const myColorPickerElement = document.getElementById('color-palette-picker');
    myColorPickerElement.addEventListener('change', event => {
        themeSessionContextGroup.setContext({ type: 'color-palette', selection: event.value });
    });
Copy

In other views:

    const themeSessionContextGroup = await fin.me.interop.joinSessionContextGroup('theme');

    const changeColorPalette = ({ selection }) => {
        // change the color palette to the selection
    };

    // If the context is already set by the time the handler was set, the handler will get invoked immediately with the current context.
    themeSessionContextGroup.addContextHandler(changeColorPalette, 'color-palette');
Copy

Register a listener that is called when the Interop Client has been disconnected from the Interop Broker. Only one listener per Interop Client can be set.

Example

const listener = (event) => {
    const { type, topic, brokerName} = event;
    console.log(`Disconnected from Interop Broker ${brokerName} `);
}

await fin.me.interop.onDisconnection(listener);
Copy

Adds an intent handler for incoming intents. The last intent sent of the name subscribed to will be received.

Example

const intentHandler = (intent) => {
    const { context } = intent;
    myViewChartHandler(context);
};

const subscription = await fin.me.interop.registerIntentHandler(intentHandler, 'ViewChart');

function myAppCloseSequence() {
    // to unsubscribe the handler, simply call:
    subscription.unsubscribe();
}
Copy

Removes the specified target from a context group. If no target is specified, it removes the sender from their context group. Used by Platform Windows.

Example

removeViewFromContextGroup = async (view) => {
    await fin.me.interop.removeFromContextGroup(view);
}

getLastFocusedView()
    .then(lastFocusedViewIdentity => {
        removeViewFromContextGroup(lastFocusedViewIdentity)
    })
Copy

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

Remarks

The entity must be part of a context group in order set a context.

Example

setInstrumentContext = async (ticker) => {
    fin.me.interop.setContext({type: 'instrument', id: {ticker}})
}

// The user clicks an instrument of interest. We want to set that Instrument context so that the rest of our workflow updates with information for that instrument
instrumentElement.on('click', (evt) => {
    setInstrumentContext(evt.ticker)
})
Copy