HERE Core

https://resources.here.io/docs/core
Admin
HERE Core is a web-technology operating environment designed for enterprise app development,...
Tokens:220,670
Snippets:2,518
Trust Score:8.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build the example locally

Source: https://resources.here.io/docs/core/develop

Use this command to set up the example application locally before starting the test server.

```bash
npm run setup
```

--------------------------------

### C# Provider Setup

Source: https://resources.here.io/docs/core/container/interop/channels

Create a channel provider and handle client connections and topic registrations. Use OpenAsync to start listening for connections.

```csharp
static async void MakeProvider()
  {
    var fin = GetRuntime();

    var providerBus = fin.InterApplicationBus.Channel.CreateProvider("channelName");
    await providerBus.OpenAsync();

    providerBus.Opened += (identity, payload) =>
    {
      Console.WriteLine("Client connection request identity: ", identity?.ToString());
      Console.WriteLine("Client connection request payload: ", payload?.ToString());
    };

    providerBus.RegisterTopic<Object>("topic", (payload, client) =>
    {
      Console.WriteLine("Action dispatched by client: ", client.RemoteEndpoint);
      Console.WriteLine("Payload sent in dispatch: ", payload?.ToString());
    });
  }

```

--------------------------------

### Install @openfin/core-web

Source: https://resources.here.io/docs/core/container/interop/api/web-interop

Run this command to install the HERE Core Web package.

```bash
npm i @openfin/core-web -S  
```

--------------------------------

### Run the examples application

Source: https://resources.here.io/docs/core/develop

Execute this command to launch the examples application after the test server is running.

```bash
npm run client
```

--------------------------------

### Example startup_app Options

Source: https://resources.here.io/docs/core/develop/manifests

This example demonstrates common options for the startup_app object, including application identification, display settings, and content navigation rules.

```json
"startup_app": {
    "name": "APP_NAME",
    "icon": "http://SERVER_NAME/PATH/ICON_FILE.ico",
    "description": "APP_NAME",
    "url": "http://SERVER_NAME/PATH/START_PATH.html",
    "uuid": "UUID",
    "backgroundColor": "#fffff",
    "contextMenu": true,
    "contentNavigation": {
        "whitelist": ["https://ALLOWED_DOMAIN/*"]
    },
    "autoShow": true,
    "defaultWidth": 480,
    "maxWidth": 480,
    "minWidth": 480,
    "maxHeight": 50,
    "defaultHeight": 50,
    "minHeight": 50,
    "defaultTop": 50,
    "defaultLeft": 10,
    "resizable": false,
    "maximizable": false,
    "frame": false,
    "cornerRounding": {
        "width": 5,
        "height": 5,
    },
    "taskbarIconGroup": "APP_GROUP",
    "loadErrorMessage": "There was an error loading the application."
}

```

--------------------------------

### Start a local test server

Source: https://resources.here.io/docs/core/develop

This command starts a local test server to serve the application files.

```bash
npm run start
```

--------------------------------

### Install Snap SDK Client with npm

Source: https://resources.here.io/docs/core/container/windows/snap

Use this command to download and install the Snap SDK package using npm. Specify @SNAP_SDK_VERSION for a particular version; otherwise, the current version is installed.

```bash
npm install @openfin/snap-sdk@SNAP_SDK_VERSION
```

--------------------------------

### Install Snap SDK Client with yarn

Source: https://resources.here.io/docs/core/container/windows/snap

Use this command to download and install the Snap SDK package using yarn. Specify @SNAP_SDK_VERSION for a particular version; otherwise, the current version is installed.

```bash
yarn add @openfin/snap-sdk@SNAP_SDK_VERSION
```

--------------------------------

### Example Shortcut Object Properties

Source: https://resources.here.io/docs/core/develop/manifests

Demonstrates the structure and common properties used to define an application shortcut in a manifest file. This includes settings for company, description, icon, name, target locations, and start menu folder.

```json
"shortcut": {
    "company": "COMPANY_NAME",
    "description": "APP_DESCRIPTION",
    "icon": "http://SERVER_NAME/PATH/ICON_FILE.ico",
    "name": "APP_NAME",
    "target": ["desktop", "start-menu","automatic-start-up"],
    "startMenuRootFolder": "FOLDER_NAME"
}
```

--------------------------------

### Start Snap SDK Server

Source: https://resources.here.io/docs/core/container/windows/snap

Start the SnapServer object. The start method takes an optional ServerOptions object to configure the server's behavior and appearance.

