@openfin/deployment

@openfin/deployment

Many desktops already have the OpenFin runtime installed and support launching your app launched via a fins link. If you wish to check to see if the OpenFin runtime and fins link support is available from your website via a standard web browser then this module provides an easy way to do that. In addition to checking if your app can be launched it can also check to ensure that all the endpoints your application needs can be reached

Install

With npm:

npm -i @openfin/deployment

With yarn:

yarn global add @openfin/deployment

With script tag:

<script src="https://cdn.openfin.co/tools/deployment/1.0.0/openfin-deployment.js"></script>

Usage

Detect the fins protocol

The checkForFinsProtocol function returns an object that reveals whether the fins protocol is supported on the desktop. If the isFinsDetectionSupported and isFinsSupported properties are true, then the fins protocol is available.

import { checkForFinsProtocol } from '@openfin/deployment';

const supportInfo = await checkForFinsProtocol(); 
if (supportInfo.isFinsDetectionSupported && supportInfo.isFinsSupported){
    // fins protocol is supported
}

Detect access to OpenFin resources

The checkEndpoints function can be called to check whether the desktop can access OpenFin resources, such as the OpenFin CDN, or any custom endpoints. The function returns an array of Endpoint objects. If the status property of the Endpoint object is true, theat resource is available.

import { checkEndpoints, Endpoint, EndpointStatus, OpenFinEndpoint } from '@openfin/deployment';

const endpointResults = await checkEndpoints();
customResult.forEach((status) => {
    console.log(status.url, status.success, status.statusCode);
});

// Check all OpenFin endpoints, excluding OpenFinEndpoint.Diagnostics.
const endpointCheckResult = await checkEndpoints([OpenFinEndpoint.Diagnostics]);

// Check additional custom endpoints.
const customEndpoints:Endpoint[] = [
    {
        id: 'OpenFin Website',
        url: 'https://openfin.co',
        displayName: 'OpenFin Website'
    }
];

const customResult = await checkEndpoints([], customEndpoints);

Enable in Desktop Owner Settings

To enable the checkForFinsProtocol function, please refer to the document for more details.

Samples

Two code samples are available that demonstrate how to detect the fins protocol and detect access to OpenFin resources. One code sample takes an ES module approach, the other uses a <script> tag.

The samples are available in OpenFin's Deployment repository.

License

Copyright 2021-2022 OpenFin Inc.

You may not run or in any way utilize the code in this package, unless you have executed an enterprise license directly with OpenFin. You can learn more about OpenFin licensing by emailing us at [e-mail] with questions.