```APIDOC
## Start Snap SDK Server

Start the SnapServer object. The start method takes an optional `ServerOptions` object.
```typescript
// Download and start Here Snap SDK.
await snapServer.start({
  theme: "snap-light1",
  taskbarIcon: "http://here.io/favicon.ico",
  taskbarIconGroup: "openfin_apps_group.my-group",
  hideTaskbarEntry: true,
  keyToStick: true,
});
```

This method starts the Snap SDK service as a hidden application. `OpenFinSnap.exe` appears in the Windows Task Manager.
```

--------------------------------

### Example Content Creation Rule Configuration

Source: https://resources.here.io/docs/core/container/layouts/content-creation-rules

A comprehensive example demonstrating rule precedence and various behaviors (window, browser, view, block) with specific match patterns and options.

```javascript
const contentCreationOptions = {
  rules: [
    {
      behavior: 'window',
      match: [
        '*://*.stackoverflow.com/*'
      ],
      options: {
        'frame': false,
        'alwaysOnTop': true,
        'defaultWidth': 800,
        'defaultHeight': 600
      }
    },
    {
      behavior: 'browser',
      match: [
        '*://*.gitlab.com/*'
      ]
    },
    {
      behavior: 'view',
      match: [
        '*://*.reddit.com/r/javascript'
      ],
      options: {
        'title': '...loading'
      }
    },
    {
      behavior: 'block',
      match: [
        '*://*.reddit.com/*'
      ]
    },
    {
      behavior: 'window',
      match: [
        '*://*/*?window=true'
      ]
    },
    {
      behavior: 'view',
      match: [
        '<all_urls>'
      ]
    }
  ]
}
```

--------------------------------

### Install @openfin/notifications Package

Source: https://resources.here.io/docs/core/hc-ui/notifications/get-started/register

Install the necessary package for the HERE notification center client library using npm.

```bash
npm install @openfin/notifications  

```

--------------------------------

### Complete Download Bubble Example

Source: https://resources.here.io/docs/core/container/windows/download-bubble

This example demonstrates setting color theme overrides for a download bubble and handling download button visibility, icon updates, and full download history requests within a BrowserWindow.

```javascript
// Set color theme for download bubble  
app.setColorProvidersOverrides([  
    {  
        colorProviderKey: { colorMode: 'light' },  
        colorsMap: {  
            'kColorBubbleBackground': 0xFFF5F5F5,  
            'kColorDialogBackground': 0xFFFFFFFF,  
            'kColorLabelForeground': 0xFF000000  
        }  
    },  
    {  
        colorProviderKey: { colorMode: 'dark' },  
        colorsMap: {  
            'kColorBubbleBackground': 0xFF2D2D2D,  
            'kColorDialogBackground': 0xFF1E1E1E,  
            'kColorLabelForeground': 0xFFFFFFFF  
        }  
    }  
]);  
  
app.whenReady().then(() => {  
    const win = new BrowserWindow({  
        width: 1200,  
        height: 800,  
        webPreferences: {  
            nodeIntegration: true,  
            contextIsolation: false  
        }  
    });  
  
    win.loadFile('index.html');  
  
    // Handle download button visibility  
    win.on('download-button-visibility-changed', (isVisible) => {  
        win.webContents.send('toggle-download-button', isVisible);  
    });  
  
    // Handle download button appearance updates  
    win.on('update-download-button-icon', (event) => {  
        win.webContents.send('update-download-button', event);  
    });  
  
    // Handle full download history request  
    win.on('show-all-downloads', () => {  
        win.loadURL('chrome://downloads');  
    });  
});  
```

--------------------------------

### Initialize Runtime and Connect

Source: https://resources.here.io/docs/core/adapters/cpp-api

Demonstrates how to get an instance of the HERE Core runtime and establish a connection.

```APIDOC
## Initialize Runtime and Connect

### Description
Get an instance of the HERE Core runtime and establish a connection.

### Code
```cpp
auto factory = OpenFinAdapterApi::RuntimeFactory();
auto runtime = factory.getRuntimeInstance(runtimeOptions);
runtime->connectAsync().get();
```
```

--------------------------------

### Example Multi-Runtime Security Realm Configuration

Source: https://resources.here.io/docs/core/manage/security

This example demonstrates configuring both a security realm and enabling multi-runtime features using the '--enable-mesh' flag within the runtime arguments.

```json
},
    "runtime": {
        "arguments": "--security-realm=[MYREALMID] --enable-mesh",
        "version": "beta",
        "forceLatest": true
    },

```

--------------------------------

### Download Bubble Implementation Example

Source: https://resources.here.io/docs/core/container/windows/download-bubble

This example demonstrates a complete download bubble implementation with a custom download button, including setting color theme overrides and handling window events.

```APIDOC
## Complete Example: Download Bubble Implementation

The following example demonstrates a complete download bubble implementation with a custom download button.

### Setting Color Theme Overrides

```javascript
app.setColorProvidersOverrides([
    {
        colorProviderKey: { colorMode: 'light' },
        colorsMap: {
            'kColorBubbleBackground': 0xFFF5F5F5,
            'kColorDialogBackground': 0xFFFFFFFF,
            'kColorLabelForeground': 0xFF000000
        }
    },
    {
        colorProviderKey: { colorMode: 'dark' },
        colorsMap: {
            'kColorBubbleBackground': 0xFF2D2D2D,
            'kColorDialogBackground': 0xFF1E1E1E,
            'kColorLabelForeground': 0xFFFFFFFF
        }
    }
]);
```

### Window Initialization and Event Handling

```javascript
app.whenReady().then(() => {
    const win = new BrowserWindow({
        width: 1200,
        height: 800,
        webPreferences: {
            nodeIntegration: true,
            contextIsolation: false
        }
    });

    win.loadFile('index.html');

    // Handle download button visibility
    win.on('download-button-visibility-changed', (isVisible) => {
        win.webContents.send('toggle-download-button', isVisible);
    });

    // Handle download button appearance updates
    win.on('update-download-button-icon', (event) => {
        win.webContents.send('update-download-button', event);
    });

    // Handle full download history request
    win.on('show-all-downloads', () => {
        win.loadURL('chrome://downloads');
    });
});
```
```

--------------------------------

### Start Snap SDK Server

Source: https://resources.here.io/docs/core/container/windows/snap

Start the SnapServer object with optional ServerOptions to configure its behavior, such as theme and taskbar icon.

```typescript
// Download and start Here Snap SDK.
await snapServer.start({
  theme: "snap-light1",
  taskbarIcon: "http://here.io/favicon.ico",
  taskbarIconGroup: "openfin_apps_group.my-group",
  hideTaskbarEntry: true,
  keyToStick: true,
});
```

--------------------------------

### Install @openfin/core package

Source: https://resources.here.io/docs/core/container/develop/typescript-types

Install the necessary package to use HERE Core Container API types in your project. This package includes a shim for the `fin` object.

```bash
npm install --save @openfin/core  

```

--------------------------------

### Install @openfin/core-web Package

Source: https://resources.here.io/docs/core/container/layouts/web-layouts

Install the @openfin/core-web package using npm to enable Web Layouts and interoperability features in your web application.

```bash
npm install @openfin/core-web -S
```

--------------------------------

### Install HERE NWI Library

Source: https://resources.here.io/docs/core/container/layouts/native-snapshots

Install the HERE Native Window Interface (NWI) library using npm. This is the first step to gathering state information for native apps.

```bash
npm i @openfin/native-window-integration-client  
```

--------------------------------

### Example Security Realm Configuration

Source: https://resources.here.io/docs/core/manage/security

This example shows how to integrate the security realm argument within a full application runtime configuration. The realm value can be any string valid as a Windows folder name.

```json
},
    "runtime": {
        "arguments": "--security-realm=[MYREALMID]",
        "version": "beta",
        "forceLatest": true
    },

```

--------------------------------

### Import and Get Excel Application

Source: https://resources.here.io/docs/core/integrations/excel

Import the getExcelApplication function and call it to start controlling Excel. The first call downloads and starts a .NET adapter process.

```javascript
import { getExcelApplication } from '@openfin/excel';

const excel = await getExcelApplication();
```

--------------------------------

### Example Request using CURL

Source: https://resources.here.io/docs/core/log-manager/get-all-users-within-a-application

This example shows how to make a GET request to the user-names endpoint using CURL. Remember to replace ':application' with your actual application name.

```curl
curl -L 'https://resources.here.io/api/v1/applications/:application/user-names' \
-H 'Accept: application/json'
```

--------------------------------

### Example Usage in React

Source: https://resources.here.io/docs/core/hc-ui/customize/schemes

This React component demonstrates how to use `getSelectedScheme` to get the current theme and `setSelectedScheme` to update it, providing a dropdown for user selection.

```APIDOC
## Example: Theme Selection Component

This example shows a React component that allows users to select their preferred color scheme.

```javascript
const ThemeDropDown = () => {
    const currentScheme = getSelectedScheme();
    const [schemeOnSelect, setSchemeOnSelect] = useState(currentScheme);
    const selectThemeRef = useRef<HTMLSelectElement>();

    const onThemeSelection = useCallback(async () => {
        const key = selectThemeRef.current?.value as ColorSchemeOptionType;
        await setSelectedScheme(key);
    }, [schemeOnSelect]);

    const handleSetTheme = (e) => {
        setSchemeOnSelect(e.target.value);
    };

    const themes = ['dark', 'light', 'system'];
    return (
        <select ref={selectThemeRef} onChange={handleSetTheme} defaultValue={schemeOnSelect}>
            {themes.map((theme) => (
                <option key={theme} value={theme}>
                    {theme}
                </option>
            ))}
        </select>
        <Button onClick={onThemeSelection}>Set Theme</Button>
    );
};
```
```

--------------------------------

### Initialize Excel Application

Source: https://resources.here.io/docs/core/integrations/excel

Import and call `getExcelApplication` to get an object for controlling Excel. This function downloads and starts a .NET adapter process on the first call.

```APIDOC
## Initialize Excel Application

### Description
Import and call `getExcelApplication` to obtain an object that allows you to control the Excel application.

### Method
`getExcelApplication()`

### Usage
```javascript
import { getExcelApplication } from '@openfin/excel';

const excel = await getExcelApplication();
```
```

--------------------------------

### JavaScript Provider Setup

Source: https://resources.here.io/docs/core/container/interop/channels

Create a channel and register actions and connection listeners. Reject connections by throwing an error in onConnection.

```javascript
async function makeProvider() {
  // entity creates a channel and becomes the channelProvider
  const providerBus = await fin.InterApplicationBus.Channel.create('channelName');

  providerBus.onConnection((identity, payload) => {
    // can reject a connection here by throwing an error
    console.log('Client connection request identity: ', JSON.stringify(identity));
    console.log('Client connection request payload: ', JSON.stringify(payload));
  });

  providerBus.register('topic', (payload, identity) => {
    // register a callback for a 'topic' to which clients can dispatch an action
    console.log('Action dispatched by client: ', JSON.stringify(identity));
    console.log('Payload sent in dispatch: ', JSON.stringify(payload));
  });
}

```

--------------------------------

### Java Provider Setup

Source: https://resources.here.io/docs/core/container/interop/channels

Set up a channel provider using Java, registering listeners for client connections and actions. Reject connections by throwing an exception in onClientConnect.

```java
public void makeProvider() {
  desktopConnection.getChannel(CHANNEL_NAME).createAsync().thenAccept(provider -> {
    provider.addProviderListener(new ChannelProviderListener() {
      @Override
      public void onClientConnect(ChannelClientConnectEvent connectionEvent) throws Exception {
        logger.info(String.format("provider receives client connect event from %s ", connectionEvent.getUuid()));
        JSONObject payload = (JSONObject) connectionEvent.getPayload();
        if (payload != null) {
          String name = payload.optString("name");
          if ("badguy".equals(name)) {
              // throw exception here to reject the connection
              throw new Exception("stay out");
          }
        }
      }
      @Override
      public void onClientDisconnect(ChannelClientConnectEvent connectionEvent) {
        logger.info(String.format("provider receives channel disconnect event from %s ", connectionEvent.getUuid()));
      }
    });

    provider.register("topic", new ChannelAction() {
      @Override
      public JSONObject invoke(String action, Object payload, JSONObject senderIdentity) {
        logger.info(String.format("provider processing action %s, payload=%s", action, payload.toString()));
        JSONObject obj = new JSONObject();
        obj.put("response", "123");
        return obj;
      }
    });
  });
}

```

--------------------------------

### Windows Application Shortcut Target

Source: https://resources.here.io/docs/core/manage/deployment/apps/install

This is the target format for application shortcuts created by the installer on Windows. It links the server-hosted manifest file to a desktop or Start Menu item.

```bash
%localappdata%\OpenFin\OpenFinRVM.exe  --config="https://APP_SERVER.com/PATH_TO_APP/APP_MANIFEST.json"  
```

--------------------------------

### Configure Trusted Extension Server URLs in Desktop Owner Settings

Source: https://resources.here.io/docs/core/container/develop/ms-sso

Administrators can define trusted server URLs for the Microsoft Single Sign-On extension using the 'extensionServerURLs' property in desktop owner settings. This ensures secure installation sources. The property can be refreshed when starting an application in RVM version 16 or later.

```json
{ "desktopSettings": {
    ...
    "extensionServerURLs": [
      "https://clients2.google.com/service/update2/crx",
      "https://clients2.google.com",
      "https://CUSTOM-EXTENSIONS-STORE.EXAMPLE.com",
      "https://ANOTHER-EXTENSIONS-STORE.com"
    ]
  }
}
```

--------------------------------

### Install Workspace Package

Source: https://resources.here.io/docs/core/hc-ui/home

Install the Workspace npm package using npm. The -E flag ensures the exact version is installed.

```bash
npm i -E @openfin/workspace  
```

--------------------------------

### Launch Platform with CLI

Source: https://resources.here.io/docs/core/container/platform

Use the 'openfin -l -c' command to launch a platform application using a specified manifest file. Ensure the manifest file is saved locally.

```bash
openfin -l -c app.json
```

--------------------------------

### Set Download Configuration

Source: https://resources.here.io/docs/core/develop/security/file-download

Set the download configuration, prompting the user for PNG and JPG downloads on example.com subdomains. This method is available in Runtime v33 and later.

```javascript
// Set the download configuration.  

const newDomainSettings = {
  rules: [
    {
      match: [
        '*/*.example.com'
      ],
      options: {
        downloadSettings: {
          rules: [
            {
              match: [
                '*://*/*.png', '*://*/*.jpg'
              ],
              behavior: 'prompt'
            }
          ]
        }
      }
    }
  ]
}

await fin.System.setDomainSettings(newDomainSettings);

```

--------------------------------

### Discover and Get Worksheets

Source: https://resources.here.io/docs/core/integrations/excel

Retrieve all worksheets within a workbook, get a specific worksheet by name, or get the currently active worksheet. A new worksheet can also be added.

```javascript
// Output the names of all worksheets in the workbook to the console
const worksheets = await workbook.getWorksheets();
worksheets.forEach(async (worksheet) => {
  const worksheetName = await worksheet.getName();
  console.log(worksheetName);
});

// Get the worksheet named "Sheet 1"
const sheet1 = await workbook.getWorksheetByName('Sheet 1');

// Get the current active worksheet
const activeWorksheet = await workbook.getActiveWorksheet();

// Create a new worksheet
const worksheet = await workbook.addWorksheet();
```

--------------------------------

### startFromManifest

Source: https://resources.here.io/docs/core/container/platform

Launches content into the platform using a manifest. If the manifest contains a snapshot object, that snapshot is launched.

```APIDOC
## startFromManifest

### Description
Launches content into the platform from a specified manifest. If the manifest includes a snapshot, it will be launched.

### Method
`platform.startFromManifest(manifestUrl)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Assuming 'platform' is an instance of fin.Platform
// platform.startFromManifest('path/to/manifest.json');
```

### Response
#### Success Response (200)
This method does not return a value upon success.

#### Response Example
None
```

--------------------------------

### Version 4.0 Desktop Owner Settings

Source: https://resources.here.io/docs/core/manage/deployment/hc-ui/dos-settings

Example configuration for version 4.0, showcasing various options like icon URL, window title, hotkeys, and error reporting.

```json
{
  "desktopSettings": {
    "systemApps": {
      "workspace": {
        "version": "4.0",
        "customConfig": {
          "style": {
            "iconUrl": "https://yourserver/favicon-16x16.png"
          },
          "browserWindowTitle": "MyCompany Browser",
          "hotkeys" : {
            "toggleHomeVisibility": "CommandOrControl+Space"
          },
          "errorReporting" : {
            "sentryEnabled" : false
          },
          "flags" : {
            "WorkspaceDockEnabled" : true,
          }
        }
      }
    }
  }
}

```

--------------------------------

### Example supportInformation Object

Source: https://resources.here.io/docs/core/develop/manifests

Demonstrates how to configure support information for the app load error dialog, including company name, product name, email, error forwarding, and troubleshooting URL.

```json
"supportInformation" : {
    "company": "COMPANY_NAME",
    "product": "PRODUCT_NAME",
    "email": "EMAIL_ADDRESS",
    "forwardErrorReports": true,
    "moreInfoUrl": "TROUBLESHOOTING_INFO_URL"
}
```

--------------------------------

### Download Rules in App Manifest

Source: https://resources.here.io/docs/core/develop/security/file-download

Configure download rules for PNG and JPEG files on all subdomains of example.com to be downloaded without prompting the user. This applies to the startup_app manifest.

```json
{
  "startup_app" :{
    "domainSettings": {
      "rules": [
        {
          "match": [
            "*/*.example.com"
          ],
          "options": {
            "downloadSettings": {
              "rules": [
                {
                  "match": [
                    "*://*/*.png", "*://*/*.jpg"
                  ],
                  "behavior": "no-prompt"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

```

--------------------------------

### Connecting to OpenFin Desktop

Source: https://resources.here.io/docs/core/adapters/java

This snippet shows how to establish a connection to the OpenFin Desktop using the Java adapter. It includes setting up the runtime configuration and handling connection states via a DesktopStateListener.

```APIDOC
## Connecting to OpenFin Desktop

### Description
Establishes a connection to the OpenFin Desktop using the Java adapter. This involves creating a `DesktopConnection` instance, configuring the runtime, and providing a listener for connection state changes.

### Code Example
```java
import com.openfin.desktop.*;

final DesktopConnection desktopConnection = new DesktopConnection("Unique UUID");
final RuntimeConfiguration rcg = new RuntimeConfiguration();
final int timeout = 60;

rcg.setRuntimeVersion("stable");
desktopConnection.connect(rcg, new DesktopStateListener() {
  // your implementation
}, timeout);
```

### DesktopStateListener Callbacks

#### Description
The `DesktopStateListener` interface allows you to react to various connection events, such as readiness, closure, errors, and message exchanges.

#### Callbacks
- `onReady()`: Called when the connection to the desktop is ready.
- `onClose(String error)`: Called when the connection is closed, with an optional error message.
- `onError(String reason)`: Called when an error occurs during the connection.
- `onMessage(String message)`: Called when a message is received.
- `onOutgoingMessage(String message)`: Called when a message is sent.

### Code Example
```java
new DesktopStateListener() {
  @Override
  public void onReady() {
  }

  @Override
  public void onClose(String error) {
  }

  @Override
  public void onError(String reason) {
  }

  @Override
  public void onMessage(String message) {
  }

  @Override
  public void onOutgoingMessage(String message) {
  }
}
```
```

--------------------------------

### Example deep link URL

Source: https://resources.here.io/docs/core/develop/deep-linking

This is an example of a deep link URL using the fins protocol. Parameters prefixed with $$ are passed to the application.

```plaintext
fins://mydomain.com/path-to-manifest/app.json?$$parameter1=value1&$$parameter2=value2
```

--------------------------------

### Install HERE Core Web npm package

Source: https://resources.here.io/docs/core/develop/core-web

Install the HERE Core Web package using npm. This is the first step to using the package in your application.

```bash
> npm install @openfin/core-web
```

--------------------------------

### Example JSON Response for Desktop Logs

Source: https://resources.here.io/docs/core/log-manager/get-all-logs-belonging-to-a-desktop-within-an-application

This is an example of the JSON response structure when retrieving logs for a desktop. It includes metadata for each log entry.

```json
{
  "response": [
    {
      "id": "0022213800000000013ea569",
      "size": 10,
      "app_session_id": "00000000-0000-0000-0000-000000000000",
      "close_reason": null,
      "desktop_id": "00000000-0000-0000-0000-000000000000",
      "runtime_version": "1.0.0",
      "rvm_version": "1.0.0",
      "start_date": "2018-08-01T12:11:00.000Z",
      "end_date": "2018-08-01T13:11:00.000Z",
      "encrypted_aes_key": "7b4bcdd7071cc4b52740e0544e337a47ad10efd4f435c353f89a4adc183079cedd8301df937d6355e34f567e38bee93ce5d0874fce2d62540965905e211aaca4f56252babed3b2a1510088cfd065c2fc41a7b0bc9d862eec3674a6678dc92f423cdfa476effe66e411699c7c5e4f780cc372ff3f61303f5c3e2282a3ad856818dc4279a536fab509a3df403b07d418f92bd57129803afa8d3b06e1284812114af36cee8f0f5e63aea51c6bd36f22cf188631d8782d08fdf5ba19074ee96826786df0de4ade006aaa1a698fe69694b45fbd6dab4371dca32983247727828e01b15386377265d7d6f2ab6206282a31e98d3b832d9af7e016393df97386e3de8eb0",
      "encrypted_aes_iv": "b150529812916a2584881d81797e68ee40063853a8873ff0cb869d6f01d53eb05c2c82966eab464393e320d59ffebfe3dfe97d2becfa5e3513fdc81f699e709e1ab3b22079e1bd319dd6b2707e402d712fa2c6df32f1e103a9806852195f6d37e5fc137e4d37e6d19fd5210f873fbdbef1e758496b3e1dc967af05caa83e15b0b588b480164e37ba87b0072cb33fd3585bd4191aba4ae6691931f97376d48b1c3678fcbe292599479602f1b9b59b5bc707d1d811007b1c94648716ae0a075027cb328f3c4a8f4f8a382071acc52acc4964411f119169b6b92035ea1278f470daec46126470d0edb3288f003ed7261745a8003441d320cb413e1b86e448d50862"
    }
  ]
}
```

--------------------------------

### Create and Open a Channel Provider

Source: https://resources.here.io/docs/core/adapters/dotnet-framework

Creates a channel provider named 'MyAppActions' and registers a 'SayHello' command. The channel is then opened asynchronously.

```csharp
var channel = runtime.InterApplicationBus.Channel.CreateProvider("MyAppActions");  
  
channel.RegisterTopic<string>("SayHello", (payload) => { return $"Hello {payload}!"};
);
await channel.OpenAsync();  

```

--------------------------------

### Install HERE Core CLI Tool

Source: https://resources.here.io/docs/core/develop/debug/cli

Use this command to download and install the HERE Core CLI tool globally. Node.js version 16 or higher is required.

```bash
npm install -g openfin-cli  

```

--------------------------------

### Download Rules in Platform Manifest

Source: https://resources.here.io/docs/core/develop/security/file-download

Configure download rules for PNG and JPEG files on all subdomains of example.com to be downloaded without prompting the user. This applies to the platform manifest.

```json
{
  "platform" :{
    "domainSettings": {
      "rules": [
        {
          "match": [
            "*/*.example.com"
          ],
          "options": {
            "downloadSettings": {
              "rules": [
                {
                  "match": [
                    "*://*/*.png", "*://*/*.jpg"
                  ],
                  "behavior": "no-prompt"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

```

--------------------------------

### Version 5.0 Desktop Owner Settings

Source: https://resources.here.io/docs/core/manage/deployment/hc-ui/dos-settings

Example configuration for version 5.0, including version and sentryEnabled flags.

```json
{
  "desktopSettings": {
    "systemApps": {
      "workspace": {
        "version": "14.0.22",
        "customConfig": {
          "flags" : {
            "WorkspaceDocEnabled" : true,
            "sentryEnabled" : false
          }
        }
      }
    }
  }
}

```

--------------------------------

### Example Platform Object Configuration

Source: https://resources.here.io/docs/core/develop/manifests

Demonstrates the structure of a platform object in a manifest, including UUID, icon, autoShow, providerUrl, preventQuitOnLastWindowClosed, permissions, and defaultWindowOptions with workspacePlatform configurations.

```json
"platform": {
    "uuid": "register-with-store",
    "icon": "http://localhost:8080/favicon.ico",
    "autoShow": false,
    "providerUrl": "http://localhost:8080/platform/provider.html",
    "preventQuitOnLastWindowClosed": true,
    "permissions": {
        "System": {
            "launchExternalProcess": true,
            "downloadAsset": true,
            "openUrlWithBrowser": {
                "enabled": true,
                "protocols": ["mailto"]
            }
        }
    },
    "defaultWindowOptions": {
        "permissions": {
            "System": {
                "openUrlWithBrowser": {
                    "enabled": true,
                    "protocols": ["mailto"]
                }
            }
        },
        "workspacePlatform": {
            // Configure page tab width
            "pageTabDimensions": {
                "minWidth": "30px",
                "maxWidth": "400px"
            },
            // Configure view tab width
            "viewTabDimensions": {
                "minWidth": "50px",
                "maxWidth": "400px"
            }
        }
    }
}


```

--------------------------------

### Desktop Owner Settings Example

Source: https://resources.here.io/docs/core/manage/security/api-security-desktop-owners

This JSON object demonstrates desktop owner settings for configuring secured APIs. It includes default permissions and application-specific settings for system and web APIs.

```json
{
    "desktopSettings": {
        "securedAPIDefaultPermission": "prompt",
        ...
    },
    "applicationSettings": {
        "https://www.examplefinapp.com/manifest1.json": {
            "permissions": {
                "System": {
                    "launchExternalProcess": {
                        "enabled": true,
                        "assets": {
                            "enabled": true
                        },
                        "downloads": {
                            "enabled": true
                        },
                        "executables": {
                            "enabled": true
                        }
                    }
                }
            }
        },
        "http://www.examplefinapp.com/AnotherApp.json": {
            "permissions": {
                "System": {
                    "launchExternalProcess": {
                        "enabled": true,
                        "assets": {
                            "enabled": true
                        },
                        "downloads": {
                            "enabled": true
                        },
                        "executables": {
                            "enabled": true
                        }
                    },
                    "readRegistryValue": {
                        "enabled": true,
                        "registryKeys": [
                            "HKEY_CURRENT_USER\Software\OpenFin\RVM",
                            "HKEY_CURRENT_USER\Software\OpenFin\Runtime",
                            "HKEY_CURRENT_USER\Software\Oracle"
                        ]
                    }
                },
                "webAPIs": [
                    "audio",
                    "video"
                ]
            }
        },
        "MyAlias": {
            "urls": [
                "https://example.com/*.json",
                "https://*.example.com/*.json"
            ],
            "permissions": {
                "System": {
                    "launchExternalProcess": {
                        "enabled": true,
                        "assets": {
                            "enabled": true
                        },
                        "downloads": {
                            "enabled": true
                        },
                        "executables": {
                            "enabled": true
                        }
                    },
                    "readRegistryValue": {
                        "enabled": true,
                        "registryKeys": [
                            "HKEY_CURRENT_USER\Software\OpenFin\RVM",
                            "HKEY_CURRENT_USER\Software\OpenFin\Runtime\Path",
                            "HKEY_CURRENT_USER\Software\Oracle"
                        ]
                    }
                }
            }
        },
        "default": {
            "permissions": {
                "System": {
                    "launchExternalProcess": {
                        "enabled": false
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Install HERE Core Web Package

Source: https://resources.here.io/docs/core/container/interop/api/web-interop

Install the HERE Core Web package using npm. This package provides the default entry point for Core Web applications.

```bash
npm install @openfin/core-web -S  

```

--------------------------------

### Runtime Version File Example

Source: https://resources.here.io/docs/core/develop/manifests/semantic-versioning

When hosting your own assets, provide a file listing all available runtime versions, separated by newlines. This allows the RVM to determine the greatest available version based on your specified criteria.

```text
16.83.53.26  
16.83.52.32  
16.83.51.26  
15.80.50.54  
15.80.49.30  
15.80.48.13  
14.78.47.23  

```

--------------------------------

### Manage Data Streams

Source: https://resources.here.io/docs/core/integrations/excel

Control the lifecycle of data streams by starting, stopping, and closing them. Calling start or stop on a closed data stream will result in an error.

```javascript
// Stop and clean up the data streams  
restApiDataStream.stop();  
restApiDataStream.close();  
wsDataStream.stop();  
wsDataStream.close();
```

--------------------------------

### Example JSON Response

Source: https://resources.here.io/docs/core/log-manager/get-application-names

This is an example of the JSON response structure when successfully retrieving application names. The response contains an array of application objects, each with a 'name' field.

```json
{
  "response": [
    {
      "name": "Hello Openfin"
    }
  ]
}
```

--------------------------------

### Worksheet Discovery and Creation

Source: https://resources.here.io/docs/core/integrations/excel

Discover existing worksheets within a workbook, get a specific worksheet by name or index, get the active worksheet, or add a new worksheet.

```APIDOC
## Working with Worksheets

### Description
Discover, access, and create worksheets within a workbook.

### Methods
#### `getWorksheets()`
- **Description**: Retrieves a list of all worksheets in the workbook.
- **Usage**: 
  ```javascript
  const worksheets = await workbook.getWorksheets();
  worksheets.forEach(async (worksheet) => {
    const worksheetName = await worksheet.getName();
    console.log(worksheetName);
  });
  ```

#### `getWorksheetByName(name: string)`
- **Description**: Gets a specific worksheet by its name.
- **Parameters**:
  - **name** (string) - Required - The name of the worksheet.
- **Usage**: 
  ```javascript
  const sheet1 = await workbook.getWorksheetByName('Sheet 1');
  ```

#### `getActiveWorksheet()`
- **Description**: Gets the currently active worksheet.
- **Usage**: 
  ```javascript
  const activeWorksheet = await workbook.getActiveWorksheet();
  ```

#### `addWorksheet()`
- **Description**: Adds a new worksheet to the workbook.
- **Returns**: The newly created worksheet object.
- **Usage**: 
  ```javascript
  const worksheet = await workbook.addWorksheet();
  ```
```

--------------------------------

### Application Desktops Response Example

Source: https://resources.here.io/docs/core/log-manager/get-all-desktops-within-a-application

This is an example of the JSON response structure when successfully retrieving desktops for an application. It returns an array of objects, where each object contains the 'name' of a desktop.

```json
{
  "response": [
    {
      "name": "00000000-0000-0000-0000-000000000000"
    }
  ]
}
```
Tokens:
Raw